ec300b28ad
* Update Span API event methods Remove the context argument from the event methods. It is unused and can be added back in as a passed option if needed in the future. Update AddEvent to accept a required name and a set of options. These options are the new EventOption type that can be used to configure a SpanConfig Timestamp and Attributes. Remove the AddEventWithTimestamp method as it is redundant to calling AddEvent with a WithTimestamp option. Update RecordError to also accept the EventOptions. * Add changes to CHANGELOG * Add LifeCycleOption Use the LifeCycleOption to encapsulate the options passed to a span for life cycle events. |
||
---|---|---|
.circleci | ||
.github | ||
api | ||
bridge/opentracing | ||
codes | ||
example | ||
exporters | ||
internal | ||
label | ||
oteltest | ||
propagators | ||
sdk | ||
semconv | ||
unit | ||
.gitignore | ||
.gitmodules | ||
.golangci.yml | ||
baggage_test.go | ||
baggage.go | ||
CHANGELOG.md | ||
CODEOWNERS | ||
config_test.go | ||
config.go | ||
CONTRIBUTING.md | ||
doc.go | ||
get_main_pkgs.sh | ||
go.mod | ||
go.sum | ||
LICENSE | ||
Makefile | ||
Makefile.proto | ||
otel.go | ||
pre_release.sh | ||
propagation_test.go | ||
propagation.go | ||
README.md | ||
RELEASING.md | ||
tag.sh | ||
trace_noop_test.go | ||
trace_noop.go | ||
trace_test.go | ||
trace.go | ||
verify_examples.sh |
OpenTelemetry-Go
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.