Skip to content

Commit

Permalink
docs: update metrics info for site
Browse files Browse the repository at this point in the history
  • Loading branch information
googs1025 committed Jul 30, 2024
1 parent 08ee737 commit 49e89c5
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions site/content/en/docs/reference/metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ description: >
JobSet exposes [prometheus](https://prometheus.io) metrics to monitor the health
of the controller.

## Installation Examples

The following [example](https://github.com/kubernetes-sigs/jobset/tree/main/examples/prometheus-operator) show how to install the Prometheus Operator for JobSet system.

## JobSet controller health

Use the following metrics to monitor the health of the jobset controller:
Expand All @@ -19,3 +23,12 @@ Use the following metrics to monitor the health of the jobset controller:
| ----------- | ---- | ----------- | ------ |
| `controller_runtime_reconcile_errors_total` | Counter | The total number of reconciliation errors encountered by each controller. | `controller`: name of controller (i.e. use value `jobset` to obtain metrics for jobset controller) |
| `controller_runtime_reconcile_time_seconds` | Histogram | The latency of a reconciliation attempt in seconds. | `controller`: name of controller (i.e. use value `jobset` to obtain metrics for jobset controller) |

## JobSet metrics

Use the following metrics to monitor the health of the jobsets created by the jobset controller:

| Metric name | Type | Description | Labels |
|---------------------------------------------| ---- |---------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------|
| `jobset_failed_total` | Counter | The total number of failed JobSets. | `jobset_name`: name of jobset |
| `jobset_completed_total` | Counter | The total number of completed JobSets. | `jobset_name`: name of jobset |

0 comments on commit 49e89c5

Please sign in to comment.