Name | Date | Size | #Lines | LOC | ||
---|---|---|---|---|---|---|
.. | 03-May-2022 | - | ||||
.github/ | H | 12-Nov-2021 | - | 758 | 705 | |
attribute/ | H | 12-Nov-2021 | - | 2,235 | 1,517 | |
baggage/ | H | 12-Nov-2021 | - | 1,305 | 965 | |
bridge/ | H | 12-Nov-2021 | - | 5,280 | 3,837 | |
codes/ | H | 12-Nov-2021 | - | 298 | 206 | |
example/ | H | 12-Nov-2021 | - | 3,044 | 2,250 | |
exporters/ | H | 12-Nov-2021 | - | 38,867 | 29,530 | |
internal/ | H | 12-Nov-2021 | - | 5,998 | 4,296 | |
metric/ | H | 12-Nov-2021 | - | 3,821 | 2,264 | |
propagation/ | H | 12-Nov-2021 | - | 1,384 | 992 | |
schema/ | H | 12-Nov-2021 | - | 793 | 495 | |
sdk/ | H | 12-Nov-2021 | - | 20,224 | 13,524 | |
semconv/ | H | 12-Nov-2021 | - | 15,651 | 7,470 | |
trace/ | H | 12-Nov-2021 | - | 2,985 | 2,103 | |
website_docs/ | H | 12-Nov-2021 | - | 764 | 576 | |
.gitattributes | H A D | 12-Nov-2021 | 89 | 4 | 3 | |
.gitignore | H A D | 12-Nov-2021 | 343 | 22 | 18 | |
.gitmodules | H A D | 12-Nov-2021 | 147 | 4 | 3 | |
.golangci.yml | H A D | 12-Nov-2021 | 750 | 33 | 29 | |
.markdown-link.json | H A D | 12-Nov-2021 | 335 | 17 | 16 | |
.markdownlint.yaml | H A D | 12-Nov-2021 | 309 | 30 | 20 | |
CHANGELOG.md | H A D | 12-Nov-2021 | 111.8 KiB | 1,639 | 1,346 | |
CODEOWNERS | H A D | 12-Nov-2021 | 517 | 18 | 15 | |
CONTRIBUTING.md | H A D | 12-Nov-2021 | 15.3 KiB | 496 | 373 | |
LICENSE | H A D | 12-Nov-2021 | 11.1 KiB | 202 | 169 | |
Makefile | H A D | 12-Nov-2021 | 6.5 KiB | 208 | 154 | |
README.md | H A D | 12-Nov-2021 | 4.6 KiB | 101 | 76 | |
RELEASING.md | H A D | 12-Nov-2021 | 5.5 KiB | 134 | 92 | |
VERSIONING.md | H A D | 12-Nov-2021 | 10.7 KiB | 225 | 194 | |
doc.go | H A D | 12-Nov-2021 | 1.5 KiB | 35 | 1 | |
error_handler.go | H A D | 12-Nov-2021 | 1.4 KiB | 39 | 9 | |
get_main_pkgs.sh | H A D | 12-Nov-2021 | 1.2 KiB | 42 | 17 | |
go.mod | H A D | 12-Nov-2021 | 2.6 KiB | 74 | 39 | |
go.sum | H A D | 12-Nov-2021 | 1.4 KiB | 16 | 15 | |
handler.go | H A D | 12-Nov-2021 | 3.3 KiB | 108 | 52 | |
handler_test.go | H A D | 12-Nov-2021 | 5.9 KiB | 267 | 195 | |
pre_release.sh | H A D | 12-Nov-2021 | 2.5 KiB | 96 | 57 | |
propagation.go | H A D | 12-Nov-2021 | 1.1 KiB | 32 | 11 | |
tag.sh | H A D | 12-Nov-2021 | 4.2 KiB | 179 | 122 | |
trace.go | H A D | 12-Nov-2021 | 1.6 KiB | 45 | 14 | |
trace_test.go | H A D | 12-Nov-2021 | 1.2 KiB | 44 | 22 | |
verify_examples.sh | H A D | 12-Nov-2021 | 2.3 KiB | 86 | 48 | |
version.go | H A D | 12-Nov-2021 | 758 | 21 | 4 | |
version_test.go | H A D | 12-Nov-2021 | 1.1 KiB | 35 | 14 | |
versions.yaml | H A D | 12-Nov-2021 | 2.4 KiB | 60 | 58 |
README.md
1# OpenTelemetry-Go 2 3[![CI](https://github.com/open-telemetry/opentelemetry-go/workflows/ci/badge.svg)](https://github.com/open-telemetry/opentelemetry-go/actions?query=workflow%3Aci+branch%3Amain) 4[![codecov.io](https://codecov.io/gh/open-telemetry/opentelemetry-go/coverage.svg?branch=main)](https://app.codecov.io/gh/open-telemetry/opentelemetry-go?branch=main) 5[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel)](https://pkg.go.dev/go.opentelemetry.io/otel) 6[![Go Report Card](https://goreportcard.com/badge/go.opentelemetry.io/otel)](https://goreportcard.com/report/go.opentelemetry.io/otel) 7[![Slack](https://img.shields.io/badge/slack-@cncf/otel--go-brightgreen.svg?logo=slack)](https://cloud-native.slack.com/archives/C01NPAXACKT) 8 9OpenTelemetry-Go is the [Go](https://golang.org/) implementation of [OpenTelemetry](https://opentelemetry.io/). 10It provides a set of APIs to directly measure performance and behavior of your software and send this data to observability platforms. 11 12## Project Status 13 14| Signal | Status | Project | 15| ------- | ---------- | ------- | 16| Traces | Stable | N/A | 17| Metrics | Alpha | N/A | 18| Logs | Frozen [1] | N/A | 19 20- [1]: The Logs signal development is halted for this project while we develop both Traces and Metrics. 21 No Logs Pull Requests are currently being accepted. 22 23Progress and status specific to this repository is tracked in our local 24[project boards](https://github.com/open-telemetry/opentelemetry-go/projects) 25and 26[milestones](https://github.com/open-telemetry/opentelemetry-go/milestones). 27 28Project versioning information and stability guarantees can be found in the 29[versioning documentation](./VERSIONING.md). 30 31### Compatibility 32 33This project is tested on the following systems. 34 35| OS | Go Version | Architecture | 36| ------- | ---------- | ------------ | 37| Ubuntu | 1.17 | amd64 | 38| Ubuntu | 1.16 | amd64 | 39| Ubuntu | 1.15 | amd64 | 40| Ubuntu | 1.17 | 386 | 41| Ubuntu | 1.16 | 386 | 42| Ubuntu | 1.15 | 386 | 43| MacOS | 1.17 | amd64 | 44| MacOS | 1.16 | amd64 | 45| MacOS | 1.15 | amd64 | 46| Windows | 1.17 | amd64 | 47| Windows | 1.16 | amd64 | 48| Windows | 1.15 | amd64 | 49| Windows | 1.17 | 386 | 50| Windows | 1.16 | 386 | 51| Windows | 1.15 | 386 | 52 53While this project should work for other systems, no compatibility guarantees 54are made for those systems currently. 55 56## Getting Started 57 58You can find a getting started guide on [opentelemetry.io](https://opentelemetry.io/docs/go/getting-started/). 59 60OpenTelemetry's goal is to provide a single set of APIs to capture distributed 61traces and metrics from your application and send them to an observability 62platform. This project allows you to do just that for applications written in 63Go. There are two steps to this process: instrument your application, and 64configure an exporter. 65 66### Instrumentation 67 68To start capturing distributed traces and metric events from your application 69it first needs to be instrumented. The easiest way to do this is by using an 70instrumentation library for your code. Be sure to check out [the officially 71supported instrumentation 72libraries](https://github.com/open-telemetry/opentelemetry-go-contrib/tree/main/instrumentation). 73 74If you need to extend the telemetry an instrumentation library provides or want 75to build your own instrumentation for your application directly you will need 76to use the 77[go.opentelemetry.io/otel/api](https://pkg.go.dev/go.opentelemetry.io/otel/api) 78package. The included [examples](./example/) are a good way to see some 79practical uses of this process. 80 81### Export 82 83Now that your application is instrumented to collect telemetry, it needs an 84export pipeline to send that telemetry to an observability platform. 85 86All officially supported exporters for the OpenTelemetry project are contained in the [exporters directory](./exporters). 87 88| Exporter | Metrics | Traces | 89| :-----------------------------------: | :-----: | :----: | 90| [Jaeger](./exporters/jaeger/) | | ✓ | 91| [OTLP](./exporters/otlp/) | ✓ | ✓ | 92| [Prometheus](./exporters/prometheus/) | ✓ | | 93| [stdout](./exporters/stdout/) | ✓ | ✓ | 94| [Zipkin](./exporters/zipkin/) | | ✓ | 95 96Additionally, OpenTelemetry community supported exporters can be found in the [contrib repository](https://github.com/open-telemetry/opentelemetry-go-contrib/tree/main/exporters). 97 98## Contributing 99 100See the [contributing documentation](CONTRIBUTING.md). 101