go/opentelemetry-go
go/opentelemetry-go
1
0
Fork 0
mirror of https://github.com/open-telemetry/opentelemetry-go.git synced 2024-12-04 09:43:23 +02:00
Code Issues Releases Activity
06a0be789a
opentelemetry-go/README.md
Tyler Yahn 06a0be789a
Update README.md (#1106) 
* Update README.md

Replace `Installation` and `Compatible Libraries` sections with a more
comprehensive `Getting Started` section to address the two actions most
users will want to know about: instrumenting and exporting.

Remove the code example.

Add links to project boards and milestones to address project status
questions.

* Fix spelling error

* Apply suggestions from code review

Co-authored-by: ET <evantorrie@users.noreply.github.com>

Co-authored-by: ET <evantorrie@users.noreply.github.com>
2020-08-27 12:14:37 -07:00

2.7 KiB
Raw Blame History

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.