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.

Sign up for GitHub

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

Jump to bottom

[operator] Add extra labels/annotations on default alerts #1226

Merged
merged 1 commit into from
Jul 2, 2024
Merged

[operator] Add extra labels/annotations on default alerts #1226

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion charts/opentelemetry-operator/Chart.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
apiVersion: v2
name: opentelemetry-operator
version: 0.64.0
version: 0.64.1
description: OpenTelemetry Operator Helm chart for Kubernetes
type: application
home: https://opentelemetry.io/
Expand Down
4 changes: 2 additions & 2 deletions ...ator/examples/default/rendered/admission-webhooks/operator-webhook-with-cert-manager.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ metadata:
annotations:
cert-manager.io/inject-ca-from: default/example-opentelemetry-operator-serving-cert
labels:
helm.sh/chart: opentelemetry-operator-0.64.0
helm.sh/chart: opentelemetry-operator-0.64.1
app.kubernetes.io/name: opentelemetry-operator
app.kubernetes.io/version: "0.103.0"
app.kubernetes.io/managed-by: Helm
Expand Down Expand Up @@ -91,7 +91,7 @@ metadata:
annotations:
cert-manager.io/inject-ca-from: default/example-opentelemetry-operator-serving-cert
labels:
helm.sh/chart: opentelemetry-operator-0.64.0
helm.sh/chart: opentelemetry-operator-0.64.1
app.kubernetes.io/name: opentelemetry-operator
app.kubernetes.io/version: "0.103.0"
app.kubernetes.io/managed-by: Helm
Expand Down
4 changes: 2 additions & 2 deletions charts/opentelemetry-operator/examples/default/rendered/certmanager.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ apiVersion: cert-manager.io/v1
kind: Certificate
metadata:
labels:
helm.sh/chart: opentelemetry-operator-0.64.0
helm.sh/chart: opentelemetry-operator-0.64.1
app.kubernetes.io/name: opentelemetry-operator
app.kubernetes.io/version: "0.103.0"
app.kubernetes.io/managed-by: Helm
Expand All @@ -30,7 +30,7 @@ apiVersion: cert-manager.io/v1
kind: Issuer
metadata:
labels:
helm.sh/chart: opentelemetry-operator-0.64.0
helm.sh/chart: opentelemetry-operator-0.64.1
app.kubernetes.io/name: opentelemetry-operator
app.kubernetes.io/version: "0.103.0"
app.kubernetes.io/managed-by: Helm
Expand Down
6 changes: 3 additions & 3 deletions charts/opentelemetry-operator/examples/default/rendered/clusterrole.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
labels:
helm.sh/chart: opentelemetry-operator-0.64.0
helm.sh/chart: opentelemetry-operator-0.64.1
app.kubernetes.io/name: opentelemetry-operator
app.kubernetes.io/version: "0.103.0"
app.kubernetes.io/managed-by: Helm
Expand Down Expand Up @@ -223,7 +223,7 @@ apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
labels:
helm.sh/chart: opentelemetry-operator-0.64.0
helm.sh/chart: opentelemetry-operator-0.64.1
app.kubernetes.io/name: opentelemetry-operator
app.kubernetes.io/version: "0.103.0"
app.kubernetes.io/managed-by: Helm
Expand All @@ -242,7 +242,7 @@ apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
labels:
helm.sh/chart: opentelemetry-operator-0.64.0
helm.sh/chart: opentelemetry-operator-0.64.1
app.kubernetes.io/name: opentelemetry-operator
app.kubernetes.io/version: "0.103.0"
app.kubernetes.io/managed-by: Helm
Expand Down
4 changes: 2 additions & 2 deletions charts/opentelemetry-operator/examples/default/rendered/clusterrolebinding.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata:
labels:
helm.sh/chart: opentelemetry-operator-0.64.0
helm.sh/chart: opentelemetry-operator-0.64.1
app.kubernetes.io/name: opentelemetry-operator
app.kubernetes.io/version: "0.103.0"
app.kubernetes.io/managed-by: Helm
Expand All @@ -26,7 +26,7 @@ apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata:
labels:
helm.sh/chart: opentelemetry-operator-0.64.0
helm.sh/chart: opentelemetry-operator-0.64.1
app.kubernetes.io/name: opentelemetry-operator
app.kubernetes.io/version: "0.103.0"
app.kubernetes.io/managed-by: Helm
Expand Down
2 changes: 1 addition & 1 deletion charts/opentelemetry-operator/examples/default/rendered/deployment.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ apiVersion: apps/v1
kind: Deployment
metadata:
labels:
helm.sh/chart: opentelemetry-operator-0.64.0
helm.sh/chart: opentelemetry-operator-0.64.1
app.kubernetes.io/name: opentelemetry-operator
app.kubernetes.io/version: "0.103.0"
app.kubernetes.io/managed-by: Helm
Expand Down
2 changes: 1 addition & 1 deletion charts/opentelemetry-operator/examples/default/rendered/role.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ apiVersion: rbac.authorization.k8s.io/v1
kind: Role
metadata:
labels:
helm.sh/chart: opentelemetry-operator-0.64.0
helm.sh/chart: opentelemetry-operator-0.64.1
app.kubernetes.io/name: opentelemetry-operator
app.kubernetes.io/version: "0.103.0"
app.kubernetes.io/managed-by: Helm
Expand Down
2 changes: 1 addition & 1 deletion charts/opentelemetry-operator/examples/default/rendered/rolebinding.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ apiVersion: rbac.authorization.k8s.io/v1
kind: RoleBinding
metadata:
labels:
helm.sh/chart: opentelemetry-operator-0.64.0
helm.sh/chart: opentelemetry-operator-0.64.1
app.kubernetes.io/name: opentelemetry-operator
app.kubernetes.io/version: "0.103.0"
app.kubernetes.io/managed-by: Helm
Expand Down
4 changes: 2 additions & 2 deletions charts/opentelemetry-operator/examples/default/rendered/service.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ apiVersion: v1
kind: Service
metadata:
labels:
helm.sh/chart: opentelemetry-operator-0.64.0
helm.sh/chart: opentelemetry-operator-0.64.1
app.kubernetes.io/name: opentelemetry-operator
app.kubernetes.io/version: "0.103.0"
app.kubernetes.io/managed-by: Helm
Expand Down Expand Up @@ -32,7 +32,7 @@ apiVersion: v1
kind: Service
metadata:
labels:
helm.sh/chart: opentelemetry-operator-0.64.0
helm.sh/chart: opentelemetry-operator-0.64.1
app.kubernetes.io/name: opentelemetry-operator
app.kubernetes.io/version: "0.103.0"
app.kubernetes.io/managed-by: Helm
Expand Down
2 changes: 1 addition & 1 deletion charts/opentelemetry-operator/examples/default/rendered/serviceaccount.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ metadata:
name: opentelemetry-operator
namespace: default
labels:
helm.sh/chart: opentelemetry-operator-0.64.0
helm.sh/chart: opentelemetry-operator-0.64.1
app.kubernetes.io/name: opentelemetry-operator
app.kubernetes.io/version: "0.103.0"
app.kubernetes.io/managed-by: Helm
Expand Down
2 changes: 1 addition & 1 deletion ...s/opentelemetry-operator/examples/default/rendered/tests/test-certmanager-connection.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ metadata:
name: "example-opentelemetry-operator-cert-manager"
namespace: default
labels:
helm.sh/chart: opentelemetry-operator-0.64.0
helm.sh/chart: opentelemetry-operator-0.64.1
app.kubernetes.io/name: opentelemetry-operator
app.kubernetes.io/version: "0.103.0"
app.kubernetes.io/managed-by: Helm
Expand Down
4 changes: 2 additions & 2 deletions charts/opentelemetry-operator/examples/default/rendered/tests/test-service-connection.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ metadata:
name: "example-opentelemetry-operator-metrics"
namespace: default
labels:
helm.sh/chart: opentelemetry-operator-0.64.0
helm.sh/chart: opentelemetry-operator-0.64.1
app.kubernetes.io/name: opentelemetry-operator
app.kubernetes.io/version: "0.103.0"
app.kubernetes.io/managed-by: Helm
Expand Down Expand Up @@ -44,7 +44,7 @@ metadata:
name: "example-opentelemetry-operator-webhook"
namespace: default
labels:
helm.sh/chart: opentelemetry-operator-0.64.0
helm.sh/chart: opentelemetry-operator-0.64.1
app.kubernetes.io/name: opentelemetry-operator
app.kubernetes.io/version: "0.103.0"
app.kubernetes.io/managed-by: Helm
Expand Down
14 changes: 13 additions & 1 deletion charts/opentelemetry-operator/templates/prometheusrule.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ metadata:
{{- printf "%s: %s" $key (tpl $value $ | quote) | nindent 4 }}
{{- end }}
annotations:
{{- range $key, $value := .Values.manager.serviceMonitor.annotations }}
{{- range $key, $value := .Values.manager.prometheusRule.annotations }}
Copy link
Contributor

