Simple Log Service:,

Visão geral do Log4j

O Log4j é um projeto open source da Apache que permite configurar destinos de log, como consoles, arquivos, componentes de GUI, servidores socket, registradores de eventos NT e daemons Syslog UNIX. Você pode controlar o formato de saída de cada entrada de log e ajustar a geração de logs definindo níveis de log, tudo por meio de um arquivo de configuração, sem modificar o código da aplicação. O Log4j consiste em três componentes:

Pré-requisitos

• Crie um Project e um Logstore. Para obter mais informações, consulte Gerencie Projects e Gerencie Logstores.

• Se você usar um usuário RAM em vez de uma conta Alibaba Cloud, conceda ao usuário RAM as permissões para gravar dados em um Logstore. Para conceder as permissões, primeiro crie uma política personalizada e depois conceda permissões ao usuário RAM.

Procedimento

Etapa 1: Adicionar o arquivo de configuração do Log4j2

1. Adicione dependências ao seu projeto Maven.

   <dependencies>
     <dependency>
       <groupId>org.apache.logging.log4j</groupId>
       <artifactId>log4j-api</artifactId>
       <version>2.23.1</version>
     </dependency>
     <dependency>
       <groupId>org.apache.logging.log4j</groupId>
       <artifactId>log4j-core</artifactId>
       <version>2.23.1</version>
     </dependency>
   </dependencies>

2. Modifique o arquivo de configuração.

   Por padrão, o Log4j2 procura o arquivo de configuração no classpath. Se o arquivo não existir, crie-o manualmente. O exemplo a seguir usa log4j2.xml. Dois appenders são definidos para enviar logs ao console e ao arquivo app.log, respectivamente. O nível do logger raiz é definido como error com saída para o console. O logger chamado com.example.demo.log é definido como warn com saída para o arquivo. Para obter mais informações sobre como configurar o Log4j2, consulte a documentação oficial em Log4j – Configuring Log4j 2 (apache.org)

   <!-- status="WARN" sets the internal status of Log4j 2 itself, not the application's logging. It is used to capture and report potential issues during the configuration process. -->
   <Configuration status="WARN">
       <!-- Start: Define two appenders for log output -->
       <Appenders>
           <!-- Defines a console appender named "Console". Logs are printed to the standard system output. -->
           <Console name="Console" target="SYSTEM_OUT">
               <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss:SSS zzz} [%t] %-5level %logger{36} - %msg%n"/>
           </Console>
           <!-- Defines a file appender named "MyFile". Logs are written to the "app.log" file. -->
           <File name="MyFile" fileName="app.log">
               <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss:SSS zzz} [%t] %-5level %logger{36} - %msg%n"/>
           </File>
       </Appenders>
       <!-- End: Define two appenders for log output -->
       <!-- Start: Configure logger behavior -->
       <Loggers>
           <!-- Defines a logger named "com.example.demo.log" and sets its level to warn. It references the "MyFile" appender, which means logs at the warn level and above from this logger are sent to "MyFile". -->
           <Logger name="com.example.demo.log" level="warn">
               <AppenderRef ref="MyFile" />
           </Logger>
           <!-- Defines the root logger and sets its level to error. It references the "Console" appender, which means logs at the error level and above are sent to the console. -->
           <Root level="error">
               <AppenderRef ref="Console" />
           </Root>
       </Loggers>
       <!-- End: Configure logger behavior -->
   </Configuration>

3. Use o logger.

   Escreva um código de teste para obter uma instância do logger e gerar logs:

       public void logExampleDemo() {
           // Get the logger instance named "com.example.demo.log".
           Logger logger = LogManager.getLogger("com.example.demo.log");
           // Record log messages at different levels.
           logger.trace("trace level");
           logger.debug("debug level");
           logger.info("info level");
           logger.warn("warn level");
           logger.error("error level");
           logger.fatal("fatal level");
       }

4. Exemplo de saída de log:

   2024-05-28 13:37:16:295 CST [http-nio-8080-exec-8] TRACE com.example.demo.log - trace level
   2024-05-28 13:37:16:296 CST [http-nio-8080-exec-8] DEBUG com.example.demo.log - debug level
   2024-05-28 13:37:16:296 CST [http-nio-8080-exec-8] INFO  com.example.demo.log - info level
   2024-05-28 13:37:16:296 CST [http-nio-8080-exec-8] WARN  com.example.demo.log - warn level
   2024-05-28 13:37:16:296 CST [http-nio-8080-exec-8] ERROR com.example.demo.log - error level
   2024-05-28 13:37:16:296 CST [http-nio-8080-exec-8] FATAL com.example.demo.log - fatal level

Etapa 2: Coletar logs do Log4j

Via Log4j2 appender

1. Adicione dependências ao seu projeto Maven.

   <dependency>
       <groupId>com.google.protobuf</groupId>
       <artifactId>protobuf-java</artifactId>
       <version>2.5.0</version>
   </dependency>
   <dependency>
       <groupId>com.aliyun.openservices</groupId>
       <artifactId>aliyun-log-log4j2-appender</artifactId>
       <version>0.1.12</version>
   </dependency>

