1
0
mirror of https://github.com/open-telemetry/opentelemetry-go.git synced 2024-12-04 09:43:23 +02:00
OpenTelemetry Go API and SDK https://opentelemetry.io/
Go to file
2022-09-02 07:51:35 -07:00
.github Update golangci-lint to v1.48.0 (#3105) 2022-08-24 21:42:28 -05:00
attribute Update golangci-lint to v1.48.0 (#3105) 2022-08-24 21:42:28 -05:00
baggage fix typo (#2986) 2022-07-02 08:55:14 -07:00
bridge Fix opentracing.Bridge where it miss identifying the spanKind (#3096) 2022-08-18 13:49:25 -04:00
codes Prerelease v1.0.0 (#2250) 2021-09-20 13:02:46 -07:00
example Bump go.opentelemetry.io/proto/otlp from v0.18.0 to v0.19.0 (#3107) 2022-08-25 08:00:46 -05:00
exporters Add instrumentation scope attributes (#3131) 2022-08-31 15:19:50 -07:00
internal Update golangci-lint to v1.48.0 (#3105) 2022-08-24 21:42:28 -05:00
metric Add WithScopeAttributes MeterOption to metric API package (#3132) 2022-09-01 14:19:03 -07:00
propagation Un-escape url coding when parsing baggage. (#2529) 2022-01-24 09:17:45 -08:00
schema Introduce "split" metric schema transformation (#2999) 2022-07-25 08:30:23 -07:00
sdk Add instrumentation scope attributes (#3131) 2022-08-31 15:19:50 -07:00
semconv replace required by requirementlevel (#3103) 2022-08-22 12:47:11 -04:00
trace Refactor TracerProvider documentation (#3133) 2022-09-01 15:11:48 -07:00
website_docs consistency-of: Changed signal names for website docs (#3137) 2022-09-02 07:51:35 -07:00
.gitattributes Create .gitattributes (#1920) 2021-05-13 11:23:29 -04:00
.gitignore added traces.txt to gitignore for fib (#2993) 2022-07-06 14:41:30 -04:00
.gitmodules Move OTLP to the OTLP exporter (#1050) 2020-08-10 19:55:52 -07:00
.golangci.yml Use already enabled revive linter and add depguard (#2883) 2022-05-19 15:15:07 -05:00
.lycheeignore Add a release template (#2863) 2022-07-06 19:00:21 -04:00
.markdownlint.yaml Fix existing markdown lint issues (#1866) 2021-04-30 10:51:19 -07:00
CHANGELOG.md Add WithScopeAttributes MeterOption to metric API package (#3132) 2022-09-01 14:19:03 -07:00
CODEOWNERS add @dmathieu as an approver (#2908) 2022-05-18 09:21:57 -07:00
CONTRIBUTING.md add @dmathieu as an approver (#2908) 2022-05-18 09:21:57 -07:00
doc.go Prerelease v1.0.0 (#2250) 2021-09-20 13:02:46 -07:00
error_handler.go Add ErrorHandlerFunc to simplify creating ErrorHandlers (#2149) 2021-08-03 15:15:54 -07: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 Release v1.9.0 (#3052) 2022-08-02 08:02:33 -07:00
go.sum Release prep 1.8.0 (#3001) 2022-07-08 14:23:16 -04:00
handler_test.go Replace ioutil with io and os (#3058) 2022-08-03 14:45:05 -07:00
handler.go Use already enabled revive linter and add depguard (#2883) 2022-05-19 15:15:07 -05:00
internal_logging_test.go Fixes race, moved into global 2021-11-24 20:06:39 +00:00
internal_logging.go Fixes race, moved into global 2021-11-24 20:06:39 +00:00
LICENSE Initial commit 2019-05-16 12:05:27 -07:00
Makefile Release prep 1.8.0 (#3001) 2022-07-08 14:23:16 -04:00
propagation.go Fix small typo (#1409) 2020-12-17 12:07:09 -08:00
README.md Update compatibility documentation (#3079) 2022-08-10 10:57:01 -05:00
RELEASING.md Update RELEASING docs git command for semconv gen (#2789) 2022-04-14 11:17:22 -07:00
trace_test.go Remove unnecessary internal package for noop instances (#2867) 2022-04-28 12:11:17 -07:00
trace.go Update golangci-lint to v1.48.0 (#3105) 2022-08-24 21:42:28 -05:00
verify_examples.sh Clean up tools (#762) 2020-05-26 11:35:34 -07:00
version_test.go Release v0.20.0 (#1837) 2021-04-23 11:19:07 -07:00
version.go Release v1.9.0 (#3052) 2022-08-02 08:02:33 -07:00
VERSIONING.md Fix RC tags in docs (#2239) 2021-09-14 08:15:02 -07:00
versions.yaml Release v1.9.0 (#3052) 2022-08-02 08:02:33 -07:00

OpenTelemetry-Go

CI codecov.io PkgGoDev Go Report Card Slack

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 Project
Traces Stable N/A
Metrics Alpha N/A
Logs Frozen [1] N/A
  • [1]: The Logs signal development is halted for this project while we develop both Traces and Metrics. No Logs Pull Requests are currently being accepted.

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

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.19 amd64
Ubuntu 1.18 amd64
Ubuntu 1.17 amd64
Ubuntu 1.19 386
Ubuntu 1.18 386
Ubuntu 1.17 386
MacOS 1.19 amd64
MacOS 1.18 amd64
MacOS 1.17 amd64
Windows 1.19 amd64
Windows 1.18 amd64
Windows 1.17 amd64
Windows 1.19 386
Windows 1.18 386
Windows 1.17 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 Metrics Traces
Jaeger
OTLP
Prometheus
stdout
Zipkin

Contributing

See the contributing documentation.