| 1 |
# OpenTelemetry-Go |
| 2 |
|
| 3 |
[](https://github.com/open-telemetry/opentelemetry-go/actions/workflows/ci.yml) |
| 4 |
[](https://app.codecov.io/gh/open-telemetry/opentelemetry-go?branch=main) |
| 5 |
[](https://pkg.go.dev/go.opentelemetry.io/otel) |
| 6 |
[](https://goreportcard.com/report/go.opentelemetry.io/otel) |
| 7 |
[](https://scorecard.dev/viewer/?uri=github.com/open-telemetry/opentelemetry-go) |
| 8 |
[](https://www.bestpractices.dev/projects/9996) |
| 9 |
[](https://issues.oss-fuzz.com/issues?q=project:opentelemetry-go) |
| 10 |
[](https://app.fossa.com/projects/custom%2B162%2Fgithub.com%2Fopen-telemetry%2Fopentelemetry-go?ref=badge_shield&issueType=license) |
| 11 |
[](https://cloud-native.slack.com/archives/C01NPAXACKT) |
| 12 |
|
| 13 |
OpenTelemetry-Go is the [Go](https://golang.org/) implementation of [OpenTelemetry](https://opentelemetry.io/). |
| 14 |
It provides a set of APIs to directly measure performance and behavior of your software and send this data to observability platforms. |
| 15 |
|
| 16 |
## Project Status |
| 17 |
|
| 18 |
| Signal | Status | |
| 19 |
|---------|--------------------| |
| 20 |
| Traces | Stable | |
| 21 |
| Metrics | Stable | |
| 22 |
| Logs | Beta[^1] | |
| 23 |
|
| 24 |
Progress and status specific to this repository is tracked in our |
| 25 |
[project boards](https://github.com/open-telemetry/opentelemetry-go/projects) |
| 26 |
and |
| 27 |
[milestones](https://github.com/open-telemetry/opentelemetry-go/milestones). |
| 28 |
|
| 29 |
Project versioning information and stability guarantees can be found in the |
| 30 |
[versioning documentation](VERSIONING.md). |
| 31 |
|
| 32 |
[^1]: https://github.com/orgs/open-telemetry/projects/43 |
| 33 |
|
| 34 |
### Compatibility |
| 35 |
|
| 36 |
OpenTelemetry-Go ensures compatibility with the current supported versions of |
| 37 |
the [Go language](https://golang.org/doc/devel/release#policy): |
| 38 |
|
| 39 |
> Each major Go release is supported until there are two newer major releases. |
| 40 |
> 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. |
| 41 |
|
| 42 |
For versions of Go that are no longer supported upstream, opentelemetry-go will |
| 43 |
stop ensuring compatibility with these versions in the following manner: |
| 44 |
|
| 45 |
- A minor release of opentelemetry-go will be made to add support for the new |
| 46 |
supported release of Go. |
| 47 |
- The following minor release of opentelemetry-go will remove compatibility |
| 48 |
testing for the oldest (now archived upstream) version of Go. This, and |
| 49 |
future, releases of opentelemetry-go may include features only supported by |
| 50 |
the currently supported versions of Go. |
| 51 |
|
| 52 |
Currently, this project supports the following environments. |
| 53 |
|
| 54 |
| OS | Go Version | Architecture | |
| 55 |
|----------|------------|--------------| |
| 56 |
| Ubuntu | 1.26 | amd64 | |
| 57 |
| Ubuntu | 1.25 | amd64 | |
| 58 |
| Ubuntu | 1.26 | 386 | |
| 59 |
| Ubuntu | 1.25 | 386 | |
| 60 |
| Ubuntu | 1.26 | arm64 | |
| 61 |
| Ubuntu | 1.25 | arm64 | |
| 62 |
| macOS | 1.26 | amd64 | |
| 63 |
| macOS | 1.25 | amd64 | |
| 64 |
| macOS | 1.26 | arm64 | |
| 65 |
| macOS | 1.25 | arm64 | |
| 66 |
| Windows | 1.26 | amd64 | |
| 67 |
| Windows | 1.25 | amd64 | |
| 68 |
| Windows | 1.26 | 386 | |
| 69 |
| Windows | 1.25 | 386 | |
| 70 |
|
| 71 |
While this project should work for other systems, no compatibility guarantees |
| 72 |
are made for those systems currently. |
| 73 |
|
| 74 |
## Getting Started |
| 75 |
|
| 76 |
You can find a getting started guide on [opentelemetry.io](https://opentelemetry.io/docs/languages/go/getting-started/). |
| 77 |
|
| 78 |
OpenTelemetry's goal is to provide a single set of APIs to capture distributed |
| 79 |
traces and metrics from your application and send them to an observability |
| 80 |
platform. This project allows you to do just that for applications written in |
| 81 |
Go. There are two steps to this process: instrument your application, and |
| 82 |
configure an exporter. |
| 83 |
|
| 84 |
### Instrumentation |
| 85 |
|
| 86 |
To start capturing distributed traces and metric events from your application |
| 87 |
it first needs to be instrumented. The easiest way to do this is by using an |
| 88 |
instrumentation library for your code. Be sure to check out [the officially |
| 89 |
supported instrumentation |
| 90 |
libraries](https://github.com/open-telemetry/opentelemetry-go-contrib/tree/main/instrumentation). |
| 91 |
|
| 92 |
If you need to extend the telemetry an instrumentation library provides or want |
| 93 |
to build your own instrumentation for your application directly you will need |
| 94 |
to use the |
| 95 |
[Go otel](https://pkg.go.dev/go.opentelemetry.io/otel) |
| 96 |
package. The [examples](https://github.com/open-telemetry/opentelemetry-go-contrib/tree/main/examples) |
| 97 |
are a good way to see some practical uses of this process. |
| 98 |
|
| 99 |
### Export |
| 100 |
|
| 101 |
Now that your application is instrumented to collect telemetry, it needs an |
| 102 |
export pipeline to send that telemetry to an observability platform. |
| 103 |
|
| 104 |
All officially supported exporters for the OpenTelemetry project are contained in the [exporters directory](./exporters). |
| 105 |
|
| 106 |
| Exporter | Logs | Metrics | Traces | |
| 107 |
|---------------------------------------|:----:|:-------:|:------:| |
| 108 |
| [OTLP](./exporters/otlp/) | ✓ | ✓ | ✓ | |
| 109 |
| [Prometheus](./exporters/prometheus/) | | ✓ | | |
| 110 |
| [stdout](./exporters/stdout/) | ✓ | ✓ | ✓ | |
| 111 |
| [Zipkin](./exporters/zipkin/) | | | ✓ | |
| 112 |
|
| 113 |
## Contributing |
| 114 |
|
| 115 |
See the [contributing documentation](CONTRIBUTING.md). |