-
Notifications
You must be signed in to change notification settings - Fork 90
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add upjet runtime Prometheus metrics:
- upjet_terraform_cli_duration: Reports statistics, in seconds, on how long it takes a Terraform CLI invocation to complete - upjet_terraform_active_cli_invocations: The number of active (running) Terraform CLI invocations - upjet_terraform_running_processes: The number of running Terraform CLI and Terraform provider processes - upjet_resource_ttr: Measures, in seconds, the time-to-readiness for managed resources - terraform.Operation.MarkStart now atomically checks for any previous ongoing operation before starting a new one - terraform.Operation.{Start,End}Time no longer return pointers that could potentially be used to modify the shared state outside of critical sections. Signed-off-by: Alper Rifat Ulucinar <ulucinar@users.noreply.github.com>
- Loading branch information
Showing
10 changed files
with
197 additions
and
58 deletions.
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,93 @@ | ||
// 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" | ||
// TODO(aru): we will probably remove this label from collected metrics | ||
// as it has potentially high cardinality. | ||
promLabelWS = "workspace" | ||
) | ||
|
||
// 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{promLabelWS, "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{promLabelWS, "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 for managed resources", | ||
Buckets: []float64{10, 15, 30, 60, 120, 300, 600, 1800, 3600}, | ||
}, []string{"group", "version", "kind", "name", "uid"}) | ||
) | ||
|
||
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.