Mobile Platform as a Service:Logs do lado do servidor do gateway

O gateway mPaaS gera sete tipos de logs do lado do servidor. Cada log abrange um aspecto diferente da atividade do gateway, desde resumos por requisição e payloads completos até o estado do pool de threads e alterações de configuração.

O gateway gera sete tipos de logs do lado do servidor. Cada arquivo de log registra um aspecto diferente da atividade do gateway:

Utilize o campo TraceId para correlacionar entradas nos logs de resumo, detalhes, estatísticas e erros referentes à mesma requisição.

Log de resumo da API

Caminho do log: ~/logs/gateway/gateway-page-digest.log

O log de resumo registra uma entrada por chamada de API. Cada entrada contém os seguintes campos:

• Timestamp do log

• Endereço da requisição

• Resposta

• Resultado: Y (sucesso) ou N (falha)

• Tempo consumido, em milissegundos (ms)

• operationType

• Nome do sistema

• appId

• workspaceId

• Código de resultado

• ID do produto cliente

• Versão do produto cliente

• Canal

• ID do usuário

• ID do dispositivo

• UUID

• ID de rastreamento do cliente

• Endereço IP do cliente

• Protocolo de rede: HTTP ou HTTP/2

• Protocolo de dados: JSON ou PB (Protocol Buffers)

• Tamanho dos dados da requisição, em bytes

• Tamanho dos dados da resposta, em bytes

• Sinalizador de teste de estresse

• TraceId: identificador exclusivo da requisição. Use este ID para localizar as entradas correspondentes nos logs de detalhes, estatísticas e erros.

• Sinalizador de componente

• Tipo de sistema do cliente

• Tempo consumido pelo sistema backend, em milissegundos (ms)

• Tipo de endereço IP do cliente: 4 (IPv4) ou 6 (IPv6)

• Versão do protocolo RPC: 1,0 ou 2,0

Formato:

Timestamp - (Request address,Response,Result (Y/N),Time consumed,operationType,System name,appId,workspaceId,Result code,Client product ID,Client product version,Channel,User ID,Device ID,UUID,Client track ID,Client IP address,Network protocol,Data protocol,Request data size,Response data size,Is stress test,TraceId,Is component API,Client system type,Backend system time consumed,IP protocol version,RPC protocol version)

Exemplo:

2020-06-03 14:14:08,001 - (/mgw.htm,response,Y,61 ms,alipay.mcdp.space.initSpaceInfo,-,84EFA9A281942,default,1000,-,-,-,-,Wz4Zak5peDgDAGRNW5rFFGhT,Wz4Zak5peDgDAGRNW5rFFGhTN9uqCLa,Wz4Zak5peDgDAGRNW5rFFGhTN9uqCLa,223.104.XXX.XXX,HTTP,JSON,2,2406,F,0a1d76671591164847940829820658,T,ANDROID,61,4,2.0)

Log de detalhes da API

Caminho do log: ~/logs/gateway/gateway-page-detail.log

O log de detalhes captura dados completos de requisição e resposta para cada chamada de API. Utilize-o para inspecionar payloads ao depurar requisições individuais. Os logs de detalhes dividem-se em duas categorias:

• Log de requisição: [request]

• Log de resposta: [response]

Log de requisição

• Timestamp do log

• Endereço IP do cliente

• TraceId

• Nível do log

• Tipo de log: request

• operationType

• appId

• workspaceId

• requestData

• sessionId

• did: ID do dispositivo

• contentType

• mmtp: T ou F. Indica se o protocolo MMTP (Mobile Message Transfer Protocol) está em uso.

• async: T ou F. Indica se a invocação é assíncrona.

Log de resposta

• Timestamp do log

• Endereço IP do cliente

• TraceId

• Nível do log

• Tipo de log: response

• operationType

• appId

• workspaceId

• responseData

• resultStatus: Código de resultado

• contentType

• sessionId

• did: ID do dispositivo

• mmtp: T ou F. Indica se o protocolo MMTP está em uso.

• async: T ou F. Indica se a invocação é assíncrona.

Exemplo:

2017-12-21 15:37:10,208 [100.97.90.113][79c731d51513841830208829314258] INFO  - [request]operationType=com.alipay.gateway.test,appId=2A9ADA1045,workspaceId=antcloud,requestData=***,sessionId=-,did=WjtkmWe1uHsDADl7BEleyK2L,contentType=JSON,mmtp=F,async=T

2017-12-21 15:37:10,229 [][79c731d51513841830208829314258] INFO  - [response]operationType=com.alipay.gateway.test,appId=2A9ADA1045,workspaceId=antcloud,responseData=***,resultStatus=1000,contentType=JSON,sessionId=-,did=WjtkmWe1uHsDADl7BEleyK2L,mmtp=F,async=T

Log de estatísticas da API

Caminho do log: ~/logs/gateway/gateway-page-stat-s.log

O log de estatísticas registra métricas agregadas por tipo de operação, agrupadas por código de resultado e sinalizador de teste de estresse. Utilize-o para monitorar tendências de throughput e latência nas operações da API. Cada entrada contém os seguintes campos:

• Timestamp do log

• operationType

• appId

• workspaceId

• Resultado: Y (sucesso) ou N (falha)

• Código de resultado

• Sinalizador de teste de estresse

• Total de requisições

• Tempo total consumido, em milissegundos (ms)

Formato:

Timestamp - operationType,appId,workspaceId,Result (Y/N),Result code,Stress testing flag (T/F),Total requests,Total time consumed (ms)

Exemplo:

2017-12-21 15:34:58,419 - com.alipay.gateway.test,2A9ADA1045,antcloud,Y,1000,F,1,3

Log de estatísticas de threads do gateway

Caminho do log: ~/logs/gateway/gateway-threadpool.log

O log de estatísticas de threads registra o estado do pool de threads do gateway em cada intervalo de log. Utilize-o para identificar exaustão de threads ou acúmulo na fila. Cada entrada contém os seguintes campos:

• Timestamp do log

• Nome da thread

• Threads ativas

• Tamanho atual do pool

• Tamanho máximo do pool (maior número de threads já criado)

• Threads principais

• Máximo de threads

• Capacidade da fila de tarefas

• Capacidade restante da fila

Formato:

Timestamp [Thread name,ActiveCount,PoolSize,LargestPoolSize,CorePoolSize,MaximumPoolSize,QueueSize,QueueRemainingCapacity]

Exemplo:

2017-12-21 16:33:32,617 [gateway-executor,0,80,80,80,400,0,1000]

Log de configuração do gateway

Caminho do log: ~/logs/gateway/gateway-config.log

O log de configuração registra cada alteração feita na configuração do gateway, incluindo o momento da mudança e as configurações atualizadas.

Log padrão do gateway

Caminho do log: ~/logs/gateway/gateway-default.log

O log padrão captura pontos de instrumentação que não possuem um destino de log designado. Componentes do gateway que não gravam em um arquivo de log específico escrevem neste log.

Log de erros do gateway

Caminho do log: ~/logs/gateway/gateway-error.log

O log de erros registra erros de tempo de execução e stack traces de exceções. Utilize-o para diagnosticar falhas no gateway e comportamentos inesperados.