mirror of
https://github.com/open-telemetry/opentelemetry-go.git
synced 2024-12-12 10:04:29 +02:00
7918070617
The code example was rendering oddly in github.com because the first line had 4 spaces instead of tabs like the rest of the example. Fix this.
117 lines
4.4 KiB
Markdown
117 lines
4.4 KiB
Markdown
# OpenTelemetry-Go
|
|
|
|
[](https://circleci.com/gh/open-telemetry/opentelemetry-go)
|
|
[](https://pkg.go.dev/go.opentelemetry.io/otel)
|
|
[](https://goreportcard.com/report/go.opentelemetry.io/otel)
|
|
[](https://gitter.im/open-telemetry/opentelemetry-go?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
|
|
|
|
The Go [OpenTelemetry](https://opentelemetry.io/) client.
|
|
|
|
## Installation
|
|
|
|
This repository includes multiple packages. The `api`
|
|
package contains core data types, interfaces and no-op implementations that comprise the OpenTelemetry API following
|
|
[the
|
|
specification](https://github.com/open-telemetry/opentelemetry-specification).
|
|
The `sdk` package is the reference implementation of the API.
|
|
|
|
Libraries that produce telemetry data should only depend on `api`
|
|
and defer the choice of the SDK to the application developer. Applications may
|
|
depend on `sdk` or another package that implements the API.
|
|
|
|
All packages are published to [go.opentelemetry.io/otel](https://pkg.go.dev/go.opentelemetry.io/otel) and is the preferred location to import from.
|
|
|
|
Additional resources:
|
|
|
|
- [Developing using Go Modules](https://blog.golang.org/using-go-modules)
|
|
- [Adding dependencies and installing them](https://golang.org/cmd/go/#hdr-Add_dependencies_to_current_module_and_install_them)
|
|
|
|
## Quick Start
|
|
|
|
Below is a brief example of importing OpenTelemetry, initializing a tracer and creating some simple spans.
|
|
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
"context"
|
|
"log"
|
|
|
|
"go.opentelemetry.io/otel/api/global"
|
|
"go.opentelemetry.io/otel/exporters/stdout"
|
|
sdktrace "go.opentelemetry.io/otel/sdk/trace"
|
|
)
|
|
|
|
func main() {
|
|
pusher, err := stdout.InstallNewPipeline(nil, nil)
|
|
if err != nil {
|
|
log.Fatal(err)
|
|
}
|
|
defer pusher.Stop()
|
|
|
|
tracer := global.Tracer("ex.com/basic")
|
|
|
|
tracer.WithSpan(context.Background(), "foo",
|
|
func(ctx context.Context) error {
|
|
tracer.WithSpan(ctx, "bar",
|
|
func(ctx context.Context) error {
|
|
tracer.WithSpan(ctx, "baz",
|
|
func(ctx context.Context) error {
|
|
return nil
|
|
},
|
|
)
|
|
return nil
|
|
},
|
|
)
|
|
return nil
|
|
},
|
|
)
|
|
}
|
|
```
|
|
|
|
See the [API
|
|
documentation](https://pkg.go.dev/go.opentelemetry.io/otel) for more
|
|
detail, and the
|
|
[opentelemetry-example-app](./example/README.md)
|
|
for a complete example.
|
|
|
|
## Compatible Exporters
|
|
|
|
See the Go packages depending upon
|
|
[sdk/export/trace](https://pkg.go.dev/go.opentelemetry.io/otel/sdk/export/trace?tab=importedby)
|
|
and [sdk/export/metric](https://pkg.go.dev/go.opentelemetry.io/otel/sdk/export/metric?tab=importedby)
|
|
for a list of all exporters compatible with OpenTelemetry's Go SDK.
|
|
|
|
## Compatible Libraries
|
|
|
|
See the
|
|
[opentelemetry-go-contrib](https://github.com/open-telemetry/opentelemetry-go-contrib)
|
|
repo for packages that facilitates instrumenting other useful Go libraries
|
|
with opentelemetry-go for distributed tracing and monitoring.
|
|
|
|
## Contributing
|
|
|
|
See the [contributing file](CONTRIBUTING.md).
|
|
|
|
## Release Schedule
|
|
|
|
OpenTelemetry Go is under active development. Below is the release schedule
|
|
for the Go library. The first version of the release isn't guaranteed to conform
|
|
to a specific version of the specification, and future releases will not
|
|
attempt to maintain backward compatibility with the alpha release.
|
|
|
|
| Component | Version | Release Date |
|
|
| -------------------------------- | ------------ | ---------------- |
|
|
| Tracing API | Alpha v0.1.0 | November 05 2019 |
|
|
| Tracing SDK | Alpha v0.1.0 | November 05 2019 |
|
|
| Jaeger Trace Exporter | Alpha v0.1.0 | November 05 2019 |
|
|
| Trace Context Propagation | Alpha v0.1.0 | November 05 2019 |
|
|
| OpenTracing Bridge | Alpha v0.1.0 | November 05 2019 |
|
|
| Metrics API | Alpha v0.2.0 | December 03 2019 |
|
|
| Metrics SDK | Alpha v0.2.0 | December 03 2019 |
|
|
| Prometheus Metrics Exporter | Alpha v0.2.0 | December 03 2019 |
|
|
| Context Prop. rename/Baggage | Beta v0.4.0 | March 30 2020 |
|
|
| OpenTelemetry Collector Exporter | Beta v0.4.0 | March 30 2020 |
|
|
| Zipkin Trace Exporter | Beta v0.4.0 | March 30 2020 |
|
|
| OTLP Trace & Metrics Exporter | Beta v0.4.0 | March 30 2020 |
|