1
0
mirror of https://github.com/open-telemetry/opentelemetry-go.git synced 2025-01-12 02:28:07 +02:00
OpenTelemetry Go API and SDK https://opentelemetry.io/
Go to file
Injun Song d75e268053
Avoid overriding configuration of tracer provider (#1633)
* sdk/trace: add missing options to tracer provider

This change adds `WithDefaultSampler` and `WithSpanLimits` to the tracer
provider and removed `WithConfig` from it.

Before this change, `WithConfig` is the only way to set sampler or
limits of a span. However, it is prone to misuse, since `WithConfig` can
override tracing configurations that are configured by `WithResource` or
`WithIDGenerator`.  Thus to fix this, it adds new functional options -
`WithDefaultSampler` and `WithSpanLimits` and removes `WithConfig`.

Resolves #1631.

* Update sdk/trace/provider.go

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

* Update sdk/trace/provider.go

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

* rebase and remove WithConfig

Co-authored-by: Tyler Yahn <MrAlias@users.noreply.github.com>
2021-03-08 13:43:11 -08:00
.github Add compatibility tests to CI (#1567) 2021-03-01 08:38:23 -08:00
attribute Rename otel/label -> otel/attribute (#1541) 2021-02-18 12:59:37 -05:00
baggage Rename otel/label -> otel/attribute (#1541) 2021-02-18 12:59:37 -05:00
bridge Bump github.com/google/go-cmp from 0.5.4 to 0.5.5 (#1667) 2021-03-08 12:15:49 -08:00
codes Update default branch name (#1505) 2021-02-04 11:13:25 -08:00
example Avoid overriding configuration of tracer provider (#1633) 2021-03-08 13:43:11 -08:00
exporters Avoid overriding configuration of tracer provider (#1633) 2021-03-08 13:43:11 -08:00
internal Bump github.com/golangci/golangci-lint in /internal/tools (#1671) 2021-03-08 12:26:54 -08:00
metric Bump github.com/google/go-cmp from 0.5.4 to 0.5.5 (#1667) 2021-03-08 12:15:49 -08:00
oteltest Bump github.com/google/go-cmp from 0.5.4 to 0.5.5 (#1667) 2021-03-08 12:15:49 -08:00
propagation Rename otel/label -> otel/attribute (#1541) 2021-02-18 12:59:37 -05:00
sdk Avoid overriding configuration of tracer provider (#1633) 2021-03-08 13:43:11 -08:00
semconv add code attributes to semconv package (#1558) 2021-02-22 13:42:52 -08:00
trace Bump github.com/google/go-cmp from 0.5.4 to 0.5.5 (#1667) 2021-03-08 12:15:49 -08:00
unit chore: adds vanity import for files that don't have it. (#1297) 2020-11-04 09:10:58 -08:00
.gitignore gitignore: remove unused example path (#1474) 2021-01-19 12:13:49 -08: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 Avoid overriding configuration of tracer provider (#1633) 2021-03-08 13:43:11 -08:00
CODEOWNERS Update default branch name (#1505) 2021-02-04 11:13:25 -08:00
CONTRIBUTING.md Add docs on when reviews should be cleared (#1556) 2021-03-05 14:25:58 -08:00
doc.go Mention the getting started guide (#1406) 2020-12-17 10:00:34 -08:00
error_handler.go chore: adds vanity import for files that don't have it. (#1297) 2020-11-04 09:10:58 -08:00
get_main_pkgs.sh Build scripts: Replace mapfile with read loop for old bash versions (#1425) 2020-12-29 10:43:05 -08:00
go.mod Bump github.com/google/go-cmp from 0.5.4 to 0.5.5 (#1667) 2021-03-08 12:15:49 -08:00
go.sum Bump github.com/google/go-cmp from 0.5.4 to 0.5.5 (#1667) 2021-03-08 12:15:49 -08:00
handler_test.go Move Version function and code from global to toplevel (#1330) 2020-11-16 09:30:54 -08:00
handler.go Move Version function and code from global to toplevel (#1330) 2020-11-16 09:30:54 -08:00
LICENSE Initial commit 2019-05-16 12:05:27 -07:00
Makefile Fix the examples target info messaging (#1676) 2021-03-08 11:59:41 -08:00
Makefile.protos Rename Makefile.proto to avoid interpretation as proto file (#1468) 2021-01-15 07:38:29 -08:00
pre_release.sh Update default branch name (#1505) 2021-02-04 11:13:25 -08:00
propagation.go Fix small typo (#1409) 2020-12-17 12:07:09 -08:00
README.md Add compatibility tests to CI (#1567) 2021-03-01 08:38:23 -08:00
RELEASING.md Update default branch name (#1505) 2021-02-04 11:13:25 -08:00
tag.sh Move tools package under internal (#1141) 2020-09-09 09:14:03 -07:00
trace_test.go Move Version function and code from global to toplevel (#1330) 2020-11-16 09:30:54 -08:00
trace.go nit: Fix comment to be up-to-date (#1510) 2021-02-04 10:36:34 -08:00
verify_examples.sh Clean up tools (#762) 2020-05-26 11:35:34 -07:00
version.go Pre release v0.18.0 (#1635) 2021-03-03 14:40:00 -05:00
VERSIONING.md Add Versioning Documentation (#1388) 2020-12-29 10:34:46 -08:00

OpenTelemetry-Go

CI PkgGoDev Go Report Card Slack

The Go OpenTelemetry implementation.

Project Status

Warning: this project is currently in a pre-GA phase. Backwards incompatible changes may be introduced in subsequent minor version releases as we work to track the evolving OpenTelemetry specification and user feedback.

Our progress towards a GA release candidate is tracked in this project board. This release candidate will follow semantic versioning and will be released with a major version greater than zero.

Progress and status specific to this repository is tracked in our local project boards and milestones.

Project versioning information and stability guarantees can be found in the versioning documentation.

Compatibility

This project is tested on the following systems.

OS Go Version Architecture
Ubuntu 1.15 amd64
Ubuntu 1.14 amd64
Ubuntu 1.15 386
Ubuntu 1.14 386
MacOS 1.15 amd64
MacOS 1.14 amd64
Windows 1.15 amd64
Windows 1.14 amd64
Windows 1.15 386
Windows 1.14 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.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.

Contributing

See the contributing documentation.