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
Tyler Yahn 4bf6150fa9
Add baggage implementation based on the W3C and OpenTelemetry specification (#1967)
* Rename baggage context file

* Initial baggage implementation

* Initial tests

* More tests

* Update baggage context functionality

* Add New method to baggage pkg

* Update namedtracer example

* URL encode baggage values

* Refactor and use internal baggage pkg

* Update OpenTracing bridge

* Update baggage propagator

* Fix lint and test errors

* Add changes to changelog

* Apply suggestions from code review

* Rename testcase field per suggestion

* Update test to verify last-one-wins semantics

* Explicitly seed random numbers with static seed in tests

* Parse Member key/value with string split

* Add test for member parse with equal signs in value

* Trim whitespaces for member key/value
2021-06-08 08:06:37 -07:00
.github add otlp trace http exporter (#1963) 2021-06-07 07:57:58 -07:00
attribute remove Set.Encoded(Encoder) enconding cache (#1855) 2021-04-29 11:28:04 -07:00
baggage Add baggage implementation based on the W3C and OpenTelemetry specification (#1967) 2021-06-08 08:06:37 -07:00
bridge Add baggage implementation based on the W3C and OpenTelemetry specification (#1967) 2021-06-08 08:06:37 -07:00
codes Update default branch name (#1505) 2021-02-04 11:13:25 -08:00
example Add baggage implementation based on the W3C and OpenTelemetry specification (#1967) 2021-06-08 08:06:37 -07:00
exporters Bump github.com/cenkalti/backoff/v4 from 4.1.0 to 4.1.1 in /exporters/otlp/otlptrace (#1972) 2021-06-07 09:28:36 -07:00
internal Add baggage implementation based on the W3C and OpenTelemetry specification (#1967) 2021-06-08 08:06:37 -07:00
metric add otlp trace http exporter (#1963) 2021-06-07 07:57:58 -07:00
oteltest add otlp trace http exporter (#1963) 2021-06-07 07:57:58 -07:00
propagation Add baggage implementation based on the W3C and OpenTelemetry specification (#1967) 2021-06-08 08:06:37 -07:00
sdk add otlp trace http exporter (#1963) 2021-06-07 07:57:58 -07:00
semconv Do not include authentication information in the http.url attribute (#1919) 2021-05-13 13:05:44 -04:00
trace add otlp trace http exporter (#1963) 2021-06-07 07:57:58 -07:00
website_docs Fix typo in doc (#1949) 2021-05-25 15:20:45 -04:00
.gitattributes Create .gitattributes (#1920) 2021-05-13 11:23:29 -04:00
.gitignore Add Passthrough example (#1912) 2021-05-18 14:03:10 -07:00
.gitmodules Move OTLP to the OTLP exporter (#1050) 2020-08-10 19:55:52 -07:00
.golangci.yml Remove nolint and update misspell to ignore cancelled 2020-05-29 11:11:19 -07:00
.markdown-link.json Add markdown link check configuration and action (#1869) 2021-05-02 07:15:42 -07:00
.markdownlint.yaml Fix existing markdown lint issues (#1866) 2021-04-30 10:51:19 -07:00
CHANGELOG.md Add baggage implementation based on the W3C and OpenTelemetry specification (#1967) 2021-06-08 08:06:37 -07:00
CODEOWNERS Add @MadVikingGod as a project Approver (#1923) 2021-05-17 08:41:24 -07:00
CONTRIBUTING.md Update API configs. (#1921) 2021-05-27 07:53:56 -07:00
doc.go Mention the getting started guide (#1406) 2020-12-17 10:00:34 -08:00
error_handler.go chore: adds vanity import for files that don't have it. (#1297) 2020-11-04 09:10:58 -08:00
get_main_pkgs.sh Build scripts: Replace mapfile with read loop for old bash versions (#1425) 2020-12-29 10:43:05 -08:00
go.mod add otlp trace http exporter (#1963) 2021-06-07 07:57:58 -07:00
go.sum Bump github.com/google/go-cmp from 0.5.5 to 0.5.6 (#1954) 2021-06-01 11:53:02 -07:00
handler_test.go Fix flaky global ErrorHandler delegation test (#1829) 2021-04-21 15:17:02 -04:00
handler.go Move Version function and code from global to toplevel (#1330) 2020-11-16 09:30:54 -08:00
LICENSE Initial commit 2019-05-16 12:05:27 -07:00
Makefile OTLP trace gRPC exporter (#1922) 2021-05-27 13:47:01 -07:00
pre_release.sh Update default branch name (#1505) 2021-02-04 11:13:25 -08:00
propagation.go Fix small typo (#1409) 2020-12-17 12:07:09 -08:00
README.md Add codecov badge (#1940) 2021-05-24 09:27:43 -07:00
RELEASING.md Generate semantic conventions according to specification latest tagged version (#1933) 2021-06-01 16:15:32 -04:00
tag.sh Move tools package under internal (#1141) 2020-09-09 09:14:03 -07:00
trace_test.go Move Version function and code from global to toplevel (#1330) 2020-11-16 09:30:54 -08:00
trace.go Add tracer option argument to global Tracer function (#1902) 2021-05-13 14:43:19 -07:00
verify_examples.sh Clean up tools (#762) 2020-05-26 11:35:34 -07:00
version_test.go Release v0.20.0 (#1837) 2021-04-23 11:19:07 -07:00
version.go Release v0.20.0 (#1837) 2021-04-23 11:19:07 -07:00
VERSIONING.md Add Versioning Documentation (#1388) 2020-12-29 10:34:46 -08: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

Warning: this project is currently in a pre-GA phase. Backwards incompatible changes may be introduced in subsequent minor version releases as we work to track the evolving OpenTelemetry specification and user feedback.

Our progress towards a GA release candidate is tracked in this project board. This release candidate will follow semantic versioning and will be released with a major version greater than zero.

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.

Signal Status
Traces Stable release is primary focus
Metrics Development paused [1]
Logs Frozen [2]
  • [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.

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.

You can find officially supported exporters here and in the companion contrib repository. Additionally, there are many vendor specific or 3rd party exporters for OpenTelemetry. These exporters are broken down by trace and metric support.

Contributing

See the contributing documentation.