Simple Log Service:,

Descripción general de Log4j

Log4j es un proyecto de código abierto de Apache que permite configurar destinos de registros como consolas, archivos, componentes GUI, servidores socket, registradores de eventos NT y demonios Syslog de UNIX. Es posible controlar el formato de salida de cada entrada de registro y realizar fine-tune de la generación de registros mediante la definición de niveles, todo a través de un archivo de configuración sin modificar el código de la aplicación. Log4j se compone de tres elementos:

Requisitos previos

• Se ha creado un Project y un Logstore. Para obtener más información, consulte Manage Projects y Manage Logstores.

• Si utiliza un usuario RAM en lugar de una cuenta de Alibaba Cloud, debe otorgar al usuario RAM los permisos permissions to write data to a Logstore. Para conceder estos permisos, primero debe create a custom policy y luego grant permissions to the RAM user.

Procedimiento

Paso 1: Agregar el archivo de configuración de Log4j2

1. Agregue dependencias a su proyecto 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 el archivo de configuración.

   De forma predeterminada, Log4j2 busca el archivo de configuración en el classpath. Si el archivo no existe, créelo manualmente. El siguiente ejemplo utiliza log4j2.xml. Se definen dos appenders para enviar registros a la consola y al archivo app.log, respectivamente. El nivel del logger raíz se establece en error con salida a la consola. El logger llamado com.example.demo.log se configura en warn con salida al archivo. Para obtener más información sobre cómo configurar Log4j2, consulte la documentación oficial en 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. Utilice el logger.

   Escriba código de prueba para obtener una instancia de logger y generar registros:

       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. Ejemplo de salida de registros:

   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

Paso 2: Recolectar registros Log4j

Mediante appender Log4j2

1. Agregue dependencias a su proyecto 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 el archivo de configuración.

   El siguiente ejemplo utiliza el archivo de configuración XML log4j2.xml. Si el archivo no existe, créelo en el directorio raíz del proyecto. Configure el appender Loghub y el logger de la siguiente manera:

   <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>

   Los parámetros project, Logstore, endpoint, accessKeyId y accessKeySecret son obligatorios. Los parámetros opcionales utilizan valores predeterminados si no se especifican. La siguiente tabla describe los parámetros.

   Parámetro	Descripción
   project	El nombre de su Project en Simple Log Service.
   Logstore	El nombre de su Logstore en Simple Log Service.
   endpoint	El endpoint público para Simple Log Service. Para obtener más información, consulte Service endpoint.
   accessKeyId	El AccessKey ID. Para obtener más información, consulte Create an AccessKey.
   accessKeySecret	El AccessKey secret. Para obtener más información, consulte Create an AccessKey.

3. Ejemplo de código de prueba:

   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);
       }
   }

Mediante Logtail

Importante

Al configurar Logtail, debe especificar la ruta del archivo. Asegúrese de que los registros de la aplicación puedan escribirse en los archivos de registro.

Simple Log Service proporciona un asistente de configuración para la recolección rápida de registros de texto mediante Logtail. Si su instancia ECS y el Project de Simple Log Service están bajo la misma cuenta y en la misma región, consulte Collect text logs from servers. De lo contrario, consulte Manually install Logtail to collect text logs from servers.

Paso 3: Consultar registros

1. Inicie sesión en la consola de Simple Log Service.

2. En la sección Projects, haga clic en el proyecto deseado.

   

3. En la pestaña Log Storage > Logstores, haga clic en el logstore deseado.

   

4. Compruebe que los datos de registro se hayan cargado. En el Logstore, haga clic en Consumption Preview para ver rápidamente los registros. Para obtener más información, consulte Query and analysis quick start.

5. Consulte y analice los registros.

   Importante

   Después de cargar registros en un Logstore, debe create an index antes de poder consultarlos y analizarlos. Para obtener información sobre la configuración de índices, consulte Create indexes.

   Introduzca una sentencia de consulta y luego haga clic en Last 15 Minutes para especificar un rango de tiempo. A continuación se muestra un ejemplo de registro:

   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 y analice registros en la página del Logstore.

   Introduzca una sentencia de consulta para ver, buscar y filtrar datos de registro. Para obtener más información, consulte Query and analyze logs. Ejemplos:

   • Consulte las tres ubicaciones principales con más errores en la última hora.

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

   • Cuente el número de registros para cada nivel de registro en los últimos 15 minutos.

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

Solución de problemas

Si la recolección de registros falla después de configurar el appender Log4j2, revise las siguientes causas comunes.

Documentos relacionados

• To learn how to use Logtail to collect logs from a server, see Collect text logs from servers. Various plug-ins are available for processing. For more information, see Data parsing plugins.

• Si la página de vista previa está en blanco o no aparecen datos en la página de consulta después de usar Logtail para recolectar registros, consulte Troubleshoot Logtail collection errors. Pueden ocurrir errores como fallos en el análisis de expresiones regulares, rutas de archivo incorrectas o tráfico que excede la capacidad del shard. Para ver errores de recolección de Logtail, consulte How do I view Logtail collection errors?. Para errores comunes de recolección de datos, consulte Common collection errors.

• Para casos de uso y preguntas frecuentes (FAQ) sobre la recolección de registros Log4j con un appender Log4j2, consulte Log4j2 Appender. Para versiones anteriores, consulte Log4j Appender.

• Al usar un appender Log4j2 para recolectar registros Log4j, debe configurar su accessKeyId y accessKeySecret. Para obtener información sobre cómo conseguirlos, consulte Create an AccessKey. Para configurar el endpoint de Simple Log Service, consulte Service endpoint.