Microservices Engine:Integrate Simple Log Service with SchedulerX 2.0

<dependency>
    <groupId>com.aliyun.schedulerx</groupId>
    <artifactId>schedulerx2-spring-boot-starter</artifactId>
    <version>${Latest version of the SchedulerX client}</version>
</dependency>

Log4j 2

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="off">
    <Appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout
                pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %m%n" />
        </Console>
        <SchedulerxLog4j2Appender name="schedulerxLog"
            timeFormat="yyyy-MM-dd'T'HH:mmZ"
            timeZone="UTC"
            ignoreExceptions="true">
            <PatternLayout pattern="%d %-5level [%thread] %logger{0}: %msg"/>
        </SchedulerxLog4j2Appender>
    </Appenders>

    <Loggers>
        <Root level="info">
            <AppenderRef ref="Console" />
            <AppenderRef ref="schedulerxLog" />
        </Root>
    </Loggers>
</Configuration>

Log4j

log4j.rootLogger = INFO,console,schedulerxLog
log4j.appender.schedulerxLog=com.alibaba.schedulerx.worker.log.appender.SchedulerxLog4jAppender

Logback

<appender name="schedulerxLog" class="com.alibaba.schedulerx.worker.log.appender.SchedulerxLogbackAppender">
    <timeFormat>yyyy-MM-dd'T'HH:mmZ</timeFormat>
    <timeZone>UTC</timeZone>
</appender>

<root level="INFO">
    <appender-ref ref="CONSOLE" />
    <appender-ref ref="schedulerxLog"/>
</root>

Campos de log

Cada entrada de log contém os seguintes campos:

Consultar logs históricos

O SchedulerX retém apenas os 60 registros de execução mais recentes por instância de job. Para pesquisar registros mais antigos, clique em Log Query no painel de navegação à esquerda do console do SchedulerX. Na página Log Query, filtre por ID do job, palavra-chave ou intervalo de tempo.

Diagnosticar uma falha de serviço

Após integrar o Simple Log Service, o SchedulerX coleta tanto logs de jobs quanto logs de serviço, incluindo exceções. O exemplo a seguir demonstra como identificar um erro de divisão por zero em uma chamada de serviço.

1. Crie um job que chame um método de serviço e grave logs com o logger schedulerx:

   package com.hxm.test.processor;
   
   import com.alibaba.schedulerx.test.service.TestService;
   import com.alibaba.schedulerx.worker.domain.JobContext;
   import com.alibaba.schedulerx.worker.processor.JavaProcessor;
   import com.alibaba.schedulerx.worker.processor.ProcessResult;
   
   import org.apache.logging.log4j.LogManager;
   import org.apache.logging.log4j.Logger;
   import org.springframework.beans.factory.annotation.Autowired;
   import org.springframework.stereotype.Component;
   
   @Component
   public class HelloWorldJob extends JavaProcessor {
       // Use the schedulerx logger to collect logs
       private static final Logger LOGGER = LogManager.getLogger("schedulerx");
   
       @Autowired
       private TestService testService;
   
       @Override
       public ProcessResult process(JobContext context) throws Exception {
           String parameters = context.getJobParameters();
           String tokens[] = parameters.split(" ");
           int a = Integer.valueOf(tokens[0]);
           int b = Integer.valueOf(tokens[1]);
           int c = testService.doDivision(a, b);
           LOGGER.info("testService.doDivision finished, a={}, b={}, c={}", a, b, c);
           if (c < 0) {
               return new ProcessResult(false, "result=" + c);
           }
           return new ProcessResult(true);
       }
   
   }

2. Crie a classe de serviço:

   package com.hxm.test.service;
   
   import org.apache.logging.log4j.LogManager;
   import org.apache.logging.log4j.Logger;
   import org.springframework.stereotype.Service;
   
   @Service("testService")
   public class TestServiceImpl implements TestService {
       // Use the schedulerx logger to collect logs
       private static final Logger LOGGER = LogManager.getLogger("schedulerx");
   
       @Override
       public int doDivision(int a, int b) {
           try {
                LOGGER.info("start to do division c = " + a + "/" + b);
                int c = a/b;
                LOGGER.info("c=" + c);
                return c;
           } catch (Exception e) {
               LOGGER.error("", e);
           }
           return -1;
       }
   
   }

3. Configure o job no console do SchedulerX. Por exemplo, defina os parâmetros do job como 1 0 para acionar um erro de divisão por zero.

   

4. Execute o job uma vez e abra o painel Task instance records para visualizar os logs. O log mostra que o job falhou porque TestServiceImpl lançou uma exceção "by zero".

   

Diagnosticar uma falha de job distribuído

Jobs distribuídos no SchedulerX 2.0 despacham subtarefas para vários workers visando o processamento em lote. Se uma subtarefa falhar, use os logs para identificar qual tarefa específica falhou e o motivo.

1. Crie um job distribuído que despache subtarefas e grave logs com o logger schedulerx:

   package com.hxm.test.processor;
   
   import java.util.ArrayList;
   import java.util.List;
   
   import com.alibaba.schedulerx.worker.domain.JobContext;
   import com.alibaba.schedulerx.worker.processor.MapJobProcessor;
   import com.alibaba.schedulerx.worker.processor.ProcessResult;
   
   import org.apache.logging.log4j.LogManager;
   import org.apache.logging.log4j.Logger;
   
   public class TestMapJobProcessor extends MapJobProcessor {
       private static final Logger LOGGER = LogManager.getLogger("schedulerx");
   
       @Override
       public ProcessResult process(JobContext context) throws Exception {
           String taskName = context.getTaskName();
           String parameter = context.getJobParameters();
           int dispatchNum = Integer.valueOf(parameter);
           if (isRootTask(context)) {
               LOGGER.info("start root task");
               List<String> msgList = new ArrayList<>();
               for (int i = 0; i <= dispatchNum; i++) {
                   msgList.add("msg_" + i);
               }
   
               return map(msgList, "Level1Dispatch");
           } else if (taskName.equals("Level1Dispatch")) {
               String task = (String)context.getTask();
               if (task.equals("msg_23")) {
                   LOGGER.error("msg={}, failed", task);
                   return new ProcessResult(false);
               } else {
                   LOGGER.info("msg={}, success", task);
               }
               return new ProcessResult(true);
           }
           return new ProcessResult(false);
       }
   }

2. Configure o job no console do SchedulerX e acione-o.

   

3. Abra os logs do job conforme descrito em Visualizar logs de jobs.

4. Pesquise palavras-chave (como failed ou error) para localizar a subtarefa com falha e sua causa raiz.