2. Modifique o arquivo de configuração.

   O exemplo a seguir usa o arquivo de configuração XML log4j2.xml. Se o arquivo não existir, crie-o no diretório raiz do projeto. Configure o appender Loghub e o logger da seguinte forma:

   <Appenders>
       <Loghub name="Loghub"
               project="your project"
               logStore="your logStore"
               endpoint="your project endpoint"
               accessKeyId="your accessKey id"
               accessKeySecret="your accessKey secret"
               totalSizeInBytes="104857600"
               maxBlockMs="0"
               ioThreadCount="8"
               batchSizeThresholdInBytes="524288"
               batchCountThreshold="4096"
               lingerMs="2000"
               retries="10"
               baseRetryBackoffMs="100"
               maxRetryBackoffMs="100"
               topic="your topic"
               source="your source"
               timeFormat="yyyy-MM-dd'T'HH:mmZ"
               timeZone="UTC"
               ignoreExceptions="true">
           <PatternLayout pattern="%d %-5level [%thread] %logger{0}: %msg"/>
       </Loghub>
   </Appenders>
   <Loggers>
       <Root level="warn">
           <AppenderRef ref="Loghub"/>
       </Root>
   </Loggers>

   Os parâmetros project, Logstore, endpoint, accessKeyId e accessKeySecret são obrigatórios. Parâmetros opcionais assumem valores padrão se não forem especificados. A tabela a seguir descreve os parâmetros.

   Parâmetro	Descrição
   project	Nome do seu Project no Simple Log Service.
   Logstore	Nome do seu Logstore no Simple Log Service.
   endpoint	Endpoint público do Simple Log Service. Para obter mais informações, consulte Service endpoint.
   accessKeyId	AccessKey ID. Para obter mais informações, consulte Crie um AccessKey.
   accessKeySecret	AccessKey secret. Para obter mais informações, consulte Crie um AccessKey.

3. Exemplo de código de teste:

   import org.apache.logging.log4j.LogManager;
   import org.apache.logging.log4j.Logger;
   public class Log4j2AppenderExample {
       private static final Logger LOGGER = LogManager.getLogger(Log4j2AppenderExample.class);
       public static void main(String[] args) throws InterruptedException {
           LOGGER.trace("log4j2 trace log");
           LOGGER.debug("log4j2 debug log");
           LOGGER.info("log4j2 info log");
           LOGGER.warn("log4j2 warn log");
           LOGGER.error("log4j2 error log", new RuntimeException("Runtime Exception"));
           Thread.sleep(1000 * 5);
       }
   }

Via Logtail

Importante

Ao configurar o Logtail, especifique o caminho do arquivo. Certifique-se de que os logs da aplicação possam ser gravados nos arquivos de log.

O Simple Log Service fornece um assistente de configuração para coleta rápida de logs de texto usando o Logtail. Se sua instância ECS e o Project do Simple Log Service estiverem na mesma conta e na mesma região, consulte Collect text logs from servers. Caso contrário, consulte Manually install Logtail to collect text logs from servers.

Etapa 3: Visualizar logs

1. Faça login no console do Simple Log Service.

2. Na seção Projects, clique em no projeto desejado.

   

3. Na aba Log Storage > Logstores, clique em no logstore desejado.

   

4. Verifique se os dados de log foram carregados. No Logstore, clique em Consumption Preview para visualizar rapidamente os logs. Para obter mais informações, consulte Query and analysis quick start.

5. Consulte e analise os logs.

   Importante

   Após carregar os logs em um Logstore, crie um índice antes de consultá-los e analisá-los. Para obter informações sobre a configuração de índice, consulte Crie indexes.

   Insira uma instrução de consulta e clique em Last 15 Minutes para especificar um intervalo de tempo. Veja abaixo um exemplo de log:

   level: ERROR
   location: com.aliyun.openservices.log.log4j.example.Log4jAppenderExample.main(Log4jAppenderExample.java:16)
   message: error log
   throwable: java.lang.RuntimeException: xxx
   thread: main
   time: 2018-01-02T03:15+0000
   log: 0 [main] ERROR com.aliyun.openservices.log.log4j.example.Log4jAppenderExample - error log
   __source__: xxx
   __topic__: yyy

   Consulte e analise logs na página do Logstore.

   Insira uma instrução de consulta para visualizar, pesquisar e filtrar dados de log. Para obter mais informações, consulte Query and analyze logs. Exemplos:

   • Consulte as três principais localizações com mais erros na última hora.

     level: ERROR | select location ,count(*) as count GROUP BY  location  ORDER BY count DESC LIMIT 3

   • Conte o número de logs para cada nível de log nos últimos 15 minutos.

     | select level ,count(*) as count GROUP BY level ORDER BY count DESC

Solução de problemas

Se a coleta de logs falhar após configurar o appender do Log4j2, verifique as causas comuns a seguir.

Documentos relacionados

• Para aprender a usar o Logtail para coletar logs de um servidor, consulte Collect text logs from servers. Vários plug-ins estão disponíveis para processamento. Para obter mais informações, consulte Data parsing plugins.

• Se a página de visualização estiver em branco ou nenhum dado aparecer na página de consulta após usar o Logtail para coletar logs, consulte Troubleshoot Logtail collection errors. Erros como falhas de análise regex, caminhos de arquivo incorretos ou tráfego excedendo a capacidade do shard podem ocorrer. Para visualizar erros de coleta do Logtail, consulte How do I view Logtail collection errors?. Para erros comuns de coleta de dados, consulte Common collection errors.

• Para casos de uso e perguntas frequentes (FAQs) sobre a coleta de logs do Log4j com um appender do Log4j2, consulte Log4j2 Appender. Para versões anteriores, consulte Log4j Appender.

• Ao usar um appender do Log4j2 para coletar logs do Log4j, configure seu accessKeyId e accessKeySecret. Para obter informações sobre como obtê-los, consulte Crie um AccessKey. Para configurar o endpoint do Simple Log Service, consulte Service endpoint.