OpenTelemetry Go API and SDK
Go to file
JBD 2621bd4847
Convert XConfigure into constructor for metrics (#1175)
* Convert XConfigure into constructor for metrics

A follow up of #1155.

* Add to CHANGELOG

Co-authored-by: Tyler Yahn <MrAlias@users.noreply.github.com>
2020-09-15 07:49:18 -07:00
.circleci Export coverage report to codecov (#995) 2020-08-24 09:43:29 -07:00
.github Allow up to 0.5% coverage change before failing build (#1162) 2020-09-10 12:49:08 -07:00
api Convert XConfigure into constructor for metrics (#1175) 2020-09-15 07:49:18 -07:00
bridge/opentracing Convert XConfigure into constructors (#1155) 2020-09-10 15:15:17 -04:00
codes Add the missing vanity import path directive (#1157) 2020-09-10 06:29:21 -04:00
example Minor change: ParentSampler -> ParentBased in Zipkin example description (#1171) 2020-09-13 14:45:46 -04:00
exporters Recommend use of initializers for config structs (#1163) 2020-09-11 14:14:25 -07:00
internal Bump github.com/golangci/golangci-lint from 1.30.0 to 1.31.0 in /internal/tools (#1152) 2020-09-09 12:49:55 -04:00
label Unify `api/label` and `api/kv` in new `label` package (#1060) 2020-08-17 20:25:03 -07:00
propagators Unexport NoopXXX trace types (#1134) 2020-09-08 20:43:35 -04:00
sdk Don't consider unset env var to be an error during resource detection (#1170) 2020-09-14 12:08:05 -04:00
semconv Add more semantic conventions for k8s as resource attributes (#1167) 2020-09-11 14:46:24 -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 Convert XConfigure into constructor for metrics (#1175) 2020-09-15 07:49:18 -07:00
CODEOWNERS Add @XSAM as project approver (#1110) 2020-08-28 17:05:48 -04:00
CONTRIBUTING.md Recommend use of initializers for config structs (#1163) 2020-09-11 14:14:25 -07:00
LICENSE Initial commit 2019-05-16 12:05:27 -07:00
Makefile Move tools package under internal (#1141) 2020-09-09 09:14:03 -07:00
Makefile.proto Move OTLP to the OTLP exporter (#1050) 2020-08-10 19:55:52 -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
doc.go Merge otel into one file and add package doc (#1176) 2020-09-14 19:35:21 -04: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
otel.go Merge otel into one file and add package doc (#1176) 2020-09-14 19:35:21 -04:00
pre_release.sh fix pre_release.sh to update version in sdk/opentelemetry.go (#607) 2020-03-31 12:02:56 -07:00
tag.sh Move tools package under internal (#1141) 2020-09-09 09:14:03 -07:00
verify_examples.sh Clean up tools (#762) 2020-05-26 11:35:34 -07:00

README.md

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.