feat(helm): observability support (ArcadeDB 26.7.1, #4463) #12
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 |
|---|---|---|
|
|
@@ -144,6 +144,11 @@ Create a comma separated list of plugins to be enabled in arcadedb | |
| {{- $params = append $params (printf "-Darcadedb.redis.port=%d" (int $config.port)) -}} | ||
| {{- else if eq $plugin "prometheus" -}} | ||
| {{- $plugins = append $plugins "Prometheus:com.arcadedb.metrics.prometheus.PrometheusMetricsPlugin" -}} | ||
| {{- with $.Values.arcadedb.plugins.prometheus -}} | ||
| {{- if hasKey . "requireAuthentication" -}} | ||
| {{- $params = append $params (printf "-Darcadedb.serverMetrics.prometheus.requireAuthentication=%v" .requireAuthentication) -}} | ||
| {{- end -}} | ||
| {{- end -}} | ||
| {{- else -}} | ||
| {{- $plugins = append $plugins (printf "%s:%s" $plugin $config.class) -}} | ||
| {{- end -}} | ||
|
|
@@ -170,3 +175,71 @@ Create service configuration for the enabled plugins | |
| {{- end -}} | ||
| {{- end -}} | ||
| {{- end -}} | ||
|
|
||
| {{/* | ||
| Observability -D JVM args (logging, OTLP metrics, tracing, readiness). | ||
| All opt-in; emits nothing when defaults are unchanged. | ||
| */}} | ||
| {{- define "arcadedb.observability.args" -}} | ||
| {{- $o := .Values.observability | default dict -}} | ||
| {{- $logging := $o.logging | default dict -}} | ||
| {{- $otlp := (($o.metrics | default dict).otlp) | default dict -}} | ||
| {{- $tracing := $o.tracing | default dict -}} | ||
| {{- $health := $o.health | default dict -}} | ||
| {{- if eq $logging.format "json" }} | ||
| - -Darcadedb.server.logFormat=json | ||
| {{- end }} | ||
| {{- if $logging.includeTrace }} | ||
| - -Darcadedb.server.logIncludeTrace=true | ||
| {{- end }} | ||
| {{- if $otlp.enabled }} | ||
| - -Darcadedb.serverMetrics.otlp.enabled=true | ||
| - -Darcadedb.serverMetrics.otlp.endpoint={{ $otlp.endpoint }} | ||
| {{- end }} | ||
| {{- if $tracing.enabled }} | ||
| - -Darcadedb.serverMetrics.tracing.enabled=true | ||
| - -Darcadedb.serverMetrics.tracing.endpoint={{ $tracing.endpoint }} | ||
| - -Darcadedb.serverMetrics.tracing.samplingRate={{ $tracing.samplingRate }} | ||
| {{- end }} | ||
| {{- if $health.readinessRequiresHA }} | ||
| - -Darcadedb.server.readinessRequiresHA=true | ||
| {{- end }} | ||
| {{- end -}} | ||
|
|
||
| {{/* | ||
| Guard: scrape discovery (ServiceMonitor or pod annotations) needs the | ||
| prometheus plugin so /prometheus is actually served. | ||
| */}} | ||
| {{- define "arcadedb.observability.validate" -}} | ||
| {{- $p := (((.Values.observability | default dict).metrics | default dict).prometheus) | default dict -}} | ||
| {{- $serviceMonitor := $p.serviceMonitor | default dict -}} | ||
| {{- $podAnnotations := $p.podAnnotations | default dict -}} | ||
| {{- if or $serviceMonitor.enabled $podAnnotations.enabled -}} | ||
| {{- $promEnabled := false -}} | ||
| {{- with .Values.arcadedb.plugins.prometheus -}} | ||
| {{- if .enabled -}}{{- $promEnabled = true -}}{{- end -}} | ||
| {{- end -}} | ||
| {{- if not $promEnabled -}} | ||
| {{- fail "observability.metrics.prometheus serviceMonitor/podAnnotations require arcadedb.plugins.prometheus.enabled=true (the /prometheus endpoint must be served)" -}} | ||
| {{- end -}} | ||
| {{- end -}} | ||
| {{- end -}} | ||
|
Comment on lines
+213
to
+226
There was a problem hiding this comment. The validation helper
Contributor
Author
There was a problem hiding this comment. Addressed in 9e17bbb — |
||
|
|
||
| {{/* | ||
| Merge user-supplied podAnnotations with computed prometheus.io/* scrape | ||
| annotations. Returns YAML (possibly empty). | ||
| */}} | ||
| {{- define "arcadedb.podAnnotations" -}} | ||
| {{- $annotations := deepCopy (default dict .Values.podAnnotations) -}} | ||
| {{- $pa := (((((.Values.observability | default dict).metrics | default dict).prometheus) | default dict).podAnnotations) | default dict -}} | ||
| {{- if $pa.enabled -}} | ||
| {{- $port := int .Values.service.http.port -}} | ||
| {{- if $pa.port -}}{{- $port = int $pa.port -}}{{- end -}} | ||
| {{- $_ := set $annotations "prometheus.io/scrape" "true" -}} | ||
| {{- $_ := set $annotations "prometheus.io/port" (printf "%d" $port) -}} | ||
| {{- $_ := set $annotations "prometheus.io/path" (default "/prometheus" $pa.path) -}} | ||
| {{- end -}} | ||
| {{- if $annotations -}} | ||
| {{- toYaml $annotations -}} | ||
| {{- end -}} | ||
| {{- end -}} | ||
|
Comment on lines
+232
to
+245
There was a problem hiding this comment. The helper
Contributor
Author
There was a problem hiding this comment. Addressed in 9e17bbb — |
||
This file contains hidden or 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 hidden or 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,50 @@ | ||
| {{- $sm := (((((.Values.observability | default dict).metrics | default dict).prometheus) | default dict).serviceMonitor) | default dict -}} | ||
| {{- if $sm.enabled }} | ||
| {{- include "arcadedb.observability.validate" . -}} | ||
| {{- $basicAuth := $sm.basicAuth | default dict -}} | ||
| {{- if and $basicAuth.enabled (not $basicAuth.secretName) -}} | ||
| {{- fail "serviceMonitor.basicAuth.enabled requires basicAuth.secretName (a secret with username + password keys)" -}} | ||
| {{- end -}} | ||
| apiVersion: monitoring.coreos.com/v1 | ||
| kind: ServiceMonitor | ||
| metadata: | ||
| name: {{ include "arcadedb.fullname" . }} | ||
| labels: | ||
| {{- include "arcadedb.labels" . | nindent 4 }} | ||
| {{- with $sm.labels }} | ||
| {{- toYaml . | nindent 4 }} | ||
| {{- end }} | ||
| {{- with $sm.annotations }} | ||
| annotations: | ||
| {{- toYaml . | nindent 4 }} | ||
| {{- end }} | ||
| spec: | ||
| selector: | ||
| matchLabels: | ||
| {{- include "arcadedb.selectorLabels" . | nindent 6 }} | ||
| app.kubernetes.io/component: http | ||
| endpoints: | ||
| - port: http | ||
| path: {{ $sm.path }} | ||
| interval: {{ $sm.interval }} | ||
| {{- with $sm.scrapeTimeout }} | ||
| scrapeTimeout: {{ . }} | ||
| {{- end }} | ||
| {{- if $basicAuth.enabled }} | ||
| basicAuth: | ||
| username: | ||
| name: {{ $basicAuth.secretName }} | ||
| key: {{ $basicAuth.usernameKey }} | ||
| password: | ||
| name: {{ $basicAuth.secretName }} | ||
| key: {{ $basicAuth.passwordKey }} | ||
| {{- end }} | ||
| {{- with $sm.relabelings }} | ||
| relabelings: | ||
| {{- toYaml . | nindent 8 }} | ||
| {{- end }} | ||
| {{- with $sm.metricRelabelings }} | ||
| metricRelabelings: | ||
| {{- toYaml . | nindent 8 }} | ||
| {{- end }} | ||
| {{- end }} |
This file contains hidden or 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 hidden or 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.
The helper
arcadedb.observability.argsdirectly accesses nested keys under.Values.observability(such as.Values.observability.logging.formatand.Values.observability.metrics.otlp.enabled) without checking if the parent keys exist. If a user provides a custom values file that partially overrides or completely omits theobservabilitysection, Helm will throw a nil pointer evaluation error (e.g.,nil pointer evaluating interface {}). Usingdefault dictto safely navigate these nested maps prevents rendering crashes.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.
Verified this empirically before applying. The stated trigger — partially overriding or omitting the
observabilitysection — does not panic: Helm coalesces user values over the chart'svalues.yamldefaults, so omitted/partially-set keys retain their defaults (helm template -fwith onlyobservability.metrics.otlp.enabled: truerenders fine, exit 0; the unit suite also sets partial observability keys and passes).The real failure mode is explicitly nulling a map, e.g.
--set observability=nullor--set observability.logging=null, which does dereference nil. That's a genuine crash, so I've applied nil-safe navigation (| default dict) to this helper and the other three sites, plus regression tests covering the explicit-null case.Fixed in 9e17bbb.