Skip to content

Commit 04df525

Browse files
authored
Allow disabling the creation of the SM for operator metrics (#3509)
Signed-off-by: Israel Blancas <[email protected]>
1 parent b6e7636 commit 04df525

File tree

4 files changed

+25
-2
lines changed

4 files changed

+25
-2
lines changed

.chloggen/3474.yaml

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
2+
change_type: breaking
3+
4+
# The name of the component, or a single word describing the area of concern, (e.g. collector, target allocator, auto-instrumentation, opamp, github action)
5+
component: operator
6+
7+
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
8+
note: Make ServiceMonitor for operator metrics optional and disable it by default
9+
10+
# One or more tracking issues related to the change
11+
issues: [3474]
12+
13+
# (Optional) One or more lines of additional information to render under the primary note.
14+
# These lines will be padded with 2 spaces and then inserted directly into the document.
15+
# Use pipe (|) for multiline entries.
16+
subtext: |
17+
Add `--create-sm-operator-metrics` flag to create a ServiceMonitor for the operator metrics.
18+
This is disabled by default, which is a breaking change, because it was enabled by default in 0.113.0 and 0.114.0.

bundle/openshift/manifests/opentelemetry-operator.clusterserviceversion.yaml

+1
Original file line numberDiff line numberDiff line change
@@ -528,6 +528,7 @@ spec:
528528
- --openshift-create-dashboard=true
529529
- --feature-gates=+operator.observability.prometheus
530530
- --enable-cr-metrics=true
531+
- --create-sm-operator-metrics=true
531532
env:
532533
- name: SERVICE_ACCOUNT_NAME
533534
valueFrom:

config/overlays/openshift/manager-patch.yaml

+2-1
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,5 @@
99
- '--enable-go-instrumentation=true'
1010
- '--openshift-create-dashboard=true'
1111
- '--feature-gates=+operator.observability.prometheus'
12-
- '--enable-cr-metrics=true'
12+
- '--enable-cr-metrics=true'
13+
- '--create-sm-operator-metrics=true'

main.go

+4-1
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,7 @@ func main() {
115115
enableNodeJSInstrumentation bool
116116
enableJavaInstrumentation bool
117117
enableCRMetrics bool
118+
createSMOperatorMetrics bool
118119
collectorImage string
119120
targetAllocatorImage string
120121
operatorOpAMPBridgeImage string
@@ -154,6 +155,7 @@ func main() {
154155
pflag.BoolVar(&enableNodeJSInstrumentation, constants.FlagNodeJS, true, "Controls whether the operator supports nodejs auto-instrumentation")
155156
pflag.BoolVar(&enableJavaInstrumentation, constants.FlagJava, true, "Controls whether the operator supports java auto-instrumentation")
156157
pflag.BoolVar(&enableCRMetrics, constants.FlagCRMetrics, false, "Controls whether exposing the CR metrics is enabled")
158+
pflag.BoolVar(&createSMOperatorMetrics, "create-sm-operator-metrics", false, "Create a ServiceMonitor for the operator metrics")
157159

158160
stringFlagOrEnv(&collectorImage, "collector-image", "RELATED_IMAGE_COLLECTOR", fmt.Sprintf("ghcr.io/open-telemetry/opentelemetry-collector-releases/opentelemetry-collector:%s", v.OpenTelemetryCollector), "The default OpenTelemetry collector image. This image is used when no image is specified in the CustomResource.")
159161
stringFlagOrEnv(&targetAllocatorImage, "target-allocator-image", "RELATED_IMAGE_TARGET_ALLOCATOR", fmt.Sprintf("ghcr.io/open-telemetry/opentelemetry-operator/target-allocator:%s", v.TargetAllocator), "The default OpenTelemetry target allocator image. This image is used when no image is specified in the CustomResource.")
@@ -219,6 +221,7 @@ func main() {
219221
"enable-nodejs-instrumentation", enableNodeJSInstrumentation,
220222
"enable-java-instrumentation", enableJavaInstrumentation,
221223
"create-openshift-dashboard", createOpenShiftDashboard,
224+
"create-sm-operator-metrics", createSMOperatorMetrics,
222225
"zap-message-key", encodeMessageKey,
223226
"zap-level-key", encodeLevelKey,
224227
"zap-time-key", encodeTimeKey,
@@ -413,7 +416,7 @@ func main() {
413416
os.Exit(1)
414417
}
415418

416-
if cfg.PrometheusCRAvailability() == prometheus.Available {
419+
if cfg.PrometheusCRAvailability() == prometheus.Available && createSMOperatorMetrics {
417420
operatorMetrics, opError := operatormetrics.NewOperatorMetrics(mgr.GetConfig(), scheme, ctrl.Log.WithName("operator-metrics-sm"))
418421
if opError != nil {
419422
setupLog.Error(opError, "Failed to create the operator metrics SM")

0 commit comments

Comments
 (0)