Argo Workflows · Schema

io.argoproj.workflow.v1alpha1.Prometheus

Prometheus is a prometheus metric to be emitted

CNCFContainersData ProcessingKubernetesMachine LearningOpen SourceWorkflow Engine

Properties

Name Type Description
counter object Counter is a counter metric
gauge object Gauge is a gauge metric
help string Help is a string that describes the metric
histogram object Histogram is a histogram metric
labels array Labels is a list of metric labels
name string Name is the name of the metric
when string When is a conditional statement that decides when to emit the metric
View JSON Schema on GitHub

JSON Schema

argo-workflows-io-argoproj-workflow-v1alpha1-prometheus-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/argo-workflows/refs/heads/main/json-schema/argo-workflows-io-argoproj-workflow-v1alpha1-prometheus-schema.json",
  "title": "io.argoproj.workflow.v1alpha1.Prometheus",
  "description": "Prometheus is a prometheus metric to be emitted",
  "type": "object",
  "properties": {
    "counter": {
      "description": "Counter is a counter metric",
      "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Counter"
    },
    "gauge": {
      "description": "Gauge is a gauge metric",
      "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Gauge"
    },
    "help": {
      "description": "Help is a string that describes the metric",
      "type": "string"
    },
    "histogram": {
      "description": "Histogram is a histogram metric",
      "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Histogram"
    },
    "labels": {
      "description": "Labels is a list of metric labels",
      "type": "array",
      "items": {
        "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.MetricLabel"
      }
    },
    "name": {
      "description": "Name is the name of the metric",
      "type": "string"
    },
    "when": {
      "description": "When is a conditional statement that decides when to emit the metric",
      "type": "string"
    }
  },
  "required": [
    "name",
    "help"
  ]
}