Skip to content
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

internal/cmd: add build info metric in helm/ansible operators #4220

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions changelog/fragments/helm-ansible-version-metric.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
entries:
- description: >
In Ansible-based operators, added the `ansible_operator_build_info`
metric to instrument commit and version information.
kind: "addition"
- description: >
In Helm-based operators, added the `helm_operator_build_info`
metric to instrument commit and version information.
kind: "addition"
18 changes: 18 additions & 0 deletions internal/ansible/metrics/metrics.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,26 @@ import (
"github.com/prometheus/client_golang/prometheus"
logf "sigs.k8s.io/controller-runtime/pkg/log"
"sigs.k8s.io/controller-runtime/pkg/metrics"

sdkVersion "github.com/operator-framework/operator-sdk/internal/version"
)

const (
subsystem = "ansible_operator"
)

var (
buildInfo = prometheus.NewGauge(
prometheus.GaugeOpts{
Subsystem: subsystem,
Name: "build_info",
Help: "Build information for the ansible-operator binary",
ConstLabels: map[string]string{
"commit": sdkVersion.GitCommit,
"version": sdkVersion.Version,
},
})

reconcileResults = prometheus.NewGaugeVec(
prometheus.GaugeOpts{
Subsystem: subsystem,
Expand Down Expand Up @@ -64,6 +77,11 @@ func recoverMetricPanic() {
}
}

func RegisterBuildInfo(r prometheus.Registerer) {
buildInfo.Set(1)
r.MustRegister(buildInfo)
}

func ReconcileSucceeded(gvk string) {
defer recoverMetricPanic()
reconcileResults.WithLabelValues(gvk, "succeeded").Inc()
Expand Down
3 changes: 3 additions & 0 deletions internal/cmd/ansible-operator/run/cmd.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,11 @@ import (
zapf "sigs.k8s.io/controller-runtime/pkg/log/zap"
"sigs.k8s.io/controller-runtime/pkg/manager"
"sigs.k8s.io/controller-runtime/pkg/manager/signals"
crmetrics "sigs.k8s.io/controller-runtime/pkg/metrics"

"github.com/operator-framework/operator-sdk/internal/ansible/controller"
"github.com/operator-framework/operator-sdk/internal/ansible/flags"
"github.com/operator-framework/operator-sdk/internal/ansible/metrics"
"github.com/operator-framework/operator-sdk/internal/ansible/proxy"
"github.com/operator-framework/operator-sdk/internal/ansible/proxy/controllermap"
"github.com/operator-framework/operator-sdk/internal/ansible/runner"
Expand Down Expand Up @@ -81,6 +83,7 @@ func NewCmd() *cobra.Command {

func run(cmd *cobra.Command, f *flags.Flags) {
printVersion()
metrics.RegisterBuildInfo(crmetrics.Registry)

cfg, err := config.GetConfig()
if err != nil {
Expand Down
3 changes: 3 additions & 0 deletions internal/cmd/helm-operator/run/cmd.go
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,11 @@ import (
zapf "sigs.k8s.io/controller-runtime/pkg/log/zap"
"sigs.k8s.io/controller-runtime/pkg/manager"
"sigs.k8s.io/controller-runtime/pkg/manager/signals"
crmetrics "sigs.k8s.io/controller-runtime/pkg/metrics"

"github.com/operator-framework/operator-sdk/internal/helm/controller"
"github.com/operator-framework/operator-sdk/internal/helm/flags"
"github.com/operator-framework/operator-sdk/internal/helm/metrics"
"github.com/operator-framework/operator-sdk/internal/helm/release"
"github.com/operator-framework/operator-sdk/internal/helm/watches"
"github.com/operator-framework/operator-sdk/internal/util/k8sutil"
Expand Down Expand Up @@ -73,6 +75,7 @@ func NewCmd() *cobra.Command {

func run(cmd *cobra.Command, f *flags.Flags) {
printVersion()
metrics.RegisterBuildInfo(crmetrics.Registry)

cfg, err := config.GetConfig()
if err != nil {
Expand Down
44 changes: 44 additions & 0 deletions internal/helm/metrics/metrics.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
// Copyright 2020 The Operator-SDK Authors
//
// 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"

sdkVersion "github.com/operator-framework/operator-sdk/internal/version"
)

const (
subsystem = "helm_operator"
)

var (
buildInfo = prometheus.NewGauge(
prometheus.GaugeOpts{
Subsystem: subsystem,
Name: "build_info",
Help: "Build information for the helm-operator binary",
ConstLabels: map[string]string{
"commit": sdkVersion.GitCommit,
"version": sdkVersion.Version,
},
},
)
)

func RegisterBuildInfo(r prometheus.Registerer) {
Copy link
Contributor

@camilamacedo86 camilamacedo86 Nov 23, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@joelanford just a nit. Could you please add a comment here in this method before we get it merged?

Suggested change
func RegisterBuildInfo(r prometheus.Registerer) {
// RegisterBuildInfo ...
func RegisterBuildInfo(r prometheus.Registerer) {

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm going to go ahead and merge without these comments since CI already passed. If I push to this branch again, this PR will get stuck (we're currently out of Travis CI build credits).

buildInfo.Set(1)
r.MustRegister(buildInfo)
}