/docs/reference/Recent content in Reference on JobsetHugoen/docs/reference/metrics/Mon, 14 Feb 2022 00:00:00 +0000/docs/reference/metrics/<h2 id="prometheus-metrics">Prometheus Metrics</h2> <p>JobSet exposes <a href="https://prometheus.io">prometheus</a> metrics to monitor the health of the controller.</p> <h2 id="installation-examples">Installation Examples</h2> <p>The following <a href="https://github.com/kubernetes-sigs/jobset/tree/main/site/static/examples/prometheus-operator">example</a> show how to install the Prometheus Operator for JobSet system.</p> <h2 id="jobset-controller-health">JobSet controller health</h2> <p>Use the following metrics to monitor the health of the jobset controller:</p> <table> <thead> <tr> <th>Metric name</th> <th>Type</th> <th>Description</th> <th>Labels</th> </tr> </thead> <tbody> <tr> <td><code>controller_runtime_reconcile_errors_total</code></td> <td>Counter</td> <td>The total number of reconciliation errors encountered by each controller.</td> <td><code>controller</code>: name of controller (i.e. use value <code>jobset</code> to obtain metrics for jobset controller)</td> </tr> <tr> <td><code>controller_runtime_reconcile_time_seconds</code></td> <td>Histogram</td> <td>The latency of a reconciliation attempt in seconds.</td> <td><code>controller</code>: name of controller (i.e. use value <code>jobset</code> to obtain metrics for jobset controller)</td> </tr> </tbody> </table> <h2 id="jobset-metrics">JobSet metrics</h2> <p>Use the following metrics to monitor the health of the jobsets created by the jobset controller:</p>/docs/reference/jobset.v1alpha2/Mon, 01 Jan 0001 00:00:00 +0000/docs/reference/jobset.v1alpha2/<h2 id="resource-types">Resource Types</h2> <ul> <li><a href="/docs/reference/jobset.v1alpha2/#jobset-x-k8s-io-v1alpha2-JobSet">JobSet</a></li> </ul> <h2 id="jobset-x-k8s-io-v1alpha2-JobSet"><code>JobSet</code> </h2> <p><strong>Appears in:</strong></p> <p>JobSet is the Schema for the jobsets API</p> <table class="table"> <thead><tr><th width="30%">Field</th><th>Description</th></tr></thead> <tbody> <tr><td><code>apiVersion</code><br/>string</td><td><code>jobset.x-k8s.io/v1alpha2</code></td></tr> <tr><td><code>kind</code><br/>string</td><td><code>JobSet</code></td></tr> <tr><td><code>spec</code> <B>[Required]</B><br/> <a href="#jobset-x-k8s-io-v1alpha2-JobSetSpec"><code>JobSetSpec</code></a> </td> <td> <p>spec is the specification for jobset</p> </td> </tr> <tr><td><code>status</code> <B>[Required]</B><br/> <a href="#jobset-x-k8s-io-v1alpha2-JobSetStatus"><code>JobSetStatus</code></a> </td> <td> <p>status is the status of the jobset</p> </td> </tr> </tbody> </table> <h2 id="jobset-x-k8s-io-v1alpha2-Coordinator"><code>Coordinator</code> </h2> <p><strong>Appears in:</strong></p> <ul> <li><a href="/docs/reference/jobset.v1alpha2/#jobset-x-k8s-io-v1alpha2-JobSetSpec">JobSetSpec</a></li> </ul> <p>Coordinator defines which pod can be marked as the coordinator for the JobSet workload.</p> <table class="table"> <thead><tr><th width="30%">Field</th><th>Description</th></tr></thead> <tbody> <tr><td><code>replicatedJob</code> <B>[Required]</B><br/> <code>string</code> </td> <td> <p>replicatedJob is the name of the ReplicatedJob which contains the coordinator pod.</p>