You've already forked opentelemetry-go
mirror of
https://github.com/open-telemetry/opentelemetry-go.git
synced 2026-06-03 18:35:08 +02:00
renovate[bot]
b8301a29d9
This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [CodSpeedHQ/action](https://redirect.github.com/CodSpeedHQ/action) | action | minor | `v4.11.1` → `v4.12.1` | --- > [!WARNING] > Some dependencies could not be looked up. Check the [Dependency Dashboard](../issues/5322) for more information. --- ### Release Notes <details> <summary>CodSpeedHQ/action (CodSpeedHQ/action)</summary> ### [`v4.12.1`](https://redirect.github.com/CodSpeedHQ/action/releases/tag/v4.12.1) [Compare Source](https://redirect.github.com/CodSpeedHQ/action/compare/v4.11.1...v4.12.1) #### Release Notes In this release, we've focused on improving the local user experience.\ We've revamped the output of the cli to provide tailed logs while the benchmarks are being executed, and polished a bit the display of results after your run. We also added support to run multiple modes in a single command invocation, both for local and CI runs!\ For instance, that means you can now do `codspeed run --mode simulation --mode memory --mode walltime -- cargo codspeed run` Last but not least, you can now define `entrypoints` in your project config ```yaml # codspeed.yml # List of commands that are run when running `codspeed run` without further arguments benchmarks: - name: My ls command # Mutually exclusive with entrypoint # Expects a command that will run a benchmark for an arbitrary command exec: ls -al /usr/bin - name: My pytest-codspeed benchmark # Mutually exclusive with exec # Expects a command that will run a benchmark program that is using a codspeed integration entrypoint: pytest --codspeed src ``` Fix a bug where memory profiling with `codspeed exec` for binaries that use statically-linked allocators (e.g. jemalloc in Rust). Previously, we reported incorrect memory usage because it didn't attach to the statically linked allocators. #### Details ##### <!-- 0 -->🚀 Features - Set NODE\_OPTIONS to get perf map from node by [@​GuillaumeLagrange](https://redirect.github.com/GuillaumeLagrange) in [#​267](https://redirect.github.com/CodSpeedHQ/runner/pull/267) - Disable node instrospection for exec-harness by [@​GuillaumeLagrange](https://redirect.github.com/GuillaumeLagrange) - Support CODSPEED\_MEMTRACK\_BINARIES for static allocator discovery by [@​not-matthias](https://redirect.github.com/not-matthias) - Gracefully handle logs from the runner while rolling buffer is active by [@​GuillaumeLagrange](https://redirect.github.com/GuillaumeLagrange) - Add `--show-full-output` to bypass the new rolling buffer by [@​GuillaumeLagrange](https://redirect.github.com/GuillaumeLagrange) - Add a spinner while waiting for results by [@​GuillaumeLagrange](https://redirect.github.com/GuillaumeLagrange) - Clean up group headers and emoji usage, make the executor title not dim after run by [@​GuillaumeLagrange](https://redirect.github.com/GuillaumeLagrange) - Add rolling buffer to display logs from executors by [@​GuillaumeLagrange](https://redirect.github.com/GuillaumeLagrange) - Polish impact reporting and upload feedback by [@​art049](https://redirect.github.com/art049) - Add color-coded metrics to benchmark result tables by [@​art049](https://redirect.github.com/art049) - Enhance local logger with richer visual hierarchy by [@​art049](https://redirect.github.com/art049) - Style the ASCII banner with CodSpeed orange by [@​GuillaumeLagrange](https://redirect.github.com/GuillaumeLagrange) - Enforce CodSpeed CLI as single source of truth for all measurements by [@​art049](https://redirect.github.com/art049) - Add optimize and setup-harness skills by [@​art049](https://redirect.github.com/art049) - Add the cursor plugin by [@​art049](https://redirect.github.com/art049) - Check if user is logged in before doing a local run by [@​GuillaumeLagrange](https://redirect.github.com/GuillaumeLagrange) in [#​263](https://redirect.github.com/CodSpeedHQ/runner/pull/263) - Skip respository resolve with `--skip-upload` by [@​GuillaumeLagrange](https://redirect.github.com/GuillaumeLagrange) - Use an enum and fix schema for entry/entrypoint by [@​GuillaumeLagrange](https://redirect.github.com/GuillaumeLagrange) in [#​260](https://redirect.github.com/CodSpeedHQ/runner/pull/260) - Accept a mix of entrypoint and exec targets in project config by [@​GuillaumeLagrange](https://redirect.github.com/GuillaumeLagrange) - Introduce OrchestratorConfig and ExecutorConfig by [@​GuillaumeLagrange](https://redirect.github.com/GuillaumeLagrange) - Unify run\_part\_id suffix computation between ci providers and local by [@​GuillaumeLagrange](https://redirect.github.com/GuillaumeLagrange) - Add the claude plugin by [@​art049](https://redirect.github.com/art049) - Add local\_data to upload metadata by [@​GuillaumeLagrange](https://redirect.github.com/GuillaumeLagrange) - Use repositoryOverview resolver rather than repository by [@​GuillaumeLagrange](https://redirect.github.com/GuillaumeLagrange) ##### <!-- 1 -->🐛 Bug Fixes - Use fp unwinding mode when running `go test` by [@​GuillaumeLagrange](https://redirect.github.com/GuillaumeLagrange) in [#​269](https://redirect.github.com/CodSpeedHQ/runner/pull/269) - Improve error message when no benchmarks are found by [@​GuillaumeLagrange](https://redirect.github.com/GuillaumeLagrange) in [#​264](https://redirect.github.com/CodSpeedHQ/runner/pull/264) ##### <!-- 2 -->🏗️ Refactor - Extract shared test helpers for compile and track by [@​not-matthias](https://redirect.github.com/not-matthias) - Pass extra env via config instead of unsafe set\_var by [@​not-matthias](https://redirect.github.com/not-matthias) - Remove the closure argument to poll in favor of polling options by [@​GuillaumeLagrange](https://redirect.github.com/GuillaumeLagrange) - Move EXEC\_HARNESS\_VERSION and EXEC\_HARNESS\_COMMAND to orchestrator mod by [@​GuillaumeLagrange](https://redirect.github.com/GuillaumeLagrange) - Flatten orchestrator execution loop over (command, mode) pairs by [@​GuillaumeLagrange](https://redirect.github.com/GuillaumeLagrange) - Introduce Orchestrator to support multi-mode execution by [@​GuillaumeLagrange](https://redirect.github.com/GuillaumeLagrange) in [#​259](https://redirect.github.com/CodSpeedHQ/runner/pull/259) - Consolidate poll\_results into upload module by [@​GuillaumeLagrange](https://redirect.github.com/GuillaumeLagrange) ##### <!-- 3 -->📚 Documentation - docs: add documentation about multiple modes in a single run by [@​GuillaumeLagrange](https://redirect.github.com/GuillaumeLagrange) in [#​195](https://redirect.github.com/CodSpeedHQ/action/pull/195) ##### <!-- 6 -->🧪 Testing - Add spawn wrapper integration test for static allocator discovery by [@​not-matthias](https://redirect.github.com/not-matthias) in [#​266](https://redirect.github.com/CodSpeedHQ/runner/pull/266) ##### <!-- 7 -->⚙️ Internals - Bump linux-perf-data to use upstream version by [@​GuillaumeLagrange](https://redirect.github.com/GuillaumeLagrange) in [#​271](https://redirect.github.com/CodSpeedHQ/runner/pull/271) - Remove lazy\_static in favor of LazyLock by [@​GuillaumeLagrange](https://redirect.github.com/GuillaumeLagrange) in [#​265](https://redirect.github.com/CodSpeedHQ/runner/pull/265) - Rename skill directories with codspeed prefix by [@​art049](https://redirect.github.com/art049) - Move architecture docs out of this repo by [@​GuillaumeLagrange](https://redirect.github.com/GuillaumeLagrange) in [#​262](https://redirect.github.com/CodSpeedHQ/runner/pull/262) - Typo in plugin description by [@​art049](https://redirect.github.com/art049) - Bump memtrack version - chore: bump runner version to 4.12.0 by [@​github-actions](https://redirect.github.com/github-actions)\[bot] in [#​194](https://redirect.github.com/CodSpeedHQ/action/pull/194) - chore: bump runner version to 4.12.1 by [@​github-actions](https://redirect.github.com/github-actions)\[bot] in [#​196](https://redirect.github.com/CodSpeedHQ/action/pull/196) #### Install codspeed-runner 4.12.1 ##### Install prebuilt binaries via shell script ```sh curl --proto '=https' --tlsv1.2 -LsSf https://github.com/CodSpeedHQ/codspeed/releases/download/v4.12.1/codspeed-runner-installer.sh | sh ``` #### Download codspeed-runner 4.12.1 | File | Platform | Checksum | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------- | | [codspeed-runner-aarch64-unknown-linux-musl.tar.gz](https://redirect.github.com/CodSpeedHQ/codspeed/releases/download/v4.12.1/codspeed-runner-aarch64-unknown-linux-musl.tar.gz) | ARM64 MUSL Linux | [checksum](https://redirect.github.com/CodSpeedHQ/codspeed/releases/download/v4.12.1/codspeed-runner-aarch64-unknown-linux-musl.tar.gz.sha256) | | [codspeed-runner-x86\_64-unknown-linux-musl.tar.gz](https://redirect.github.com/CodSpeedHQ/codspeed/releases/download/v4.12.1/codspeed-runner-x86_64-unknown-linux-musl.tar.gz) | x64 MUSL Linux | [checksum](https://redirect.github.com/CodSpeedHQ/codspeed/releases/download/v4.12.1/codspeed-runner-x86_64-unknown-linux-musl.tar.gz.sha256) | **Full Runner Changelog**: <https://github.com/CodSpeedHQ/codspeed/blob/main/CHANGELOG.md> **Full Changelog**: <https://github.com/CodSpeedHQ/action/compare/v4.11.1...v4.12.1> </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:eyJjcmVhdGVkSW5WZXIiOiI0My42Ni40IiwidXBkYXRlZEluVmVyIjoiNDMuNjYuNCIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOlsiU2tpcCBDaGFuZ2Vsb2ciLCJkZXBlbmRlbmNpZXMiXX0=--> 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.26 | amd64 |
| Ubuntu | 1.25 | amd64 |
| Ubuntu | 1.26 | 386 |
| Ubuntu | 1.25 | 386 |
| Ubuntu | 1.26 | arm64 |
| Ubuntu | 1.25 | arm64 |
| macOS | 1.26 | amd64 |
| macOS | 1.25 | amd64 |
| macOS | 1.26 | arm64 |
| macOS | 1.25 | arm64 |
| Windows | 1.26 | amd64 |
| Windows | 1.25 | amd64 |
| Windows | 1.26 | 386 |
| Windows | 1.25 | 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.