Livros
Kotlin
Capítulo 5. Boas Práticas de Codificação
Registro de Logs

Kotlin:
Registro de Logs

Como fazer:

Em Kotlin, o logging pode ser realizado usando a função integrada println() para casos simples, ou com bibliotecas mais sofisticadas como SLF4J com Logback ou Log4j para necessidades avançadas.

Abaixo, um exemplo simples usando println():

fun main() {
    println("Mensagem simples de log: Aplicação iniciada.")
    // ... alguma lógica da aplicação aqui ...
    try {
        // Simula um erro
        throw Exception("Erro simulado")
    } catch (e: Exception) {
        println("Mensagem de log de erro: " + e.message)
    }
}

Saída:

Mensagem simples de log: Aplicação iniciada.
Mensagem de log de erro: Erro simulado

E aqui está um trecho usando SLF4J com Logback configurado:

import org.slf4j.LoggerFactory

private val logger = LoggerFactory.getLogger("MyAppLogger")

fun main() {
    logger.info("Mensagem de log estruturada: App iniciado.")
    // ... alguma lógica da aplicação aqui ...
    try {
        // Simula um erro
        throw Exception("Erro simulado")
    } catch (e: Exception) {
        logger.error("Log de erro estruturado: ", e)
    }
}

Assumindo a configuração apropriada do Logback, a saída seria formatada e poderia parecer algo assim quando escrita em um arquivo de log:

[INFO] - 2023-03-29 14:15:42 - MyAppLogger - Mensagem de log estruturada: App iniciado.
[ERROR] - 2023-03-29 14:15:43 - MyAppLogger - Log de erro estruturado: 
java.lang.Exception: Erro simulado
   at com.myapp.Main.main(Main.kt:10)

Aprofundamento

Historicamente, o registro de logs em softwares evoluiu juntamente com a crescente complexidade das aplicações e sistemas. Comandos simples de impressão eram suficientes nos primeiros dias, onde os programas eram frequentemente executados e depurados pelo próprio desenvolvedor. Mas à medida que os sistemas se conectavam em rede e rodavam em diferentes ambientes e usuários, um sistema de log robusto e persistente se tornou crucial.

Antes do Kotlin se tornar popular, desenvolvedores Java adotaram amplamente bibliotecas como Log4j e, posteriormente, SLF4J. Estas inspiraram práticas semelhantes em Kotlin, aproveitando a interoperabilidade do Kotlin com bibliotecas Java. O SLF4J atua como uma camada de abstração, permitindo que a implementação real do registro de logs seja trocada—geralmente Logback ou Log4j2 são as escolhas preferenciais.

O Kotlin também permite soluções de logging multiplataforma que funcionam em JVM, JavaScript e Native, por exemplo, através do mecanismo expect/actual, que abstrai as implementações específicas da plataforma.

Em contraste com bibliotecas de logging dedicadas, println persiste como a forma mais simples de registro de logs, pois não requer configuração adicional ou dependências; no entanto, geralmente é inadequado para aplicações de produção devido à falta de recursos como níveis de log, rotação de logs e formatos estruturados.

Outras características comuns de frameworks avançados de registro de logs incluem:

  • Níveis de log (DEBUG, INFO, WARN, ERROR, etc.) para categorizar a urgência das mensagens de log.
  • Saída para vários destinos, como console, arquivo, bancos de dados ou serviços de rede.
  • Rotação automática de logs e políticas de retenção.
  • Suporte para rastreamento distribuído em arquitetura de microsserviços.
  • Registro de logs estruturado usando formatos como JSON, que se integram bem com sistemas de análise de logs.

Essas ferramentas e recursos são críticos para manter um sistema confiável e observável, especialmente em ambientes complexos, distribuídos ou altamente escaláveis.

Veja Também

Para mais aprendizado e informações sobre registro de logs em Kotlin, confira:

Tratamento de errosOrganizando o código em funções