Guia para usar a API do agente Java

Crie um Transaction quando o New Relic não criar um automaticamente

@Trace(dispatcher = true) no método que abrange o trabalho a ser relatado. Quando esta anotação é usada em um método dentro do contexto de uma transação existente, isso não iniciará uma nova transação, mas incluirá o método na transação existente.

Capture a duração de um método que o New Relic não traceautomaticamente

@Trace() no método que você deseja cronometrar.

Defina o nome do atual Transaction

NewRelic.setTransactionName(...)

Inicie o cronômetro para o tempo de resposta do Transaction atual e para fazer com que um Transaction criado seja relatado como uma transação Web , em vez de uma transação Other

NewRelic.setRequestAndReponse(...)

Adicione atributo personalizado a Transactions e TransactionEvents

NewRelic.addCustomParameter(...)

Adiciona rastreamento de usuário a Transactions definindo o atributo de agente enduser.id .

NewRelic.setUserId()

Impedir que um Transaction seja reportado à New Relic

NewRelic.ignoreTransaction()

Exclua um Transaction ao calcular a pontuação Apdex do seu aplicativo

NewRelic.ignoreApdex()

Trace um método assíncrono se ele estiver vinculado a um Transaction existente...

@Trace(async = true)

Vincule o Transaction associado ao Token no tópico atual...

Token.link() ou Token.linkAndExpire()

Expire um Token associado ao Transaction atual ...

Token.expire()

Pare de cronometrar um Segment e faça com que ele seja relatado como parte de seu pai Transaction

Segment.end()

Pare de cronometrar um Segment e não faça com que ele seja relatado como parte de seu pai Transaction

Segment.ignore()

Saiba mais sobre os cabeçalhos específicos do tipo de uma mensagem de entrada ou de saída.

Headers

Para uma implementação fornecida de Headers use ConcurrentHashMapHeaders.

Veja um exemplo de implementação de cabeçalhos W3C Trace Context no uso da API DT com Kafka.

Crie e insira cabeçalhos distributed tracing em uma estrutura de dados Headers. Esta API inserirá newrelic W3C Trace Context cabeçalhos (traceparent etracestate), a menos que o agente esteja explicitamente configurado para excluir newrelic cabeçalhos.

Transaction.insertDistributedTraceHeaders(Headers)

Para obter mais informações sobre como obter referências à transação atual e outras classes de API, consulte Obter referências.

Aceite os cabeçalhos distributed tracing enviados do serviço chamador e vincule esses serviços em um distributed trace.

Transaction.acceptDistributedTraceHeaders(TransportType, Headers)

Para obter mais informações sobre como obter referências à transação atual e outras classes de API, consulte Obter referências.

Entenda uma classe de utilitário que fornece constantes enum para definir o tipo de transporte ao aceitar cabeçalhos distributed tracing .

Adicione atributo personalizado a SpanEvents no rastreamento distribuído

NewRelic.getAgent().getTracedMethod().addCustomAttribute(...)

Crie uma carga a ser enviada para um serviço chamado.

Transaction.createDistributedTracePayload()

Para obter mais informações sobre como obter referências à transação atual e outras classes de API, consulte Obter referências.

Aceite uma carga enviada do primeiro serviço; isso vinculará esses serviços em um trace.

Transaction.acceptDistributedTracePayload(...)

Para obter mais informações sobre como obter referências à transação atual e outras classes de API, consulte Obter referências.

Carga usada para conectar serviços. A chamada text() retorna uma representação de string JSON da carga.

DistributedTracePayload.text()

Carga usada para conectar serviços. A chamada httpSafe() retorna uma representação de string JSON codificada em base64 da carga.

DistributedTracePayload.httpSafe()

Trace através de um canal de transporte personalizado que o New Relic não suporta por padrão, como um transporte RPC proprietário

Transaction.getRequestMetadata(), .processRequestMetadata(...), .getResponseMetadata(), .processResponseMetadata(...)

Consulte também as informações neste documento sobre como usar Transaction para obter referências às classes da API New Relic.

Visualize ou altere o nome da métrica ou um nome de métrica agregada de um TracedMethod

(Um nome de métrica agregar, como OtherTransaction/all, não tem como escopo uma transação específica. Representa todas as transações anteriores.)

TracedMethod.getMetricName(), .setMetricName(...), .setRollupMetricName(...)

Consulte também as informações neste documento sobre como usar TracedMethod para obter referências às classes da API New Relic.

