Configuração de log - ApsaraMQ for RocketMQ: Central de Documentação do Alibaba Cloud

Os SDKs do ApsaraMQ for RocketMQ geram logs de cliente que registram eventos e exceções durante a execução. Utilize esses logs para solucionar problemas operacionais no cliente.

Caminhos padrão dos arquivos de log

A tabela a seguir apresenta o caminho padrão do arquivo de log para cada linguagem de SDK. {$HOME} representa o diretório raiz da aplicação iniciada por você.

Linguagem	Caminho padrão
Java	`{$HOME}/logs/rocketmq/rocketmq-client.log`
C++	`{$HOME}/logs/rocketmq/client.log`
C#	`{$HOME}/logs/rocketmq/rocketmq-client.log`
Go	`{$HOME}/logs/rocketmq/rocketmq_client_go.log`

Parâmetros de log

Ao iniciar, o cliente cria um arquivo de log com base nas configurações padrão. Os SDKs Java e Go permitem personalizar os parâmetros de log, enquanto os SDKs C++ e C# não oferecem suporte a essa configuração.

Java

No Java, todos os parâmetros de log são definidos por meio de propriedades de sistema da JVM (flags -D).

Parâmetro	Descrição	Padrão	Valores válidos
`rocketmq.log.level`	Nível de verbosidade do log.	`INFO`	`ERROR`, `WARN`, `INFO`, `DEBUG`
`rocketmq.log.root`	Diretório raiz para saída de log.	`{$HOME}/logs/rocketmq`	Qualquer diretório local com permissão de escrita.
`rocketmq.log.file.maxIndex`	Quantidade máxima de arquivos de log retidos. Cada arquivo possui tamanho fixo máximo de 64 MB.	`10`	`1`--`100`. Valores fora desse intervalo ou em formato inválido revertem para o padrão.

Nota

Verifique se o processo da aplicação tem permissão de escrita no diretório de log especificado. Caso contrário, os logs não serão gravados.

Go

Para Go, a definição dos parâmetros de log ocorre via variáveis de ambiente.

Parâmetro	Descrição	Padrão	Valores válidos
`rocketmq.client.logLevel`	Nível de verbosidade do log.	`INFO`	`ERROR`, `WARN`, `INFO`, `DEBUG`
`rocketmq.client.logRoot`	Diretório raiz para saída de log.	`{$HOME}/logs/rocketmq`	Qualquer diretório local com permissão de escrita.
`rocketmq.client.logFileName`	Nome do arquivo de log.	`rocketmq_client_go.log`	Qualquer nome de arquivo válido.
`rocketmq.log.file.maxIndex`	Quantidade máxima de arquivos de log retidos.	`10`	`1`--`100`
`rocketmq.client.logFileMaxSize`	Tamanho máximo de cada arquivo de log.	`1 GB`	--

Nota

Garanta que o processo da aplicação possua permissão de escrita no diretório de log indicado. Sem essa permissão, a gravação de logs falhará.

Configure o logging

Java

No script de inicialização ou nas opções de VM da IDE, passe flags -D para definir os parâmetros de log.

Defina o nível de log como INFO:

java -Drocketmq.log.level=INFO -jar foobar.jar

Especifique um diretório de log personalizado e aumente a retenção de arquivos:

java -Drocketmq.log.level=WARN \
     -Drocketmq.log.root=/var/log/myapp/rocketmq \
     -Drocketmq.log.file.maxIndex=20 \
     -jar foobar.jar

Go

O SDK Go oferece dois métodos de configuração:

Configuração estática -- Defina as variáveis de ambiente antes de iniciar o cliente.
Configuração dinâmica -- Defina as variáveis de ambiente no código e chame ResetLogger() para aplicar as alterações em tempo de execução.

Configuração dinâmica (alteração em tempo de execução):

os.Setenv("rocketmq.client.logLevel", "WARN")
rmq_client.ResetLogger()