{"id":15045191,"url":"https://github.com/jenkinsci/opentelemetry-plugin","last_synced_at":"2025-05-16T18:10:35.878Z","repository":{"id":37941342,"uuid":"340398655","full_name":"jenkinsci/opentelemetry-plugin","owner":"jenkinsci","description":"Monitor and observe Jenkins with OpenTelemetry.","archived":false,"fork":false,"pushed_at":"2025-05-06T16:15:34.000Z","size":31861,"stargazers_count":107,"open_issues_count":38,"forks_count":59,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-05-06T17:28:42.286Z","etag":null,"topics":["jenkins","monitoring","observability","opentelemetry"],"latest_commit_sha":null,"homepage":"https://plugins.jenkins.io/opentelemetry/","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jenkinsci.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"docs/security_obs.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-02-19T14:45:52.000Z","updated_at":"2025-05-06T16:15:36.000Z","dependencies_parsed_at":"2022-07-07T05:34:48.592Z","dependency_job_id":"624fe22b-7ee6-4523-8dc1-bc19159582a1","html_url":"https://github.com/jenkinsci/opentelemetry-plugin","commit_stats":{"total_commits":1094,"total_committers":28,"mean_commits":39.07142857142857,"dds":0.553016453382084,"last_synced_commit":"26ca14fcd9315ef97b712a5c2f5e3b1a33b9437a"},"previous_names":[],"tags_count":117,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jenkinsci%2Fopentelemetry-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jenkinsci%2Fopentelemetry-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jenkinsci%2Fopentelemetry-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jenkinsci%2Fopentelemetry-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jenkinsci","download_url":"https://codeload.github.com/jenkinsci/opentelemetry-plugin/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254582907,"owners_count":22095518,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["jenkins","monitoring","observability","opentelemetry"],"created_at":"2024-09-24T20:51:33.977Z","updated_at":"2025-05-16T18:10:35.872Z","avatar_url":"https://github.com/jenkinsci.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Jenkins OpenTelemetry Plugin\n\n[![Build Status](https://ci.jenkins.io/job/Plugins/job/opentelemetry-plugin/job/main/badge/icon)](https://ci.jenkins.io/job/Plugins/job/opentelemetry-plugin/job/main/)\n[![Contributors](https://img.shields.io/github/contributors/jenkinsci/opentelemetry-plugin.svg)](https://github.com/jenkinsci/opentelemetry-plugin/graphs/contributors)\n[![Jenkins Plugin](https://img.shields.io/jenkins/plugin/v/opentelemetry.svg)](https://plugins.jenkins.io/opentelemetry)\n[![GitHub release](https://img.shields.io/github/release/jenkinsci/opentelemetry-plugin.svg?label=changelog)](https://github.com/jenkinsci/opentelemetry-plugin/releases/latest)\n[![Jenkins Plugin Installs](https://img.shields.io/jenkins/plugin/i/opentelemetry.svg?color=blue)](https://plugins.jenkins.io/opentelemetry)\n[![Otel SDK](https://img.shields.io/badge/otel--sdk-1.44.1-blue?style=flat\u0026logo=opentelemetry)](https://github.com/open-telemetry/opentelemetry-java/releases/tag/v1.44.1)\n\n## Introduction\n\nMonitor and observe Jenkins with OpenTelemetry.\n\nVisualize jobs and pipelines executions as distributed traces:\n\n![SpringBootPipeline Execution Trace](docs/images/jenkins-maven-execution-trace-jaeger.png)\n\n*Example pipeline execution trace of a SpringBoot Maven going application*\n\nVisualize Jenkins and pipeline health indicators:\n\n![Example Kibana dashboard of the Jenkins and CI jobs health](docs/images/kibana_jenkins_overview_dashboard.png)\n\n*Example Kibana dashboard of the Jenkins and CI jobs health*\n\nTroubleshoot Jenkins performances with distributed tracing of HTTPs requests:\n\n![Jenkins HTTP request trace with Jaeger](docs/images/http-tracing/jenkins-http-request-trace-jaeger.png)\n\n*Example Jenkins HTTP trace*\n\n## Architecture\n\nUsing the [OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector-contrib/releases), you can\nuse many monitoring backends to monitor Jenkins such as Jaeger, Zipkin, Prometheus, Elastic Observability and many\nothers listed [here](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter).\n\nHere are example architectures with Elastic, Jaeger, and Prometheus:\n\n| CI/CD Observability with Jaeger and Prometheus                                                                                                                                                                            | CI/CD Observability with Elastic                                                                                                                                                                                |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ![Jenkins monitoring with Jaeger and Prometheus](docs/images/jenkins-opentelemetry-architecture-jaeger-prometheus.png) | ![Jenkins monitoring with Elastic Observability](docs/images/jenkins-opentelemetry-architecture-elastic.png) |\n\n## Getting started\n\n* Set up an OpenTelemetry endpoint such as\n  the [OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector-contrib)\n* Install the Jenkins OpenTelemetry plugin\n* Configure the Jenkins OpenTelemetry plugin navigating to the \"Manage Jenkins / Configure System\" screen. In the\n  OpenTelemetry section define:\n    * \"OTLP Endpoint\": the hostname and port of the OpenTelemetry GRPC Protocol (OTLP GRPC) endpoint, typically an\n      OpenTelemetry Collector or directly an Observability backend that supports the OTLP GRPC protocol\n    * \"Authentication\": authentication mechanism used by your OTLP Endpoint\n        * \"Header Authentication\" : name of the authentication header if header based authentication is used.\n        * \"Bearer Token Authentication\": Bearer token when using header based authentication. Note that Elastic APM\n          token authentication uses a \"Bearer Token Authentication\".\n        * \"No Authentication\"\n    * Check \"Export OpenTelemetry configuration as environment variables\" to easily integrate visibility in other build\n      tools (see the otel-cli, the OpenTelemetry Maven extension, the OpenTelemetry Ansible integration...)\n    * Visualization: add the backend used to visualize job executions as traces.\n        * Elastic Observability\n        * Jaeger\n        * Zipkin\n        * Custom Observability backend for other visualization solutions\n* Set up Jenkins health dashboards on your OpenTelemetry metrics visualization solution. See details including guidance\n  for Elastic Kibana [here](https://github.com/jenkinsci/opentelemetry-plugin/blob/master/docs/monitoring-metrics.md).\n\n![Sample Configuration](docs/images/jenkins-opentelemetry-plugin-configuration.png)\n\n*Example Jenkins OpenTelemetry configuration*\n\n## Setup and Configuration\n\nFor details to set up Jenkins with Elastic, Jaeger or Prometheus, to configure the integration including using Jenkins\nConfiguration as Code,\nsee [Setup and Configuration](https://github.com/jenkinsci/opentelemetry-plugin/blob/master/docs/setup-and-configuration.md).\n\n## Troubleshooting and Optimizing Jenkins Jobs and Pipelines Using Tracing on the Builds\n\nFor details on how to explore and troubleshoot jobs and pipelines builds as traces,\nsee [Traces of Jobs and Pipeline Builds](https://github.com/jenkinsci/opentelemetry-plugin/blob/master/docs/job-traces.md).\n\n![SpringBootPipeline Execution Trace](docs/images/jenkins-maven-execution-trace-jaeger.png)\n\n*Example pipeline execution trace of a SpringBoot app built with Maven going through security checks with Snyk, deployed on a Maven repository and published as a Docker image*\n\n## Troubleshooting pipeline plugins and the execution on the Jenkins build agents\n\nFor details on the execution of pipeline plugin steps on the Jenkins build agents,\nactivate tracing in the Jenkins build agents using:\n\n```properties\notel.instrumentation.jenkins.agent.enabled=true\n```\n\nTo activate detailed traces of the communication from the Jenkins Controller to the Jenkins Agents, activate the\ninstrumentation of Jenkins remoting with:\n\n```properties\notel.instrumentation.jenkins.remoting.enabled=true\n```\n\nNote that the instrumentation of Jenkins remoting is not feature complete and may not capture all the communication\nbetween the Jenkins Controller and the Jenkins Agents.\n\n## Troubleshooting Jenkins Performances Using Tracing on the HTTP Requests of the Jenkins Controller\n\nFor details to set up Jenkins with Elastic, Jaeger or Prometheus, to configure the integration including using Jenkins\nConfiguration as Code,\nsee [Setup and Configuration](https://github.com/jenkinsci/opentelemetry-plugin/blob/master/docs/setup-and-configuration.md).\n\n## Jenkins Security\n\nMonitor access to Jenkins to detect anomalous behaviours.\n\nFor details, see the security logs, metrics, and trace\nattributes [here](https://github.com/jenkinsci/opentelemetry-plugin/blob/master/docs/security_obs.md).\n\n## Storing Jenkins Pipeline Logs in an Observability Backend\n\nFor details on how to store Jenkins pipelines build logs in an Observability backend like Elastic or Loki,\nsee [Storing Jenkins Pipeline Logs in an Observability Backend though OpenTelemetry](https://github.com/jenkinsci/opentelemetry-plugin/blob/master/docs/build-logs.md).\n\n![Storing Jenkins pipeline logs in Elasticsearch and visualizing logs both in Kibana and through Jenkins GUI](docs/images/jenkins-pipeline-logs-elastic-with-visualization-through-jenkins.png)\n\n*Storing Jenkins pipeline logs in Elasticsearch and visualizing logs both in Kibana and through Jenkins GUI*\n\n## Other CI/CD Tools supporting OpenTelemetry traces\n\nList of other CI/CD tools that support OpenTelemetry traces and integrate with the Jenkins OpenTelemetryPlugin creating\na distributed traces providing end to end visibility.\n\n### OpenTelemetry Maven Extension\n\nThe [OpenTelemetry Maven Extension](https://github.com/open-telemetry/opentelemetry-java-contrib/blob/main/maven-extension/)\nis a Maven extension to instrument with traces steps of Maven builds, including capturing details of the produced\nartifacts for traceability.\n\nℹ️ For seamless and turnkey integration of the trace of the Maven builds that use the OpenTelemetry Maven Extension with\nthe Jenkins trace, consider in the Jenkins configuration to enable \"Export OpenTelemetry configuration as environment\nvariables\".\n\n### OpenTelemetry Ansible Plugin\n\nThe [OpenTelemetry Ansible Plugin](https://docs.ansible.com/ansible/latest/collections/community/general/opentelemetry_callback.html)\nis an Ansible callback to instrument with traces the tasks of Ansible playbooks.\n\nℹ️ For seamless and turnkey integration of the trace of the Ansible playbooks that use the OpenTelemetry plugin with the\nJenkins trace, consider in the Jenkins configuration to enable \"Export OpenTelemetry configuration as environment\nvariables\".\n\n### pytest-otel\n\nThe [PyTest Otel Plugin](https://pypi.org/project/pytest-otel/) is a PyTest plugin to report each PyTest test as a span\nof a trace.\n\nℹ️ For seamless and turnkey integration of the trace of the PyTest tests that use the OpenTelemetry plugin with the\nJenkins trace, consider in the Jenkins configuration to enable \"Export OpenTelemetry configuration as environment\nvariables\".\n\n### Otel CLI\n\nThe [`otel-cli`](https://github.com/equinix-labs/otel-cli) is a command line wrapper to observe the execution of a shell\ncommand as an OpenTelemetry trace.\n\n## FAQ\n\n### Enrich your pipeline `sh`, `bat`, and `powershell` steps with meaningful explanation thanks to labels\n\nIf you use Jenkins pipelines in conjunction with the `sh`, `bat`, `powershell` steps, then it's highly recommended using\nthe `label` argument to add a meaningful explanation thanks to step labels. Example:\n\n```groovy\nnode {\n    sh(label: 'Maven verify', script: './mvnw deploy')\n}\n```\n\n### Using the OpenTelemetry OTLP/HTTP rather than OTLP/GRPC protocol\n\nNavigate to the Jenkins OpenTelemetry Plugin configuration, in the \"Advanced\" section, add to the \"Configuration\nProperties text area the following:\n\n```properties\notel.exporter.otlp.protocol=http/protobuf\n```\n\n### Support for disabling the Groovy Sandbox and accessing the Jenkins pipeline logs APIs while enabling the Jenkins OpenTelemetry Plugin\n\nNo test have been done on disabling the Groovy Sandbox and accessing the Jenkins pipeline logs APIs while enabling the\nJenkins OpenTelemetry Plugin for the following reasons:\n\n* Disabling the Groovy Sandbox is a very advanced use case due to the security implications of doing so\n* The surface of Jenkins pipeline logs capabilities exposed by disabling the Groovy sandbox is very broad and goes way beyond the OpenTelemetry plugin\n\nIf you are limited with the current capabilities of the Jenkins OpenTelemetry Plugin and consider opening up the Groovy\nsandbox to workaround these limitations, please prefer to reach out to us creating an enhancement request so we can work together at productizing the proper secured solution to your problem.\n\n## Learn More\n\n* You can look at this video tutorial to get\n  started:\n  \n  [![Tracing Your Jenkins Pipelines With OpenTelemetry and Jaeger](https://img.youtube.com/vi/3XzVOxvNpGM/0.jpg)](https://www.youtube.com/watch?v=3XzVOxvNpGM)\n* [DevOpsWorld 2021 - Embracing Observability in Jenkins with OpenTelemetry](https://www.devopsworld.com/agenda/session/581459)\n\n## Demos\n\nIf you'd like to see this plugin in action with some other integrations then refer to the [demos](demos/README.md).\n\n## Contributing\n\nRefer to our [contribution guidelines](https://github.com/jenkinsci/.github/blob/master/CONTRIBUTING.md)\n\n## LICENSE\n\nLicensed under Apache Software License 2, see [LICENSE](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjenkinsci%2Fopentelemetry-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjenkinsci%2Fopentelemetry-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjenkinsci%2Fopentelemetry-plugin/lists"}