fix: panic when a request did not set the OpPath for instrumentation #635
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When an instrumented client (API or Metadata) made a request that did not explicitly specify the OpPath through `ctxutil.SetOpPath()` that instrumentation code caused a panic. This is now handled by adding back a fallback if the explicit OpPath is not set. The fallback uses the same patterns to create the OpPath as our manual paths. This only happened for the Metadata client and any custom clients/requests that users added besides the official endpoints implemented in hcloud-go. Co-authored-by: Jonas Lammler <jonas.lammler@hetzner-cloud.de>
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #635 +/- ##
==========================================
+ Coverage 78.93% 79.15% +0.21%
==========================================
Files 50 50
Lines 4373 4395 +22
==========================================
+ Hits 3452 3479 +27
+ Misses 706 701 -5
Partials 215 215 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
jooola
approved these changes
Mar 20, 2025
apricote
pushed a commit
that referenced
this pull request
Mar 20, 2025
### Bug Fixes - panic when a request did not set the OpPath for instrumentation (#635)
apricote
pushed a commit
to hetznercloud/fleeting-plugin-hetzner
that referenced
this pull request
Mar 20, 2025
…0.1 (hetznercloud/fleeting-plugin-hetzner!230) This MR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [github.com/hetznercloud/hcloud-go/v2](https://github.com/hetznercloud/hcloud-go) | require | minor | `v2.19.1` -> `v2.20.1` | --- ### Release Notes <details> <summary>hetznercloud/hcloud-go (github.com/hetznercloud/hcloud-go/v2)</summary> ### [`v2.20.1`](https://github.com/hetznercloud/hcloud-go/blob/HEAD/CHANGELOG.md#v2201) [Compare Source](hetznercloud/hcloud-go@v2.20.0...v2.20.1) ##### Bug Fixes - panic when a request did not set the OpPath for instrumentation ([#​635](hetznercloud/hcloud-go#635)) ### [`v2.20.0`](https://github.com/hetznercloud/hcloud-go/blob/HEAD/CHANGELOG.md#v2200) [Compare Source](hetznercloud/hcloud-go@v2.19.1...v2.20.0) In this release, the `api_endpoint` metric labels changed for all our API requests. Please make sure to update your setup if you were relying on them. The new labels are now easier to understand, see the example below: - the path `/volumes/64314930` now has the label `/volumes/-` instead of `/volumes/` - the path `/volumes/64314930/actions/resize` now has the label `/volumes/-/actions/resize` instead of `/volumes/actions/resize` ##### Features - support go v1.24 ([#​604](hetznercloud/hcloud-go#604)) - drop go v1.21 ([#​604](hetznercloud/hcloud-go#604)) - **exp**: remove sliceutil package ([#​610](hetznercloud/hcloud-go#610)) - drop go v1.22 ([#​602](hetznercloud/hcloud-go#602)) ([#​621](hetznercloud/hcloud-go#621)) - redefine `api_endpoint` metric labels ([#​626](hetznercloud/hcloud-go#626)) ##### Bug Fixes - request in batches of 25 when waiting for actions ([#​611](hetznercloud/hcloud-go#611)) - missing response from requests return values ([#​613](hetznercloud/hcloud-go#613)) - move primary ip client request/response structs to schema package ([#​633](hetznercloud/hcloud-go#633)) </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 MR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this MR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOS4yMDguMCIsInVwZGF0ZWRJblZlciI6IjM5LjIxMC4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6W119-->
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When an instrumented client (API or Metadata) made a request that did not explicitly specify the OpPath through
ctxutil.SetOpPath()that instrumentation code caused a panic.This is now handled by adding back a fallback if the explicit OpPath is not set. The fallback uses the same patterns to create the OpPath as our manual paths.
This only happened for the Metadata client and any custom clients/requests that users added besides the official endpoints implemented in hcloud-go.
Bug was introduced in #626, thanks to @lukasmetzner for finding and reporting.
Co-authored-by: Jonas Lammler jonas.lammler@hetzner-cloud.de