1
0
mirror of https://github.com/open-telemetry/opentelemetry-go.git synced 2024-12-12 10:04:29 +02:00
OpenTelemetry Go API and SDK https://opentelemetry.io/
Go to file
Damien Mathieu 844b107e98
Validate instrument names when creating them (#4210)
* validate instrument names when creating them

* add changelog entry

* remove now invalid instrument name from prometheus test

* fix invalid names in meter_test

* keep returning the instrument even if its name is invalid

* make invalid instrument name a known error

* bring back prometheus invalid instrument name test

* remove warning

* fix lint

* move name validation into the lookup method

* fix lint again

* Revert "move name validation into the lookup method"

This reverts commit ec8ccc5fa0.

* rename ErrInvalidInstrumentName to ErrInstrumentName

* switch to explicit validations, instead of a regexp

* Update CHANGELOG.md

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

* remove double check for empty name

* test validation shortcut with a single character

---------

Co-authored-by: Tyler Yahn <MrAlias@users.noreply.github.com>
Co-authored-by: Aaron Clawson <3766680+MadVikingGod@users.noreply.github.com>
2023-06-09 08:32:56 -07:00
.github [chore] Update dependabot-pr branch name (#4191) 2023-06-05 11:30:19 +02:00
attribute Guard zero value Set methods (#3957) 2023-04-04 08:06:10 -07:00
baggage Use strings.Cut() instead of string.SplitN() (#4049) 2023-05-17 09:28:44 -07:00
bridge dependabot updates Mon Jun 5 09:32:52 UTC 2023 (#4198) 2023-06-05 11:41:23 +02:00
codes [chore] Pin otel-specification hyperlinks (#4033) 2023-05-09 08:45:39 -07:00
example Upgrade go.opentelemetry.io/proto/otlp to v0.20.0 (#4213) 2023-06-08 08:57:18 -07:00
exporters Validate instrument names when creating them (#4210) 2023-06-09 08:32:56 -07:00
internal dependabot updates Mon Jun 5 09:32:52 UTC 2023 (#4198) 2023-06-05 11:41:23 +02:00
metric dependabot updates Mon Jun 5 09:32:52 UTC 2023 (#4198) 2023-06-05 11:41:23 +02:00
propagation docs(typos): Run codespell to fix typos (#3980) 2023-04-11 17:28:13 -07:00
schema dependabot updates Mon Jun 5 09:32:52 UTC 2023 (#4198) 2023-06-05 11:41:23 +02:00
sdk Validate instrument names when creating them (#4210) 2023-06-09 08:32:56 -07:00
semconv Use strings.Cut() instead of string.SplitN() (#4049) 2023-05-17 09:28:44 -07:00
trace dependabot updates Mon Jun 5 09:32:52 UTC 2023 (#4198) 2023-06-05 11:41:23 +02:00
website_docs Common weights for go pages (#4211) 2023-06-07 07:14:32 -07:00
.codespellignore feat(ci): Add codespell to Makefile and GitHub Actions (#3996) 2023-05-18 09:06:27 -07:00
.codespellrc feat(ci): Add codespell to Makefile and GitHub Actions (#3996) 2023-05-18 09:06:27 -07:00
.gitattributes Create .gitattributes (#1920) 2021-05-13 11:23:29 -04:00
.gitignore feat(ci): Add codespell to Makefile and GitHub Actions (#3996) 2023-05-18 09:06:27 -07:00
.gitmodules Move OTLP to the OTLP exporter (#1050) 2020-08-10 19:55:52 -07:00
.golangci.yml Bump github.com/golangci/golangci-lint from 1.52.2 to 1.53.2 in /internal/tools (#4177) 2023-06-04 07:54:38 -07:00
.lycheeignore Run website formatter over website_docs (#3762) 2023-02-24 07:35:24 -06:00
.markdownlint.yaml Fix existing markdown lint issues (#1866) 2021-04-30 10:51:19 -07:00
CHANGELOG.md Validate instrument names when creating them (#4210) 2023-06-09 08:32:56 -07:00
CODEOWNERS Move @Aneurysm9 to approver (#4137) 2023-05-26 08:13:37 -07:00
CONTRIBUTING.md [chore] Clarify that internal and test packages do not need docs (#4140) 2023-05-26 08:23:50 -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 dependabot updates Mon Jun 5 09:32:52 UTC 2023 (#4198) 2023-06-05 11:41:23 +02:00
go.sum dependabot updates Mon Jun 5 09:32:52 UTC 2023 (#4198) 2023-06-05 11:41:23 +02:00
handler_test.go Support a global MeterProvider in go.opentelemetry.io/otel (#3818) 2023-03-01 11:16:03 -08:00
handler.go Support a global MeterProvider in go.opentelemetry.io/otel (#3818) 2023-03-01 11:16:03 -08: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 [chore] Add go-work Make target (#4199) 2023-06-08 12:29:39 -07:00
metric_test.go Revert "Move global metric back to otel/metric/global for minor release (#3986)" (#4039) 2023-05-02 11:15:39 -07:00
metric.go Revert "Move global metric back to otel/metric/global for minor release (#3986)" (#4039) 2023-05-02 11:15:39 -07:00
propagation.go Fix small typo (#1409) 2020-12-17 12:07:09 -08:00
README.md [chore] Update Project Status and README formatting (#4146) 2023-06-01 07:30:39 -07:00
RELEASING.md Add semconv/v1.20.0 (#4078) 2023-05-16 11:17:28 -07:00
requirements.txt feat(ci): Add codespell to Makefile and GitHub Actions (#3996) 2023-05-18 09:06:27 -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 added version.go and test file for issue 2143 (#3677) 2023-05-09 08:29:19 -07:00
version.go Release v1.16.0/v0.39.0 -- Stable Metric API (#4100) 2023-05-22 12:06:21 -07:00
VERSIONING.md Fix RC tags in docs (#2239) 2021-09-14 08:15:02 -07:00
versions.yaml Release v1.16.0/v0.39.0 -- Stable Metric API (#4100) 2023-05-22 12:06:21 -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 Mixed [1] Go: Metric SDK (GA)
Logs Frozen [2] N/A
  • [1]: Metrics API is Stable. Metrics SDK is Beta.
  • [2]: The Logs signal development is halted for this project while we stablize the Metrics SDK. No Logs Pull Requests are currently being accepted.

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.20 amd64
Ubuntu 1.19 amd64
Ubuntu 1.20 386
Ubuntu 1.19 386
MacOS 1.20 amd64
MacOS 1.19 amd64
Windows 1.20 amd64
Windows 1.19 amd64
Windows 1.20 386
Windows 1.19 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.