Configure seu próprio aplicativo ou serviço com OpenTelemetry

Antes que você comece

• Se ainda não o fez, inscreva-se para obter uma conta gratuita da New Relic.
• Obtenha a chave de licença da conta New Relic para a qual deseja relatar dados.

Instrumente seu aplicativo ou serviço com OpenTelemetry

Para ajudá-lo a começar a usar a instrumentação, o OpenTelemetry fornece produtos e SDKs específicos de linguagem. Muitas linguagens oferecem instrumentação pronta para uso para bibliotecas e estruturas comuns. Cada linguagem também fornece uma API para ajudá-lo a instrumentar manualmente seu código para coletar telemetria.

Acesse o repositório do seu idioma e siga as instruções para instrumentar seu código. Quando terminar, volte aqui para concluir a Etapa 3: revisar a configuração para exportar dados de telemetria para o New Relic.

• C++
• Erlang
• Go
• Java
• Javascript/Node.js
• .NET
• PHP
• Python
• Ruby
• Ferrugem
• Swift
• ...Veja uma lista completa de idiomas no GitHub

Revise a configuração para exportar dados de telemetria para o New Relic

A exportação de dados de telemetria depende do protocolo OpenTelemetry ou, abreviadamente, OTLP. Este é um protocolo de entrega de dados de telemetria de uso geral projetado para o projeto OpenTelemetry. Este protocolo descreve como codificar e transmitir dados de telemetria, o que o torna uma escolha natural para transporte de dados. Cada SDK de linguagem fornece um exportador OTLP que você pode configurar para exportar dados por OTLP.

Antes de exportar seus dados de telemetria, você precisa ter sua chave de licença de ingestão e o endpoint OTLP apropriado. Recomendamos colar essas informações em um arquivo de texto, pois você precisará de ambos nas etapas a seguir. Você tem duas opções para exportar dados para o New Relic via OTLP:

• Diretamente do seu aplicativo:

  

• Exportar de um coletor OpenTelemetry:

  

  Quer você exporte diretamente do seu aplicativo ou de um coletor, você precisará:

1. Esteja pronto para configurar o exportador OTLP para adicionar um cabeçalho (api-key). O valor é a chave de licença da conta New Relic para a qual você deseja enviar dados.

2. Com base na sua integração, esteja pronto para configurar o endpoint onde o exportador envia dados para a New Relic. endpoint são específicos da região, então use aquele onde sua organização New Relic está baseada. Por exemplo, se você estiver usando a região data center da UE, use um endpoint da UE . Use a tabela abaixo como guia e consulte as considerações adicionais sobre portas e endpoint.

   Portas e endpoint

   Integração	gRPC	HTTP	Endpoint	Portas suportadas	Nome do cabeçalho da API	Valor do cabeçalho da API	É necessária criptografia TLS
   OTLP dos EUA	✅	✅	https://otlp.nr-data.net	443, 4317, 4318	api-key	chave de licença	✅
   OTLP da UE	✅	✅	https://otlp.eu01.nr-data.net	443, 4317, 4318	api-key	chave de licença	✅
   OTLP FedRAMP dos EUA (Consulte conformidade com FedRAMP para obter mais informações)	✅	✅	https://gov-otlp.nr-data.net	443, 4317, 4318	api-key	chave de licença	✅
   Rastreamento infinito (Veja as práticas recomendadas para detalhes do endpoint	✅	✅	https://{trace-observer}	443	api-key	chave de licença	✅

   Por que três portas?

   Os padrões OTLP designam o tráfego gRPC para a porta 4317 e o tráfego HTTP para a porta 4318. O endpoint OTLP nativo do New Relic US FedRamp segue essas especificações. Ele também permite tráfego gRPC e HTTP na porta 443. Para simplificar, você pode omitir a porta, pois o esquema https seleciona automaticamente a porta 443.

   Qual versão do protocolo devo usar?

   OTLP possui três versões diferentes do protocolo: grpc, http/protobuf e http/json. O suporte para as diferentes versões varia de acordo com o idioma.

   Embora o New Relic seja compatível com todas as versões, se tivermos a opção, recomendamos usar http/protobuf. Esta é a recomendação padrão da especificação e provou ser mais robusta que grpc sem qualquer redução aparente no desempenho.

   Detalhes adicionais endpoint

   De acordo com a especificação OpenTelemetry em URLs de endpoint para OTLP/HTTP: se você estiver enviando tráfego HTTP e usando a variável de ambiente não por sinal (OTEL_EXPORTER_OTLP_ENDPOINT), você pode simplesmente definir OTEL_EXPORTER_OTLP_ENDPOINT=https://otlp.nr-data.net:{port} e o exportador deverá anexar o caminho apropriado para o tipo de sinal (ou seja, v1/traces ou v1/metrics).

   Se você estiver usando uma variável de ambiente por sinal (ou seja, OTEL_EXPORTER_OTLP_TRACES_ENDPOINT e/ou OTEL_EXPORTER_OTLP_METRICS_ENDPOINT), será necessário defini-la com o caminho apropriado. Por exemplo, OTEL_EXPORTER_OTLP_TRACES_ENDPOINT=https://otlp.nr-data.net:4318/v1/traces. Não fazer isso resultará em um 404. Observe que esta variável de ambiente tem precedência sobre aquela que não é por sinal.

   Node.js e TLS

   No Node.js, a biblioteca OpenTelemetry-coletor-exporter-grpc requer opções adicionais para ativar o TLS.

Conclua as etapas de configuração de exportação

Agora que você está familiarizado com a configuração específica do New Relic para exportação, você tem duas opções:

• Exporte diretamente para New Relic de seus aplicativos

• Exportar para New Relic de um coletor

  Exporte diretamente para New Relic de seus aplicativos

  Clique no link abaixo para o seu idioma e conclua as etapas de configuração. Quando terminar, volte aqui para concluir a Etapa 5. Visualize seus dados na interface do New Relic.

• C++

• Erlang

• Go

• Java

• Javascript/Node.js

• .NET

• PHP

• Python

• Ruby

• Ferrugem

• Swift

• ...Encontre suporte adicional à linguagem OTLP no GitHub

  Exportar para New Relic de um coletor

  Você pode configurar o coletor de diferentes maneiras e para diferentes finalidades. Se precisar de informações gerais sobre o coletor antes de iniciar a configuração, consulte nossa introdução.

  Escolha uma das opções a seguir para ver exemplos de configuração do seu coletor para exportação.

• Exemplo básico de coletor com docker

• Configuração do coletor para monitoramento de host de infraestrutura

• Exemplos adicionais de configuração de coletor

Visualize seus dados na interface do New Relic

Depois de instrumentar seu aplicativo ou serviço e configurá-lo para exportar seus dados para o New Relic, observe a interface do usuário do New Relic para rastrear, métrica e log.

A interface do OpenTelemetry tem algumas semelhanças com a nossa interface APM, então se você estiver familiarizado com ela, pode ir direto para a interface. Se precisar de ajuda para entender as opções da interface do OpenTelemetry ou como garantir que seus dados apareçam na interface, consulte Visualizar seus dados do OpenTelemetry no New Relic.