83c61f521f
This extends the trace API new traces, span and event benchmarks into sub benchmarks, so each option is tested individually rather than all of them together. ``` open-telemetry/opentelemetry-go/trace› git:(extend-trace-config-benchmarks) go test -v -bench=Config -run Benchmark goos: darwin goarch: arm64 pkg: go.opentelemetry.io/otel/trace BenchmarkNewTracerConfig BenchmarkNewTracerConfig/with_no_options BenchmarkNewTracerConfig/with_no_options-10 558777036 2.021 ns/op 0 B/op 0 allocs/op BenchmarkNewTracerConfig/with_an_instrumentation_version BenchmarkNewTracerConfig/with_an_instrumentation_version-10 91590230 13.09 ns/op 0 B/op 0 allocs/op BenchmarkNewTracerConfig/with_a_schema_url BenchmarkNewTracerConfig/with_a_schema_url-10 89374104 13.07 ns/op 0 B/op 0 allocs/op BenchmarkNewSpanStartConfig BenchmarkNewSpanStartConfig/with_no_options BenchmarkNewSpanStartConfig/with_no_options-10 288158400 4.187 ns/op 0 B/op 0 allocs/op BenchmarkNewSpanStartConfig/with_attributes BenchmarkNewSpanStartConfig/with_attributes-10 26750458 45.20 ns/op 64 B/op 1 allocs/op BenchmarkNewSpanStartConfig/with_attributes_set_multiple_times BenchmarkNewSpanStartConfig/with_attributes_set_multiple_times-10 11745048 102.4 ns/op 192 B/op 2 allocs/op BenchmarkNewSpanStartConfig/with_a_timestamp BenchmarkNewSpanStartConfig/with_a_timestamp-10 55898018 21.38 ns/op 0 B/op 0 allocs/op BenchmarkNewSpanStartConfig/with_links BenchmarkNewSpanStartConfig/with_links-10 19950262 60.21 ns/op 96 B/op 1 allocs/op BenchmarkNewSpanStartConfig/with_links_set_multiple_times BenchmarkNewSpanStartConfig/with_links_set_multiple_times-10 8129803 141.6 ns/op 272 B/op 2 allocs/op BenchmarkNewSpanStartConfig/with_new_root BenchmarkNewSpanStartConfig/with_new_root-10 43815543 27.46 ns/op 0 B/op 0 allocs/op BenchmarkNewSpanStartConfig/with_span_kind BenchmarkNewSpanStartConfig/with_span_kind-10 43276576 27.49 ns/op 0 B/op 0 allocs/op BenchmarkNewSpanEndConfig BenchmarkNewSpanEndConfig/with_no_options BenchmarkNewSpanEndConfig/with_no_options-10 286546008 4.155 ns/op 0 B/op 0 allocs/op BenchmarkNewSpanEndConfig/with_a_timestamp BenchmarkNewSpanEndConfig/with_a_timestamp-10 55678317 21.26 ns/op 0 B/op 0 allocs/op BenchmarkNewSpanEndConfig/with_stack_trace BenchmarkNewSpanEndConfig/with_stack_trace-10 57029929 20.80 ns/op 0 B/op 0 allocs/op BenchmarkNewEventConfig BenchmarkNewEventConfig/with_no_options BenchmarkNewEventConfig/with_no_options-10 25571608 46.08 ns/op 0 B/op 0 allocs/op BenchmarkNewEventConfig/with_attributes BenchmarkNewEventConfig/with_attributes-10 13868670 80.87 ns/op 64 B/op 1 allocs/op BenchmarkNewEventConfig/with_attributes_set_multiple_times BenchmarkNewEventConfig/with_attributes_set_multiple_times-10 8357275 143.2 ns/op 192 B/op 2 allocs/op BenchmarkNewEventConfig/with_a_timestamp BenchmarkNewEventConfig/with_a_timestamp-10 80229771 14.77 ns/op 0 B/op 0 allocs/op BenchmarkNewEventConfig/with_a_stacktrace BenchmarkNewEventConfig/with_a_stacktrace-10 21965215 54.93 ns/op 0 B/op 0 allocs/op PASS ok go.opentelemetry.io/otel/trace 24.862s ``` --------- Co-authored-by: Robert Pająk <pellared@hotmail.com>
OpenTelemetry-Go
OpenTelemetry-Go is the Go implementation of OpenTelemetry. It provides a set of APIs to directly measure performance and behavior of your software and send this data to observability platforms.
Project Status
| Signal | Status |
|---|---|
| Traces | Stable |
| Metrics | Stable |
| Logs | Beta1 |
Progress and status specific to this repository is tracked in our project boards and milestones.
Project versioning information and stability guarantees can be found in the versioning documentation.
Compatibility
OpenTelemetry-Go ensures compatibility with the current supported versions of the Go language:
Each major Go release is supported until there are two newer major releases. For example, Go 1.5 was supported until the Go 1.7 release, and Go 1.6 was supported until the Go 1.8 release.
For versions of Go that are no longer supported upstream, opentelemetry-go will stop ensuring compatibility with these versions in the following manner:
- A minor release of opentelemetry-go will be made to add support for the new supported release of Go.
- The following minor release of opentelemetry-go will remove compatibility testing for the oldest (now archived upstream) version of Go. This, and future, releases of opentelemetry-go may include features only supported by the currently supported versions of Go.
Currently, this project supports the following environments.
| OS | Go Version | Architecture |
|---|---|---|
| Ubuntu | 1.22 | amd64 |
| Ubuntu | 1.21 | amd64 |
| Ubuntu | 1.22 | 386 |
| Ubuntu | 1.21 | 386 |
| Linux | 1.22 | arm64 |
| Linux | 1.21 | arm64 |
| macOS 13 | 1.22 | amd64 |
| macOS 13 | 1.21 | amd64 |
| macOS | 1.22 | arm64 |
| macOS | 1.21 | arm64 |
| Windows | 1.22 | amd64 |
| Windows | 1.21 | amd64 |
| Windows | 1.22 | 386 |
| Windows | 1.21 | 386 |
While this project should work for other systems, no compatibility guarantees are made for those systems currently.
Getting Started
You can find a getting started guide on opentelemetry.io.
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 otel 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.
All officially supported exporters for the OpenTelemetry project are contained in the exporters directory.
| Exporter | Logs | Metrics | Traces |
|---|---|---|---|
| OTLP | ✓ | ✓ | ✓ |
| Prometheus | ✓ | ||
| stdout | ✓ | ✓ | ✓ |
| Zipkin | ✓ |
Contributing
See the contributing documentation.