周玉环 d906a41c2e first commit před 2 dny
..
attribute d906a41c2e first commit před 2 dny
baggage d906a41c2e first commit před 2 dny
codes d906a41c2e first commit před 2 dny
internal d906a41c2e first commit před 2 dny
metric d906a41c2e first commit před 2 dny
propagation d906a41c2e first commit před 2 dny
semconv d906a41c2e first commit před 2 dny
trace d906a41c2e first commit před 2 dny
.codespellignore d906a41c2e first commit před 2 dny
.codespellrc d906a41c2e first commit před 2 dny
.gitattributes d906a41c2e first commit před 2 dny
.gitignore d906a41c2e first commit před 2 dny
.gitmodules d906a41c2e first commit před 2 dny
.golangci.yml d906a41c2e first commit před 2 dny
.lycheeignore d906a41c2e first commit před 2 dny
.markdownlint.yaml d906a41c2e first commit před 2 dny
CHANGELOG.md d906a41c2e first commit před 2 dny
CODEOWNERS d906a41c2e first commit před 2 dny
CONTRIBUTING.md d906a41c2e first commit před 2 dny
LICENSE d906a41c2e first commit před 2 dny
Makefile d906a41c2e first commit před 2 dny
README.md d906a41c2e first commit před 2 dny
RELEASING.md d906a41c2e first commit před 2 dny
VERSIONING.md d906a41c2e first commit před 2 dny
doc.go d906a41c2e first commit před 2 dny
error_handler.go d906a41c2e first commit před 2 dny
get_main_pkgs.sh d906a41c2e first commit před 2 dny
handler.go d906a41c2e first commit před 2 dny
internal_logging.go d906a41c2e first commit před 2 dny
metric.go d906a41c2e first commit před 2 dny
propagation.go d906a41c2e first commit před 2 dny
requirements.txt d906a41c2e first commit před 2 dny
trace.go d906a41c2e first commit před 2 dny
verify_examples.sh d906a41c2e first commit před 2 dny
version.go d906a41c2e first commit před 2 dny
versions.yaml d906a41c2e first commit před 2 dny

README.md

OpenTelemetry-Go

CI codecov.io PkgGoDev Go Report Card Slack

OpenTelemetry-Go is the Go implementation of OpenTelemetry. It provides a set of APIs to directly measure performance and behavior of your software and send this data to observability platforms.

Project Status

Signal Status
Traces Stable
Metrics Stable
Logs Design [1]
  • [1]: Currently the logs signal development is in a design phase (#4696). No Logs Pull Requests are currently being accepted.

Progress and status specific to this repository is tracked in our project boards and milestones.

Project versioning information and stability guarantees can be found in the versioning documentation.

Compatibility

OpenTelemetry-Go ensures compatibility with the current supported versions of the Go language:

Each major Go release is supported until there are two newer major releases. For example, Go 1.5 was supported until the Go 1.7 release, and Go 1.6 was supported until the Go 1.8 release.

For versions of Go that are no longer supported upstream, opentelemetry-go will stop ensuring compatibility with these versions in the following manner:

  • A minor release of opentelemetry-go will be made to add support for the new supported release of Go.
  • The following minor release of opentelemetry-go will remove compatibility testing for the oldest (now archived upstream) version of Go. This, and future, releases of opentelemetry-go may include features only supported by the currently supported versions of Go.

Currently, this project supports the following environments.

OS Go Version Architecture
Ubuntu 1.21 amd64
Ubuntu 1.20 amd64
Ubuntu 1.21 386
Ubuntu 1.20 386
MacOS 1.21 amd64
MacOS 1.20 amd64
Windows 1.21 amd64
Windows 1.20 amd64
Windows 1.21 386
Windows 1.20 386

While this project should work for other systems, no compatibility guarantees are made for those systems currently.

Getting Started

You can find a getting started guide on opentelemetry.io.

OpenTelemetry's goal is to provide a single set of APIs to capture distributed traces and metrics from your application and send them to an observability platform. This project allows you to do just that for applications written in Go. There are two steps to this process: instrument your application, and configure an exporter.

Instrumentation

To start capturing distributed traces and metric events from your application it first needs to be instrumented. The easiest way to do this is by using an instrumentation library for your code. Be sure to check out the officially supported instrumentation libraries.

If you need to extend the telemetry an instrumentation library provides or want to build your own instrumentation for your application directly you will need to use the Go otel package. The included examples are a good way to see some practical uses of this process.

Export

Now that your application is instrumented to collect telemetry, it needs an export pipeline to send that telemetry to an observability platform.

All officially supported exporters for the OpenTelemetry project are contained in the exporters directory.

Exporter Metrics Traces
OTLP
Prometheus
stdout
Zipkin

Contributing

See the contributing documentation.