Argo Workflows · JSON Structure

Argo Workflows Io Argoproj Workflow V1Alpha1 Prometheus Structure

Prometheus is a prometheus metric to be emitted

Type: object Properties: 7 Required: 2
CNCFContainersData ProcessingKubernetesMachine LearningOpen SourceWorkflow Engine

io.argoproj.workflow.v1alpha1.Prometheus is a JSON Structure definition published by Argo Workflows, describing 7 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

counter gauge help histogram labels name when

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/argo-workflows/refs/heads/main/json-structure/argo-workflows-io-argoproj-workflow-v1alpha1-prometheus-structure.json",
  "name": "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"
  ]
}