1
0
mirror of https://github.com/open-telemetry/opentelemetry-go.git synced 2025-01-05 22:54:18 +02:00
OpenTelemetry Go API and SDK https://opentelemetry.io/
Go to file
Tyler Yahn f1dad21e47
Move propagators out of API and into their own package (#1118)
* Add new propagators package

* Move B3 propagator to propagators

Update all `api/trace` dependencies in the propagator.

Export the isDeferred and isDebug methods of the SpanContext. These are
needed by the B3 propagator to track trace state.

* Move W3C trace context propagator to propagators

* Update package docs with supported encodings

* Move unified propagators code to own file

* Update b3 exported documentation

* Update trace_context exported documentation

* Add code examples for B3 propagator

* Add TraceContext example code

* Remove internal package

Move common testing declarations to the propagators_test.go file.

* Add changes to Changelog

* Add test to check default propagators
2020-09-08 19:07:59 -04:00
.circleci Export coverage report to codecov (#995) 2020-08-24 09:43:29 -07:00
.github Update dependabot config (#1100) 2020-08-26 16:34:41 -07:00
api Move propagators out of API and into their own package (#1118) 2020-09-08 19:07:59 -04:00
bridge/opentracing Unify API Span Start/End Options (#1108) 2020-09-03 07:34:36 -07:00
codes Remove google.golang.org/grpc/codes dependency from API by adding an equivalent codes package (#1046) 2020-08-10 09:17:09 -07:00
example Bump google.golang.org/api from 0.30.0 to 0.31.0 in /exporters/trace/jaeger (#1124) 2020-09-08 09:03:17 -07:00
exporters Add a test for jaeger udp client (#1137) 2020-09-08 18:38:17 -04:00
internal Make trace testhelpers public (#1111) 2020-09-01 08:16:05 -07:00
label Unify api/label and api/kv in new label package (#1060) 2020-08-17 20:25:03 -07:00
propagators Move propagators out of API and into their own package (#1118) 2020-09-08 19:07:59 -04:00
sdk Unify API Span Start/End Options (#1108) 2020-09-03 07:34:36 -07:00
semconv Unify api/label and api/kv in new label package (#1060) 2020-08-17 20:25:03 -07:00
tools Bump github.com/itchyny/gojq from 0.11.0 to 0.11.1 in /tools (#1081) 2020-08-24 09:54:13 -07:00
.gitignore Import open-telemetry/opentelemetry-proto submodule and generate protobuf bindings locally (#942) 2020-07-16 13:59:14 -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
CHANGELOG.md Move propagators out of API and into their own package (#1118) 2020-09-08 19:07:59 -04:00
CODEOWNERS Add @XSAM as project approver (#1110) 2020-08-28 17:05:48 -04:00
CONTRIBUTING.md Add @XSAM as project approver (#1110) 2020-08-28 17:05:48 -04:00
doc.go Alias api/global types, functions to root 2020-05-03 16:01:15 +08:00
error_handler.go Remove the oterror package (#1026) 2020-08-05 10:31:42 -07:00
get_main_pkgs.sh Update License header for all source files (#586) 2020-03-23 22:41:10 -07:00
go.mod Bump github.com/google/go-cmp from 0.5.1 to 0.5.2 (#1093) 2020-08-26 11:39:41 -07:00
go.sum Bump github.com/google/go-cmp from 0.5.1 to 0.5.2 (#1093) 2020-08-26 11:39:41 -07:00
LICENSE Initial commit 2019-05-16 12:05:27 -07:00
Makefile Stop find complaining due to missing directory starting point (#1116) 2020-09-02 07:40:03 -07:00
Makefile.proto Move OTLP to the OTLP exporter (#1050) 2020-08-10 19:55:52 -07:00
otel.go rm api/global alias functions 2020-05-07 00:41:11 +08:00
pre_release.sh fix pre_release.sh to update version in sdk/opentelemetry.go (#607) 2020-03-31 12:02:56 -07:00
README.md Update README.md (#1106) 2020-08-27 12:14:37 -07:00
RELEASING.md Add reminder to release contrib after this repo (#1030) 2020-08-05 09:01:00 -07:00
tag.sh Backport tag script from contrib repo (#934) 2020-07-13 16:09:59 -04:00
verify_examples.sh Clean up tools (#762) 2020-05-26 11:35:34 -07:00

OpenTelemetry-Go

Circle CI Docs Go Report Card Gitter

The Go OpenTelemetry implementation.

Getting Started

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.

Project Status

Project boards and milestones can be found at the respective links. We try to keep these accurate and should be the best place to go for answers on project status.

Contributing

See the contributing documentation.