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>

Champs de journalisation

Chaque entrée de journal contient les champs suivants :

Interroger les journaux historiques

SchedulerX ne conserve que les 60 derniers enregistrements d'exécution par instance de tâche. Pour rechercher des enregistrements plus anciens, cliquez sur Log Query dans le volet de navigation de gauche de la console SchedulerX. Sur la page Log Query, filtrez par ID de tâche, mot-clé ou plage de temps.

Diagnostiquer une défaillance de service

Après l'intégration de Simple Log Service, SchedulerX collecte à la fois les journaux de tâches et les journaux de service, y compris les exceptions. L'exemple suivant montre comment identifier une erreur de division par zéro dans un appel de service.

1. Créez une tâche qui appelle une méthode de service et consigne les journaux avec le 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. Créez la classe de service :

   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. Configurez la tâche dans la console SchedulerX. Par exemple, définissez les paramètres de la tâche sur 1 0 pour déclencher une erreur de division par zéro.

   

4. Exécutez la tâche une fois, puis ouvrez le panneau Task instance records et consultez les journaux. Le journal indique que la tâche a échoué car TestServiceImpl a levé une exception « by zero ».

   

Diagnostiquer l'échec d'une tâche distribuée

Les tâches distribuées dans SchedulerX 2.0 distribuent des sous-tâches sur plusieurs workers pour un traitement par lots. Si une sous-tâche échoue, utilisez les journaux pour identifier quelle tâche spécifique a échoué et pourquoi.

1. Créez une tâche distribuée qui distribue des sous-tâches et consigne les journaux avec le 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. Configurez la tâche dans la console SchedulerX et déclenchez-la.

   

3. Ouvrez les journaux de la tâche comme décrit dans la section Consulter les journaux des tâches.

4. Recherchez des mots-clés (tels que failed ou error) pour localiser la sous-tâche ayant échoué et sa cause première.