• Home
  • History
  • Annotate
Name Date Size #Lines LOC

..03-May-2022-

.github/H23-Apr-2021-

attribute/H23-Apr-2021-

baggage/H23-Apr-2021-

bridge/H23-Apr-2021-

codes/H23-Apr-2021-

example/H23-Apr-2021-

exporters/H23-Apr-2021-

internal/H23-Apr-2021-

metric/H23-Apr-2021-

oteltest/H23-Apr-2021-

propagation/H23-Apr-2021-

sdk/H23-Apr-2021-

semconv/H23-Apr-2021-

trace/H23-Apr-2021-

unit/H23-Apr-2021-

website_docs/H23-Apr-2021-

.gitignoreH A D23-Apr-2021293

.gitmodulesH A D23-Apr-2021147

.golangci.ymlH A D23-Apr-2021750

CHANGELOG.mdH A D23-Apr-202184.6 KiB

CODEOWNERSH A D23-Apr-2021493

CONTRIBUTING.mdH A D23-Apr-202111.8 KiB

LICENSEH A D23-Apr-202111.1 KiB

MakefileH A D23-Apr-20215.6 KiB

README.mdH A D23-Apr-20214 KiB

RELEASING.mdH A D23-Apr-20212.9 KiB

VERSIONING.mdH A D23-Apr-202110.4 KiB

doc.goH A D23-Apr-20211.7 KiB

error_handler.goH A D23-Apr-2021825

get_main_pkgs.shH A D23-Apr-20211.2 KiB

go.modH A D23-Apr-20211.8 KiB

go.sumH A D23-Apr-20211.4 KiB

handler.goH A D23-Apr-20212.5 KiB

handler_test.goH A D23-Apr-20212.2 KiB

pre_release.shH A D23-Apr-20212.5 KiB

propagation.goH A D23-Apr-20211.1 KiB

tag.shH A D23-Apr-20214.2 KiB

trace.goH A D23-Apr-20211.5 KiB

trace_test.goH A D23-Apr-20211.2 KiB

verify_examples.shH A D23-Apr-20212.3 KiB

version.goH A D23-Apr-2021759

version_test.goH A D23-Apr-20211.1 KiB

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[![PkgGoDev](https://pkg.go.dev/badge/go.opentelemetry.io/otel)](https://pkg.go.dev/go.opentelemetry.io/otel)
5[![Go Report Card](https://goreportcard.com/badge/go.opentelemetry.io/otel)](https://goreportcard.com/report/go.opentelemetry.io/otel)
6[![Slack](https://img.shields.io/badge/slack-@cncf/otel--go-brightgreen.svg?logo=slack)](https://cloud-native.slack.com/archives/C01NPAXACKT)
7
8
9The Go [OpenTelemetry](https://opentelemetry.io/) implementation.
10
11## Project Status
12
13**Warning**: this project is currently in a pre-GA phase. Backwards
14incompatible changes may be introduced in subsequent minor version releases as
15we work to track the evolving OpenTelemetry specification and user feedback.
16
17Our progress towards a GA release candidate is tracked in [this project
18board](https://github.com/orgs/open-telemetry/projects/5). This release
19candidate will follow semantic versioning and will be released with a major
20version greater than zero.
21
22Progress and status specific to this repository is tracked in our local
23[project boards](https://github.com/open-telemetry/opentelemetry-go/projects)
24and
25[milestones](https://github.com/open-telemetry/opentelemetry-go/milestones).
26
27Project versioning information and stability guarantees can be found in the
28[versioning documentation](./VERSIONING.md).
29
30### Compatibility
31
32This project is tested on the following systems.
33
34| OS      | Go Version | Architecture |
35| ------- | ---------- | ------------ |
36| Ubuntu  | 1.15       | amd64        |
37| Ubuntu  | 1.14       | amd64        |
38| Ubuntu  | 1.15       | 386          |
39| Ubuntu  | 1.14       | 386          |
40| MacOS   | 1.15       | amd64        |
41| MacOS   | 1.14       | amd64        |
42| Windows | 1.15       | amd64        |
43| Windows | 1.14       | amd64        |
44| Windows | 1.15       | 386          |
45| Windows | 1.14       | 386          |
46
47While this project should work for other systems, no compatibility guarantees
48are made for those systems currently.
49
50## Getting Started
51
52You can find a getting started guide on [opentelemetry.io](https://opentelemetry.io/docs/go/getting-started/).
53
54OpenTelemetry's goal is to provide a single set of APIs to capture distributed
55traces and metrics from your application and send them to an observability
56platform. This project allows you to do just that for applications written in
57Go. There are two steps to this process: instrument your application, and
58configure an exporter.
59
60### Instrumentation
61
62To start capturing distributed traces and metric events from your application
63it first needs to be instrumented. The easiest way to do this is by using an
64instrumentation library for your code. Be sure to check out [the officially
65supported instrumentation
66libraries](https://github.com/open-telemetry/opentelemetry-go-contrib/tree/main/instrumentation).
67
68If you need to extend the telemetry an instrumentation library provides or want
69to build your own instrumentation for your application directly you will need
70to use the
71[go.opentelemetry.io/otel/api](https://pkg.go.dev/go.opentelemetry.io/otel/api)
72package. The included [examples](./example/) are a good way to see some
73practical uses of this process.
74
75### Export
76
77Now that your application is instrumented to collect telemetry, it needs an
78export pipeline to send that telemetry to an observability platform.
79
80You can find officially supported exporters [here](./exporters/) and in the
81companion [contrib
82repository](https://github.com/open-telemetry/opentelemetry-go-contrib/tree/main/exporters/metric).
83Additionally, there are many vendor specific or 3rd party exporters for
84OpenTelemetry. These exporters are broken down by
85[trace](https://pkg.go.dev/go.opentelemetry.io/otel/sdk/export/trace?tab=importedby)
86and
87[metric](https://pkg.go.dev/go.opentelemetry.io/otel/sdk/export/metric?tab=importedby)
88support.
89
90## Contributing
91
92See the [contributing documentation](CONTRIBUTING.md).
93