(feat) extend health checks by adding metric support#1816
Merged
Conversation
ValidateHealth now supports metric-based checks via a new MetricSource
field. The addon-controller (push mode) or the sveltos-applier agent
running inside the managed cluster (pull mode) queries a
Prometheus-compatible endpoint, collects named scalar values, and
exposes them to a Lua script through a global `metrics` table.
In push mode the MetricSource URL must be reachable from the management
cluster. In pull mode the agent running inside the managed cluster
reaches the metric service directly via its in-cluster DNS name.
Example:
```yaml
validateHealths:
- name: error-rate-low
featureID: Helm
metricSource:
url: http://prometheus-server.monitoring.svc:9090
metricQueries:
- name: errorRate
query: >-
sum(rate(http_requests_errors_total{namespace="my-app"}[5m]))
/
sum(rate(http_requests_total{namespace="my-app"}[5m]))
script: |
function evaluate()
if metrics["errorRate"] > 0.05 then
return {healthy=false, message="error rate above 5%: " .. metrics["errorRate"]}
end
return {healthy=true, message=""}
end
```
ValidateHealths are skipped during ClusterSummary deletion so that
health checks do not block resource teardown when the managed workloads
are already gone.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
ValidateHealth now supports metric-based checks via a new MetricSource field. The addon-controller (push mode) or the sveltos-applier agent running inside the managed cluster (pull mode) queries a Prometheus-compatible endpoint, collects named scalar values, and exposes them to a Lua script through a global
metricstable.In push mode the MetricSource URL must be reachable from the management cluster. In pull mode the agent running inside the managed cluster reaches the metric service directly via its in-cluster DNS name.
Example:
ValidateHealths are skipped during ClusterSummary deletion so that health checks do not block resource teardown when the managed workloads are already gone.