Monitor Jenkins com OpenTelemetry e New Relic

Monitor Jenkins com o plug-in OpenTelemetry visualizando jobs e execuções de pipeline como rastreamento distribuído. Você também pode instalar o início rápido para obter um dashboard pré-construído para monitor seu pipeline Jenkins.

Pré-requisitos

Você precisa primeiro instalar o plug-in OpenTelemetry do Jenkins:

1. Log no Jenkins.
2. No dashboard, clique em Manage Jenkins.
3. Em Configuração do sistema, clique em Plugins.
4. Clique na guia Available plugins e procure por OpenTelemetry.
5. Marque a caixa de seleção OpenTelemetry e Install without restart.
6. Assim que a instalação for concluída, clique em Manage Jenkins.
7. Em System Configuration, clique em System.
8. Role para baixo e procure uma seção chamada OpenTelemetry. Se você não consegue ver, reinicie o Jenkins.

Configuração

Você precisa de um New Relic OTLP endpoint e um chave de licençapara configurar o OpenTelemetry plug-in Jenkins para enviar dados ao New Relic.

1. Insira um endpoint OTLP. Por exemplo, https://otlp.nr-data.net:4317.
2. Para autenticação, selecione Header Authentication: a. No campo Header Name , insira api-key. b. No campo Header Value , insira um texto secreto contendo sua chave de licença de ingestão do New Relic.
3. Salve as alterações.

Se você não tiver um texto secreto criado com sua chave de licença do New Relic, clique no botão + Add e selecione Jenkins Credentials Provider para criar um. Você pode manter os valores padrão, exceto kind e secret e description é opcional.

1. No dropdown Kind, selecione Secret text.
2. No campo secret , insira sua chave de licença de ingestão do New Relic.
3. Opcionalmente, adicione uma descrição para indicar para que serve o texto secreto.

Validação

Execute um trabalho ou crie um novo pipeline para ver os dados do Jenkins no New Relic. Veja como construir um pipeline:

1. Log no Jenkins e clique em New Item.
2. Insira um nome de item, clique em Pipeline e depois em OK.
3. Role para baixo até a seção Pipeline .
4. Use o script Pipeline e selecione uma opção no dropdown try sample Pipeline... .
5. Clique em Salvar.
6. No pipeline recém-criado, clique em Build Now.
7. Cheguei a one.newrelic.com > All capabilities > APM & services > Services - OpenTelemetry > jenkins.
8. Clique em Distributed tracing para visualizar jobs e execuções de pipeline.
9. Clique em Logs para ver o registro do console Jenkins. Se não houver log, verifique se a variável de ambiente OTEL_LOGS_EXPORTER="otlp" está definida.

Instale o dashboard de início rápido do Jenkins

Depois de enviar os dados do pipeline Jenkins para o New Relic, você também pode monitor facilmente seus trabalhos e execuções de pipeline com o dashboard pré-construído do New Relic Instant observabilidade. Comece em minutos com um dashboard pré-construído para ver as principais métricas em uma visão consolidada:

1. Acesse o início rápido do Jenkins em New Relic Instant observabilidade e clique em + Install now.
2. Selecione uma conta e clique em Begin installation.
3. Se você já tiver concluído a validação, selecione done para passar para a próxima etapa.
4. O quickstart implantar os recursos em sua conta. Clique em see your data para acessar o dashboard.

Atributo e tag de recurso

Você pode adicionar atributos de recursos à configuração do plugin Jenkins. Isso permite que você inclua atributos para todos os dados de log, métrica e trace gerados pelo plugin. Atributos de recursos que têm nomes começando com tags. também adicionarão a tag entidade à sua entidade do Jenkins.

Você pode definir atributo de duas maneiras:

<configurationProperties>
    otel.resource.attributes=attribute1=value1,attribute2=value2,tags.tag1=tagValue1
  </configurationProperties>

[Service]
  # Set OTel Environment Options
  Environment="OTEL_RESOURCE_ATTRIBUTES=attribute1=value1,attribute2=value2,tags.tag1=tagValue1"