OpenTelemetry Go API and SDK
Go to file
Sam Xie 230bdd10f0
Add SpanContextFromContext() (#1255)
* SpanFromContext returns nil if span not exists

* Add tests for SpanContextFromContext

* Update CHANGELOG

* Update trace.go

Co-authored-by: Tyler Yahn <MrAlias@users.noreply.github.com>

* SpanFromContext() continue to return a noopSpan{}

Co-authored-by: Tyler Yahn <MrAlias@users.noreply.github.com>
2020-10-21 17:30:28 -04: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
bridge/opentracing Add SpanContextFromContext() (#1255) 2020-10-21 17:30:28 -04:00
codes Update codes to match specification (#1214) 2020-10-05 11:36:03 -07:00
example Move the otel/api/global package to otel/global (#1262) 2020-10-17 10:03:48 -07:00
exporters Move the otel/api/global package to otel/global (#1262) 2020-10-17 10:03:48 -07:00
global Move the otel/api/global package to otel/global (#1262) 2020-10-17 10:03:48 -07:00
internal Add SpanContextFromContext() (#1255) 2020-10-21 17:30:28 -04:00
label Fix lint issues in the label package (#1244) 2020-10-12 08:39:12 -07:00
oteltest Add SpanContextFromContext() (#1255) 2020-10-21 17:30:28 -04:00
propagators Add SpanContextFromContext() (#1255) 2020-10-21 17:30:28 -04:00
registry Move metric api package into `otel` (#1252) 2020-10-17 09:48:21 -07:00
sdk Move the otel/api/global package to otel/global (#1262) 2020-10-17 10:03:48 -07:00
semconv Update semconv comments (#1249) 2020-10-13 12:35:10 -07:00
unit Move api/unit to top level (#1185) 2020-09-20 13:54:21 -04: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 Add SpanContextFromContext() (#1255) 2020-10-21 17:30:28 -04:00
CODEOWNERS Add @XSAM as project approver (#1110) 2020-08-28 17:05:48 -04:00
CONTRIBUTING.md Ensure exported interfaces have named method parameters (#1172) 2020-09-16 09:09:45 -07:00
LICENSE Initial commit 2019-05-16 12:05:27 -07:00
Makefile Test benchmarks in precommit (#1207) 2020-09-25 13:27:03 -07:00
Makefile.proto Move OTLP to the OTLP exporter (#1050) 2020-08-10 19:55:52 -07:00
README.md Update README with Org GA project board (#1253) 2020-10-13 15:02:38 -07:00
RELEASING.md Add reminder to release contrib after this repo (#1030) 2020-08-05 09:01:00 -07:00
alignment_test.go Move metric api package into `otel` (#1252) 2020-10-17 09:48:21 -07:00
baggage.go Add Baggage API and move Baggage propagator (#1217) 2020-10-05 11:25:09 -04:00
baggage_test.go Add Baggage API and move Baggage propagator (#1217) 2020-10-05 11:25:09 -04:00
config.go Move metric api package into `otel` (#1252) 2020-10-17 09:48:21 -07:00
config_test.go Move trace api package into `otel` (#1229) 2020-10-08 19:58:56 -07:00
doc.go Move the otel/api/global package to otel/global (#1262) 2020-10-17 10:03:48 -07:00
error_handler.go Move metric api package into `otel` (#1252) 2020-10-17 09:48:21 -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
instrumentkind_string.go Move metric api package into `otel` (#1252) 2020-10-17 09:48:21 -07:00
metric.go Move metric api package into `otel` (#1252) 2020-10-17 09:48:21 -07:00
metric_instrument.go Move metric api package into `otel` (#1252) 2020-10-17 09:48:21 -07:00
metric_noop.go Move metric api package into `otel` (#1252) 2020-10-17 09:48:21 -07:00
metric_sdkapi.go Move metric api package into `otel` (#1252) 2020-10-17 09:48:21 -07:00
metric_test.go Move metric api package into `otel` (#1252) 2020-10-17 09:48:21 -07:00
number.go Move metric api package into `otel` (#1252) 2020-10-17 09:48:21 -07:00
number_test.go Move metric api package into `otel` (#1252) 2020-10-17 09:48:21 -07:00
numberkind_string.go Move metric api package into `otel` (#1252) 2020-10-17 09:48:21 -07:00
pre_release.sh fix pre_release.sh to update version in sdk/opentelemetry.go (#607) 2020-03-31 12:02:56 -07:00
propagation.go Update propagation to conform with OpenTelemetry specification (#1212) 2020-10-02 12:27:16 -07:00
propagation_test.go Update propagation to conform with OpenTelemetry specification (#1212) 2020-10-02 12:27:16 -07:00
tag.sh Move tools package under internal (#1141) 2020-09-09 09:14:03 -07:00
trace.go Add SpanContextFromContext() (#1255) 2020-10-21 17:30:28 -04:00
trace_noop.go Update Span API event methods (#1254) 2020-10-16 08:09:27 -07:00
trace_noop_test.go Move trace api package into `otel` (#1229) 2020-10-08 19:58:56 -07:00
trace_test.go Add SpanContextFromContext() (#1255) 2020-10-21 17:30:28 -04: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

This project is currently in a pre-GA phase. Our progress towards a GA release candidate is tracked in this project board.

Progress and status specific to this repository is tracked in our local 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.