Instanciar Rastreador do APM
Siga estas etapas para adicionar o suporte a rastreamento ao seu aplicativo:
Para a configuração do Helidon, ignore essas etapas e consulte Usar o Rastreador do APM no Helidon.
-
Importe as classes opentracing Tracer and APM Tracer fazendo o seguinte:
import io.opentracing.Tracer; import com.oracle.apm.tracer.ApmTracer; -
O Rastreador do APM pode ser instanciado no estilo do construtor. O construtor de ApmTracer.Builder tem 2 parâmetros: tracerName e serviceName.
- tracerName: Nome deste rastreador. Pode ser qualquer nome de string, exceto nulo.
- serviceName: Nome do serviço reportado por esse rastreador. Pode ser qualquer string, exceto nula.
Tracer tracer = new ApmTracer.Builder(String tracerName, String serviceName) .<configuration methods> .build();
Antes de chamar o método build() para criar a instância do Rastreador do APM, ele pode ser configurado com métodos de configuração. Alguns métodos de configuração também podem ser configurados definindo propriedades do sistema Java e variáveis de ambiente.
Métodos de Configuração
| Método | Padrão | Descrição | Propriedade do Sistema Java Equivalente | Variável de Ambiente Equivalente |
|---|---|---|---|---|
| withDataUploadEndpoint(String endpoint) | Define o ponto final de upload de dados do APM necessária para a comunicação na nuvem do Oracle APM. | com.oracle.apm.agent.data.upload.endpoint | com_oracle_apm_agent_data_upload_endpoint | |
| withDataUploadKey(String dataKey) | Define a chave de upload de dados do APM necessária para a comunicação na nuvem do Oracle APM. | com.oracle.apm.agent.private.data.key | com_oracle_apm_agent_private_data_key | |
|
withTag(String key, String value) withTag(String key, Boolean value) withTag(String key, Number value) withTags(Map<String, Object> tags) |
Define tags estáticas a serem incluídas em todos os intervalos de rastreamento. | |||
| withLogDirectory(String directory) | ./apm-tracer-log | Especifique o caminho completo do diretório de log no qual todos os logs do Rastreador do APM são gravados. Se não for definido, o diretório de log padrão, apm-tracer-log, será criado no diretório de trabalho da JVM. | com.oracle.apm.agent.log.directory | com_oracle_apm_agent_log_directory |
|
withProperty(String key, String value) withProperties(Map<String, String> properties) |
Define uma ou mais propriedades do Rastreador do APM. Isso permite que as propriedades sejam definidas de forma programática no momento da inicialização do Rastreador do APM. Todas as propriedades também podem ser definidas por meio de propriedades do sistema Java ou de variáveis de ambiente. As propriedades serão ignoradas se a chave ou o valor for nulo. |
|||
| withMicrosecondAccurateTimestamp(boolean microsecondAccuracy) | falso | Define todos os timestamps com precisão de microssegundos quando é verdadeiro. O padrão é a precisão de milissegundos. | ||
| withCollectMetrics(boolean collectMetrics) | true |
Define o Rastreador do APM para coletar métricas do servidor e relatar para a nuvem do serviço OCI APM. O padrão é verdadeiro. O usuário pode acessar todas as métricas de servidor coletadas do serviço OCI Telemetry. Consulte Coletar Métricas para obter detalhes das métricas coletadas do servidor. |
||
| withCollectResources(boolean collectResources) | true |
Define o Rastreador do APM para coletar recursos do servidor e relatar para a nuvem do serviço OCI APM. Todos os recursos coletados são usados como dimensão para consulta de dados. Consulte Coletar Métricas para obter detalhes das métricas coletadas do servidor. |
||
| withDaemonChannel(String channel) | O canal do Daemon do APM é uma conexão de soquete entre o Rastreador e o Daemon. O formato deste valor de propriedade é <host>:<porta>. Quando o Daemon é iniciado com este conjunto de propriedades, o Daemon aceita a conexão do soquete e faz listening dos dados neste canal especificado. Quando o Rastreador é iniciado com este conjunto, o ponto final de upload de dados é ignorado e os dados só são enviados para o Daemon usando esse canal de soquete. | com.oracle.apm.agent.daemon.channel | com_oracle_apm_agent_daemon_channel | |
| build() | Instancie a instância do Rastreador do APM. |
Outras Propriedades
As propriedades podem ser definidas como propriedades do sistema Java, variáveis de ambiente ou usando com o método de construtor Property().
| Propriedade do Sistema Java | Variável de Ambiente | Padrão | Descrição |
|---|---|---|---|
| com.oracle.apm.agent.daemon.channel | com.oracle.apm.agent.daemon.channel | O canal do Daemon do APM é uma conexão de soquete entre o Rastreador e o Daemon. O formato deste valor de propriedade é <host>:<porta>. Quando o Daemon é iniciado com este conjunto de propriedades, o Daemon aceita a conexão do soquete e faz listening dos dados neste canal especificado. Quando o Rastreador é iniciado com este conjunto, o ponto final de upload de dados é ignorado e os dados só são enviados para o Daemon usando esse canal de soquete. | |
| com.oracle.apm.agent.data.upload.proxy.url | com_oracle_apm_agent_data_upload_proxy_url | URL do servidor proxy para conexão com o servidor do Oracle APM. Somente o proxy HTTP é suportado. | |
| com.oracle.apm.agent.log.filesize.mb | com_oracle_apm_agent_log_filesize_mb | 20 mb | Tamanho do arquivo de log. Você pode especificar o tamanho do arquivo de log usando esta propriedade. O valor padrão é "20", isto é, 20 MB será o tamanho do arquivo de um arquivo de log. |
| com.oracle.apm.agent.log.rotation.files.count | com_oracle_apm_agent_log_rotation_files_count | 2 | Número de arquivos que podem ser criados para armazenar logs com mecanismo de rolagem. Exemplo: Se especificarmos "2" como valor dessa propriedade, os logs serão armazenados no primeiro arquivo até atingirmos o limite do tamanho do arquivo. Quando o limite de tamanho do arquivo for atingido, o novo arquivo será criado e continuará armazenando logs. Depois de atingir o limite de tamanho do arquivo no segundo arquivo, ele excluirá o primeiro arquivo e iniciará o registro em log no primeiro arquivo. Os arquivos serão nomeados adequadamente com um sufixo numérico. Por exemplo, ApmTracer.log e ApmTracer1.log. O valor padrão é "2" ou seja, 2 arquivos serão usados para armazenar logs. |
| com.oracle.apm.agent.logging.level | com_oracle_apm_agent_logging_level | INFO | O nível de log pode ser SEVERE, WARNING, INFO, DEBUG listado em ordem desde a menor até a maior entrada gravada no ApmTracer.log. |
| com.oracle.apm.agent.tracer.propagation.type | com_oracle_apm_agent_tracer_propagation_type | B3 |
O Rastreador do APM adicionará e lerá cabeçalhos HTTP para conectar intervalos entre chamadas HTTP. Há vários tipos de formatos de cabeçalho de propagação que podem ser usados para fazer isso. Se você também estiver trabalhando com outros tipos de rastreadores, como Zipkin ou Jaeger, essa definição pode precisar ser ajustada para que eles possam trabalhar juntos.
|