-
Notifications
You must be signed in to change notification settings - Fork 90
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
Add upjet runtime Prometheus metrics #170
Merged
Merged
Changes from all commits
Commits
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 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 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 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 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 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,90 @@ | ||
| // Copyright 2023 Upbound Inc. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package metrics | ||
|
|
||
| import ( | ||
| "github.com/prometheus/client_golang/prometheus" | ||
| "sigs.k8s.io/controller-runtime/pkg/metrics" | ||
| ) | ||
|
|
||
| const ( | ||
| promNSUpjet = "upjet" | ||
| promSysTF = "terraform" | ||
| promSysResource = "resource" | ||
| ) | ||
|
|
||
| // ExecMode is the Terraform CLI execution mode label | ||
| type ExecMode int | ||
|
|
||
| const ( | ||
| // ModeSync represents the synchronous execution mode | ||
| ModeSync ExecMode = iota | ||
| // ModeASync represents the asynchronous execution mode | ||
| ModeASync | ||
| ) | ||
|
|
||
| // String converts an execMode to string | ||
| func (em ExecMode) String() string { | ||
| switch em { | ||
| case ModeSync: | ||
| return "sync" | ||
| case ModeASync: | ||
| return "async" | ||
| default: | ||
| return "unknown" | ||
| } | ||
| } | ||
|
|
||
| var ( | ||
| // CLITime is the Terraform CLI execution times histogram. | ||
| CLITime = prometheus.NewHistogramVec(prometheus.HistogramOpts{ | ||
| Namespace: promNSUpjet, | ||
| Subsystem: promSysTF, | ||
| Name: "cli_duration", | ||
| Help: "Measures in seconds how long it takes a Terraform CLI invocation to complete", | ||
| Buckets: []float64{1.0, 3, 5, 10, 15, 30, 60, 120, 300}, | ||
| }, []string{"subcommand", "mode"}) | ||
|
|
||
| // CLIExecutions are the active number of terraform CLI invocations. | ||
| CLIExecutions = prometheus.NewGaugeVec(prometheus.GaugeOpts{ | ||
| Namespace: promNSUpjet, | ||
| Subsystem: promSysTF, | ||
| Name: "active_cli_invocations", | ||
| Help: "The number of active (running) Terraform CLI invocations", | ||
| }, []string{"subcommand", "mode"}) | ||
|
|
||
| // TFProcesses are the active number of | ||
| // terraform CLI & Terraform provider processes running. | ||
| TFProcesses = prometheus.NewGaugeVec(prometheus.GaugeOpts{ | ||
| Namespace: promNSUpjet, | ||
| Subsystem: promSysTF, | ||
| Name: "running_processes", | ||
| Help: "The number of running Terraform CLI and Terraform provider processes", | ||
| }, []string{"type"}) | ||
|
|
||
| // TTRMeasurements are the time-to-readiness measurements for | ||
| // the managed resources. | ||
| TTRMeasurements = prometheus.NewHistogramVec(prometheus.HistogramOpts{ | ||
| Namespace: promNSUpjet, | ||
| Subsystem: promSysResource, | ||
| Name: "ttr", | ||
| Help: "Measures in seconds the time-to-readiness (TTR) for managed resources", | ||
| Buckets: []float64{10, 15, 30, 60, 120, 300, 600, 1800, 3600}, | ||
| }, []string{"group", "version", "kind"}) | ||
| ) | ||
|
|
||
| func init() { | ||
| metrics.Registry.MustRegister(CLITime, CLIExecutions, TFProcesses, TTRMeasurements) | ||
| } | ||
This file contains 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 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 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
Oops, something went wrong.
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.
Consider this non-blocking, but I'd prefer to use OpenTelemetry to expose Prom metrics. I believe we mostly use Otel for Upbound things internally, and it would open a path to use one SDK for all observability (i.e. traces and logs too).
We've held off on this in the past waiting to see what controller-runtime would do per kubernetes-sigs/controller-runtime#305.
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.
Thanks @negz for the pointer. Makes sense to me.
Let's proceed with the Prometheus metrics for now as the controller-runtime still makes use of them. I have not checked if it's possible with OpenTelemetry metrics but it was convenient to register upjet's custom metrics with the controller-runtime's registry. What do you think?
Opened #171 to track this. Thank you @negz for bringing this up. Let's track it there.