Relatar uma chamada para um serviço HTTP externo, servidor de banco de dados, fila de mensagens ou outro recurso externo que está sendo rastreado usando a anotação@Trace da API do agente Java

TracedMethod.reportAsExternal(...) passando argumentos construídos usando o construtor ExternalParameters .

Consulte também as informações neste documento sobre como usar TracedMethod para obter referências às classes da API New Relic.

Habilite e adicione rastreamento multiaplicativo ao se comunicar com um serviço HTTP ou JMS externo instrumentado pela New Relic

TracedMethod.addOutboundRequestHeaders(...) junto com TracedMethod.reportAsExternal(...)

Consulte também as informações neste documento sobre como usar TracedMethod para obter referências às classes da API New Relic.

Adicionar tempo para um servidor de aplicativo ou despachante que não é suportado automaticamente

Transaction.setRequest(...), Transaction.setResponse(...)ou NewRelic.setRequestAndResponse(...) e Transaction.markResponseSent()

Consulte também as informações neste documento sobre como usar Transaction para obter referências às classes da API New Relic.

Obtenha uma referência para o atual Transaction

NewRelic.getAgent().getTransaction()

Obtenha um Token para vincular trabalho assíncrono

Comece e obtenha uma referência para um Segment

Obtenha uma referência ao método que está sendo rastreado atualmente

NewRelic.getAgent().getTracedMethod()

Obtenha uma referência ao agente Agent

NewRelic.getAgent().getLogger()

Obtenha uma referência para a configuração Agent

NewRelic.getAgent().getConfig()

Obtenha uma referência de um agregador de métrica personalizada

NewRelic.getAgent().getAggregator()

Obtenha uma referência a Insights (nosso nome original para o recurso que regia o evento personalizado) para registrar o evento personalizado

NewRelic.getAgent().getInsights()

Definir explicitamente informações de porta, nome e versão para um servidor de aplicativo ou despachante e o nome da instância para uma JVM

Relatar um erro que o New Relic não reporta automaticamente

NewRelic.noticeError(...)

Quando dentro de uma transação, a última chamada para noticeError vence. Apenas 1 erro será relatado por transação.

Agrupe erros com sua própria impressão digital personalizada, implemente a interface ErrorGroupCallback e use-a para gerar chaves de agrupamento para erros que serão enviados para a New Relic. A impressão digital será usada para agrupar mensagens de erro na interface Errors Inbox .

public interface ErrorGroupCallback { String generateGroupingString(ErrorData errorData); }

Defina sua própria impressão digital de erro por meio de uma função de retorno de chamada. Para registrar um ErrorGroupCallback usado para gerar uma chave de agrupamento para o erro fornecido.

NewRelic.setErrorGroupCallback(errorGroupCallback)

Adicione o tempo de carregamento da página do browser para Transactions que o New Relic não adiciona ao cabeçalho automaticamente

Criar e acumular métrica personalizada

NewRelic.recordMetric(...), .recordResponseTimeMetric(...), ou .incrementCounter(...)

Gravar evento personalizado

Insights.recordCustomEvent(...)

Ou use NewRelic.addCustomParameter(...) para adicionar atributo personalizado ao tipo TransactionEvent definido pela New Relic.

Consulte também as informações neste documento sobre como usar Insights para obter referências às classes da API New Relic.

Forneça informações gerais da conta do provedor de nuvem ao agente

NewRelic.getAgent().getCloud().setAccountInfo(CloudAccountInfo.AWS_ACCOUNT_ID, "...");

Com esse método, você pode fornecer o tipo de informação da conta e seu valor. O agente usa essas informações para preencher o atributo cloud.resource_id nos spans selecionados de serviços na nuvem.

AWS DynamoDB e Kinesis são serviços que exigem esse valor para preencher o atributo cloud.resource_id . Da mesma forma, o AWS Lambda exige esse valor quando o ID da conta não faz parte do nome da função.

Chamar esse método substitui a respectiva configuração de nuvem. A chamada mostrada acima substitui cloud.aws.account_id.

Forneça informações específicas da conta do provedor de nuvem do cliente SDK ao agente

NewRelic.getAgent().getCloud().setAccountInfo(sdkClient, CloudAccountInfo.AWS_ACCOUNT_ID, "...");

Esta chamada fornece as mesmas informações que o método anterior, mas é específica para o cliente SDK fornecido. Quando o cliente SDK especificado for usado, esses dados serão usados em vez dos gerais.