00a1ec5fc4
* Add documentation guidelines and improve Jaeger exporter readme * Improve docs * Update CONTRIBUTING.md |
||
|---|---|---|
| .github | ||
| attribute | ||
| baggage | ||
| bridge | ||
| codes | ||
| example | ||
| exporters | ||
| internal | ||
| metric | ||
| oteltest | ||
| propagation | ||
| sdk | ||
| semconv/v1.4.0 | ||
| trace | ||
| website_docs | ||
| .gitattributes | ||
| .gitignore | ||
| .gitmodules | ||
| .golangci.yml | ||
| .markdown-link.json | ||
| .markdownlint.yaml | ||
| CHANGELOG.md | ||
| CODEOWNERS | ||
| CONTRIBUTING.md | ||
| doc.go | ||
| error_handler.go | ||
| get_main_pkgs.sh | ||
| go.mod | ||
| go.sum | ||
| handler_test.go | ||
| handler.go | ||
| LICENSE | ||
| Makefile | ||
| pre_release.sh | ||
| propagation.go | ||
| README.md | ||
| RELEASING.md | ||
| tag.sh | ||
| trace_test.go | ||
| trace.go | ||
| verify_examples.sh | ||
| version_test.go | ||
| version.go | ||
| VERSIONING.md | ||
| versions.yaml | ||
OpenTelemetry-Go
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 | Project |
|---|---|---|
| Traces | Release Candidate | 1.0.0 |
| Metrics | Development paused [1] | N/A |
| Logs | Frozen [2] | N/A |
- [1]: The development of the metrics API and SDK has paused due to limited development resources, prioritization of a stable Traces release, and instability of the official overall design from the OpenTelemetry specification. Pull Requests for metrics related issues are not being accepted currently outside of security vulnerability mitigations.
- [2]: The Logs signal development is halted for this project while we develop both Traces and Metrics. No Logs Pull Requests are currently being accepted.
Progress and status specific to this repository is tracked in our local project boards and milestones.
Project versioning information and stability guarantees can be found in the versioning documentation.
Compatibility
This project is tested on the following systems.
| OS | Go Version | Architecture |
|---|---|---|
| Ubuntu | 1.16 | amd64 |
| Ubuntu | 1.15 | amd64 |
| Ubuntu | 1.16 | 386 |
| Ubuntu | 1.15 | 386 |
| MacOS | 1.16 | amd64 |
| MacOS | 1.15 | amd64 |
| Windows | 1.16 | amd64 |
| Windows | 1.15 | amd64 |
| Windows | 1.16 | 386 |
| Windows | 1.15 | 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.opentelemetry.io/otel/api 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 |
|---|---|---|
| Jaeger | ✓ | |
| OTLP | ✓ | ✓ |
| Prometheus | ✓ | |
| stdout | ✓ | ✓ |
| Zipkin | ✓ |
Additionally, OpenTelemetry community supported exporters can be found in the contrib repository.
Contributing
See the contributing documentation.