-
Notifications
You must be signed in to change notification settings - Fork 2
docs(opslog): align --track-bucket-slo descriptions with CLI help text #50
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
senolcolak
wants to merge
3
commits into
main
Choose a base branch
from
docs/fix-readme-verb-consistency
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| // SPDX-FileCopyrightText: 2025 SAP SE or an SAP affiliate company and prysm contributors | ||
| // | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| package opslog | ||
|
|
||
| import "github.com/prometheus/client_golang/prometheus" | ||
|
|
||
| var ( | ||
| sliRequestsTotal = prometheus.NewCounterVec( | ||
| prometheus.CounterOpts{ | ||
| Name: "radosgw_bucket_sli_requests_total", | ||
| Help: "Bucket GET/LIST requests for SLI and SLO evaluation", | ||
| }, | ||
| []string{"tenant", "bucket", "operation", "status_class"}, | ||
| ) | ||
|
|
||
| sliRequestDuration = prometheus.NewHistogramVec( | ||
| prometheus.HistogramOpts{ | ||
| Name: "radosgw_bucket_sli_request_duration_seconds", | ||
| Help: "Latency histogram for bucket GET/LIST requests used for SLI and SLO evaluation", | ||
| Buckets: []float64{0.05, 0.1, 0.2, 0.3, 0.5, 1, 2, 5, 10}, | ||
| }, | ||
| []string{"tenant", "bucket", "operation"}, | ||
| ) | ||
| ) | ||
|
|
||
| func registerSLIMetrics() { | ||
| prometheus.MustRegister(sliRequestsTotal) | ||
| prometheus.MustRegister(sliRequestDuration) | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| // SPDX-FileCopyrightText: 2025 SAP SE or an SAP affiliate company and prysm contributors | ||
| // | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| package opslog | ||
|
|
||
| import "strings" | ||
|
|
||
| type SLOperation string | ||
|
|
||
| const ( | ||
| SLOperationGet SLOperation = "get" | ||
| SLOperationList SLOperation = "list" | ||
| ) | ||
|
|
||
| func classifyBucketSLOOperation(operation string) (SLOperation, bool) { | ||
| switch strings.ToLower(operation) { | ||
| case "get_obj", "head_obj": | ||
| return SLOperationGet, true | ||
| case "list_bucket", "list_buckets", "get_bucket_info": | ||
| return SLOperationList, true | ||
| default: | ||
| return "", false | ||
| } | ||
| } | ||
|
|
||
| func statusClass(status string) string { | ||
| if len(status) == 0 { | ||
| return "unknown" | ||
| } | ||
| if status[0] < '0' || status[0] > '9' { | ||
| return "unknown" | ||
| } | ||
| return status[:1] + "xx" | ||
| } | ||
|
|
||
| func observeBucketSLI(logEntry S3OperationLog, tenant string) { | ||
| sloOperation, ok := classifyBucketSLOOperation(logEntry.Operation) | ||
| if !ok || logEntry.Bucket == "" { | ||
| return | ||
| } | ||
|
|
||
| sliRequestsTotal.WithLabelValues( | ||
| tenant, | ||
| logEntry.Bucket, | ||
| string(sloOperation), | ||
| statusClass(logEntry.HTTPStatus), | ||
| ).Inc() | ||
|
|
||
| if logEntry.TotalTime > 0 { | ||
| sliRequestDuration.WithLabelValues( | ||
| tenant, | ||
| logEntry.Bucket, | ||
| string(sloOperation), | ||
| ).Observe(float64(logEntry.TotalTime) / 1000.0) | ||
| } | ||
| } | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Restrict status classes to valid HTTP ranges (
1xx–5xx)statusClasscurrently turns any leading digit into a class, so malformed statuses can produce0xx/6xx–9xx. That degrades metric quality and can skew SLO queries expecting valid HTTP classes.💡 Proposed fix
func statusClass(status string) string { if len(status) == 0 { return "unknown" } - if status[0] < '0' || status[0] > '9' { + if status[0] < '1' || status[0] > '5' { return "unknown" } return status[:1] + "xx" }📝 Committable suggestion
🤖 Prompt for AI Agents