1
0
mirror of https://github.com/open-telemetry/opentelemetry-go.git synced 2024-12-12 10:04:29 +02:00
OpenTelemetry Go API and SDK https://opentelemetry.io/
Go to file
2023-04-27 11:15:50 -07:00
.github [chore] dependabot updates Sun Apr 23 14:49:00 UTC 2023 (#4031) 2023-04-23 07:59:24 -07:00
attribute Guard zero value Set methods (#3957) 2023-04-04 08:06:10 -07:00
baggage Fix baggage.NewMember to decode the accepted value (#3226) 2022-10-18 12:45:04 -07:00
bridge Added methods for SpanID and TraceID on bridgeSpanContext (#3966) 2023-04-25 10:11:03 -07:00
codes Clarify nature of Codes values w.r.t. OTLP (#3386) 2022-10-28 15:38:32 -07:00
example [chore] dependabot updates Sun Apr 23 14:49:00 UTC 2023 (#4031) 2023-04-23 07:59:24 -07:00
exporters Fix broken link (#4034) 2023-04-27 11:15:50 -07:00
internal dependabot updates Sun Apr 16 14:23:12 UTC 2023 (#4014) 2023-04-16 07:35:37 -07:00
metric Remove the sync inst from async example (#4019) 2023-04-20 16:14:39 -07:00
propagation docs(typos): Run codespell to fix typos (#3980) 2023-04-11 17:28:13 -07:00
schema dependabot updates Sun Apr 16 14:23:12 UTC 2023 (#4014) 2023-04-16 07:35:37 -07:00
sdk Add options to measurement methods (#3971) 2023-04-18 07:16:06 -07:00
semconv Document httpconv and netconv packages as trace providing only trace semantic convention (#3823) 2023-03-02 11:42:46 -08:00
trace Move global metric back to otel/metric/global for minor release (#3986) 2023-04-13 07:39:39 -07:00
website_docs Typo in getting-started.md (#3931) 2023-03-24 09:32:31 -07:00
.gitattributes Create .gitattributes (#1920) 2021-05-13 11:23:29 -04:00
.gitignore Add go.work.sum to .gitignore file (#3975) 2023-04-08 08:10:29 -07:00
.gitmodules
.golangci.yml Add embedded private method interfaces in metric API (#3916) 2023-04-03 07:33:19 -07:00
.lycheeignore Run website formatter over website_docs (#3762) 2023-02-24 07:35:24 -06:00
.markdownlint.yaml Fix existing markdown lint issues (#1866) 2021-04-30 10:51:19 -07:00
CHANGELOG.md Added methods for SpanID and TraceID on bridgeSpanContext (#3966) 2023-04-25 10:11:03 -07:00
CODEOWNERS move jmacd to emeritus (#4024) 2023-04-20 10:04:27 -07:00
CONTRIBUTING.md move jmacd to emeritus (#4024) 2023-04-20 10:04:27 -07:00
doc.go Prerelease v1.0.0 (#2250) 2021-09-20 13:02:46 -07:00
error_handler.go Add ErrorHandlerFunc to simplify creating ErrorHandlers (#2149) 2021-08-03 15:15:54 -07:00
get_main_pkgs.sh
go.mod Move global metric back to otel/metric/global for minor release (#3986) 2023-04-13 07:39:39 -07:00
go.sum dependabot updates Sun Apr 2 15:32:08 UTC 2023 (#3963) 2023-04-02 12:10:19 -04:00
handler_test.go Support a global MeterProvider in go.opentelemetry.io/otel (#3818) 2023-03-01 11:16:03 -08:00
handler.go Support a global MeterProvider in go.opentelemetry.io/otel (#3818) 2023-03-01 11:16:03 -08:00
internal_logging_test.go Fixes race, moved into global 2021-11-24 20:06:39 +00:00
internal_logging.go Fixes race, moved into global 2021-11-24 20:06:39 +00:00
LICENSE
Makefile Update go directive value in go.mod files to 1.19 (#3850) 2023-03-15 09:52:04 -07:00
propagation.go
README.md Update metrics project status to beta (#3843) 2023-03-08 07:42:38 -08:00
RELEASING.md Add v1.13 semantic conventions (#3499) 2023-01-05 14:58:42 -08:00
trace_test.go Remove unnecessary internal package for noop instances (#2867) 2022-04-28 12:11:17 -07:00
trace.go Update golangci-lint to v1.48.0 (#3105) 2022-08-24 21:42:28 -05:00
verify_examples.sh
version_test.go
version.go Release v1.15.0-rc.2/v0.38.0-rc.2 (#3923) 2023-03-23 07:47:46 -07:00
VERSIONING.md Fix RC tags in docs (#2239) 2021-09-14 08:15:02 -07:00
versions.yaml Move the metric API back to experimental-metrics (#3987) 2023-04-13 07:14:20 -07:00

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 Project
Traces Stable N/A
Metrics Beta N/A
Logs Frozen [1] N/A
  • [1]: 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

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.20 amd64
Ubuntu 1.19 amd64
Ubuntu 1.20 386
Ubuntu 1.19 386
MacOS 1.20 amd64
MacOS 1.19 amd64
Windows 1.20 amd64
Windows 1.19 amd64
Windows 1.20 386
Windows 1.19 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
Jaeger
OTLP
Prometheus
stdout
Zipkin

Contributing

See the contributing documentation.