Choose a reason for hiding this comment

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

this is a bug fix right?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yes, noticed it while doing this pr.

{{- printf "%s: %s" $key (tpl $value $ | quote) | nindent 4 }}
{{- end }}
spec:
Expand All @@ -27,16 +27,28 @@ spec:
for: 5m
labels:
severity: warning
{{- with .Values.manager.prometheusRule.defaultRules.additionalRuleLabels }}
{{- toYaml . | nindent 8 }}
{{- end }}
annotations:
description: '{{`Reconciliation errors for {{ $labels.controller }} is increasing and has now reached {{ humanize $value }} `}}'
runbook_url: 'Check manager logs for reasons why this might happen'
{{- with .Values.manager.prometheusRule.defaultRules.additionalRuleAnnotations }}
{{- toYaml . | nindent 8 }}
{{- end }}
- alert: WorkqueueDepth
expr: workqueue_depth{name="opentelemetrycollector"} > 0
for: 5m
labels:
severity: warning
{{- with .Values.manager.prometheusRule.defaultRules.additionalRuleLabels }}
{{- toYaml . | nindent 8 }}
{{- end }}
annotations:
description: '{{`Queue depth for {{ $labels.name }} has reached {{ $value }} `}}'
runbook_url: 'Check manager logs for reasons why this might happen'
{{- with .Values.manager.prometheusRule.defaultRules.additionalRuleAnnotations }}
{{- toYaml . | nindent 8 }}
{{- end }}
{{- end }}
{{- end }}
37 changes: 31 additions & 6 deletions charts/opentelemetry-operator/values.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -855,9 +855,10 @@
"default": {},
"title": "The defaultRules Schema",
"required": [
"enabled"
"enabled",
"additionalRuleLabels",
"additionalRuleAnnotations"
],
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean",
Expand All @@ -866,10 +867,28 @@
"examples": [
false
]
},
"additionalRuleLabels": {
"type": "object",
"default": {},
"title": "The additionalRuleLabels Schema",
"required": [],
"properties": {},
"examples": [{}]
},
"additionalRuleAnnotations": {
"type": "object",
"default": {},
"title": "The additionalRuleAnnotations Schema",
"required": [],
"properties": {},
"examples": [{}]
}
},
"examples": [{
"enabled": false
"enabled": false,
"additionalRuleLabels": {},
"additionalRuleAnnotations": {}
}]
},
"extraLabels": {
Expand All @@ -893,7 +912,9 @@
"enabled": false,
"groups": [],
"defaultRules": {
"enabled": false
"enabled": false,
"additionalRuleLabels": {},
"additionalRuleAnnotations": {}
},
"extraLabels": {},
"annotations": {}
Expand Down Expand Up @@ -1124,7 +1145,9 @@
"enabled": false,
"groups": [],
"defaultRules": {
"enabled": false
"enabled": false,
"additionalRuleLabels": {},
"additionalRuleAnnotations": {}
},
"extraLabels": {},
"annotations": {}
Expand Down Expand Up @@ -1904,7 +1927,9 @@
"enabled": false,
"groups": [],
"defaultRules": {
"enabled": false
"enabled": false,
"additionalRuleLabels": {},
"additionalRuleAnnotations": {}
},
"extraLabels": {},
"annotations": {}
Expand Down
8 changes: 6 additions & 2 deletions charts/opentelemetry-operator/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,9 +124,13 @@ manager:
# Create default rules for monitoring the manager
defaultRules:
enabled: false
# additional labels on the PrometheusRule
## Additional labels for PrometheusRule alerts
additionalRuleLabels: {}
## Additional annotations for PrometheusRule alerts
additionalRuleAnnotations: {}
# additional labels on the PrometheusRule object
TylerHelmuth marked this conversation as resolved.
Show resolved Hide resolved
extraLabels: {}
# add annotations on the PrometheusRule
# add annotations on the PrometheusRule object
annotations: {}

# Whether the operator should create RBAC permissions for collectors. See README.md for more information.
Expand Down
Loading