You've already forked opentelemetry-go
mirror of
https://github.com/open-telemetry/opentelemetry-go.git
synced 2025-08-10 22:31:50 +02:00
ae0cc743a0
This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [otel/weaver](https://redirect.github.com/open-telemetry/weaver) | final | minor | `v0.12.0` -> `v0.13.0` | --- ### Release Notes <details> <summary>open-telemetry/weaver (otel/weaver)</summary> ### [`v0.13.0`](https://redirect.github.com/open-telemetry/weaver/releases/tag/v0.13.0): 0.13.0 - 2025-02-07 [Compare Source](https://redirect.github.com/open-telemetry/weaver/compare/v0.12.0...v0.13.0) #### Release Notes What's changed - **Breaking Change**: Introduced a new `weaver registry diff` command to generate a diff report between two versions of the semantic convention registry. This PR introduces a breaking change in the semantic conventions schema. While the text-based `deprecated` field is still supported for compatibility reasons, future semantic conventions should use the new `deprecated` structured format. ([#​400](https://redirect.github.com/open-telemetry/weaver/pull/400/) by [@​lquerel](https://redirect.github.com/lquerel)). - The `deprecated` field is now a structured field defining the precise reason for deprecation. The semantic conventions must be updated to adopt this new format. - The changes related to the `deprecated` field (i.e., string → struct) also have a potential impact on certain templates that reference the `deprecated` field as containing text. These templates will need to be updated to use the `brief` field, which provides a textual explanation of the reasons for the deprecation. - Improvement of comment generation: removal of `<p>` tags that precede `@` Javadoc tags. ([#​574](https://redirect.github.com/open-telemetry/weaver/pull/574) by [@​trask](https://redirect.github.com/trask)). - For Issue [#​564](https://redirect.github.com/open-telemetry/weaver/issues/564) - Require attributes and event fields to have stability: Added warnings for missing stability on: Attributes, Enum members in attributes, Event AnyValues, Enum members in AnyValues. ([#​568](https://redirect.github.com/open-telemetry/weaver/pull/568) by [@​jerbly](https://redirect.github.com/jerbly)). - For issue \[[#​569](https://redirect.github.com/open-telemetry/weaver/issues/569)]\(Add include_stability config into semconv_grouped_attributes): `is_experimental` returns `true` by default. ([#​570](https://redirect.github.com/open-telemetry/weaver/pull/570) by [@​jerbly](https://redirect.github.com/jerbly)). - Added an OTLP receiver to Weaver to prepare for the `weaver registry live-check` command. (see [#​548](https://redirect.github.com/open-telemetry/weaver/pull/548) by [@​lquerel](https://redirect.github.com/lquerel)) - Add is_array filter and test for AttributeType. ([#​540](https://redirect.github.com/open-telemetry/weaver/pull/540) by [@​arthurDiff](https://redirect.github.com/arthurDiff)). - Refactored CLI registry commands to remove some duplication. Resolving the registry with policy checks is common for `generate`, `resolve` and `check`. ([#​536](https://redirect.github.com/open-telemetry/weaver/pull/536) by [@​jerbly](https://redirect.github.com/jerbly)). - Added missing `after_resolution` policy checks to `generate` and `resolve` through the common code. - Removed the deprecated `--registry-git-sub-dir` option. - Fixed bug in `check` if `--skip-policies` was specified then it would not fail for any validation errors. - Semantic Conventions Issue [#​1513](https://redirect.github.com/open-telemetry/semantic-conventions/issues/1513) - Make span_kind required in yaml and break down multi-kind span definitions - ([#​542](https://redirect.github.com/open-telemetry/weaver/pull/542) by [@​jerbly](https://redirect.github.com/jerbly)). - Updated the EBNF and JSON schema to define `span_kind` as mandatory for `span` group types. Added a group validity check as a warning. - First iteration of the new command: `registry emit`. Emits a semantic convention registry as example spans to your OTLP receiver. This may be useful in testing/simulation scenarios. ([#​549](https://redirect.github.com/open-telemetry/weaver/pull/549) by [@​jerbly](https://redirect.github.com/jerbly)) - For issue \[[#​569](https://redirect.github.com/open-telemetry/weaver/issues/569)]\(Add include_stability config into semconv_grouped_attributes): added `stable_only` boolean flag as a parameter for `semconv_signal`, `semconv_grouped_attributes`, and other `semconv_*` JQ semconv helpers. When `stable_only` is set to `true`, corresponding helper function returns stable conventions only. If the flag is not set or set to false, stability filtering does not apply. It's recommended to use `stable_only` flag instead of `exclude_stability` parameter. ([#​588](https://redirect.github.com/open-telemetry/weaver/pull/588) by [@​lmolkova](https://redirect.github.com/lmolkova)) #### Install weaver 0.13.0 ##### Install prebuilt binaries via shell script ```sh curl --proto '=https' --tlsv1.2 -LsSf https://github.com/open-telemetry/weaver/releases/download/v0.13.0/weaver-installer.sh | sh ``` ##### Install prebuilt binaries via powershell script ```sh powershell -c "irm https://github.com/open-telemetry/weaver/releases/download/v0.13.0/weaver-installer.ps1 | iex" ``` #### Download weaver 0.13.0 | File | Platform | Checksum | |--------|----------|----------| | [weaver-aarch64-apple-darwin.tar.xz](https://redirect.github.com/open-telemetry/weaver/releases/download/v0.13.0/weaver-aarch64-apple-darwin.tar.xz) | Apple Silicon macOS | [checksum](https://redirect.github.com/open-telemetry/weaver/releases/download/v0.13.0/weaver-aarch64-apple-darwin.tar.xz.sha256) | | [weaver-x86\_64-apple-darwin.tar.xz](https://redirect.github.com/open-telemetry/weaver/releases/download/v0.13.0/weaver-x86\_64-apple-darwin.tar.xz) | Intel macOS | [checksum](https://redirect.github.com/open-telemetry/weaver/releases/download/v0.13.0/weaver-x86\_64-apple-darwin.tar.xz.sha256) | | [weaver-x86\_64-pc-windows-msvc.zip](https://redirect.github.com/open-telemetry/weaver/releases/download/v0.13.0/weaver-x86\_64-pc-windows-msvc.zip) | x64 Windows | [checksum](https://redirect.github.com/open-telemetry/weaver/releases/download/v0.13.0/weaver-x86\_64-pc-windows-msvc.zip.sha256) | | [weaver-x86\_64-pc-windows-msvc.msi](https://redirect.github.com/open-telemetry/weaver/releases/download/v0.13.0/weaver-x86\_64-pc-windows-msvc.msi) | x64 Windows | [checksum](https://redirect.github.com/open-telemetry/weaver/releases/download/v0.13.0/weaver-x86\_64-pc-windows-msvc.msi.sha256) | | [weaver-x86\_64-unknown-linux-gnu.tar.xz](https://redirect.github.com/open-telemetry/weaver/releases/download/v0.13.0/weaver-x86\_64-unknown-linux-gnu.tar.xz) | x64 Linux | [checksum](https://redirect.github.com/open-telemetry/weaver/releases/download/v0.13.0/weaver-x86\_64-unknown-linux-gnu.tar.xz.sha256) | #### Verifying GitHub Artifact Attestations The artifacts in this release have attestations generated with GitHub Artifact Attestations. These can be verified by using the [GitHub CLI](https://cli.github.com/manual/gh_attestation_verify): ```sh gh attestation verify <file-path of downloaded artifact> --repo open-telemetry/weaver ``` You can also download the attestation from [GitHub](https://redirect.github.com/open-telemetry/weaver/attestations) and verify against that directly: ```sh gh attestation verify <file-path of downloaded artifact> --bundle <file-path of downloaded attestation> ``` </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR was generated by [Mend Renovate](https://mend.io/renovate/). View the [repository job log](https://developer.mend.io/github/open-telemetry/opentelemetry-go). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOS4xNDUuMCIsInVwZGF0ZWRJblZlciI6IjM5LjE0NS4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJTa2lwIENoYW5nZWxvZyIsImRlcGVuZGVuY2llcyJdfQ==--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.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.23 | amd64 |
| Ubuntu | 1.22 | amd64 |
| Ubuntu | 1.23 | 386 |
| Ubuntu | 1.22 | 386 |
| Linux | 1.23 | arm64 |
| Linux | 1.22 | arm64 |
| macOS 13 | 1.23 | amd64 |
| macOS 13 | 1.22 | amd64 |
| macOS | 1.23 | arm64 |
| macOS | 1.22 | arm64 |
| Windows | 1.23 | amd64 |
| Windows | 1.22 | amd64 |
| Windows | 1.23 | 386 |
| Windows | 1.22 | 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 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.