metrics/schema.json at master · roadrunner-server/metrics · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
{
  "$id": "https://raw.githubusercontent.com/roadrunner-server/metrics/refs/heads/master/schema.json",
  "$schema": "https://json-schema.org/draft/2019-09/schema",
  "description": "All the valid configuration parameters for the Prometheus Metrics plugin for RoadRunner.",
  "type": "object",
  "title": "roadrunner-metrics",
  "additionalProperties": false,
  "properties": {
    "address": {
      "description": "Prometheus client address (path /metrics is appended automatically).",
      "type": "string",
      "default": "127.0.0.1:2112",
      "minLength": 1
    },
    "collect": {
      "description": "Application-specific metrics (published using an RPC connection to the server).",
      "type": "object",
      "additionalProperties": false,
      "minProperties": 1,
      "patternProperties": {
        "^[a-zA-Z_:][a-zA-Z0-9_:]*$": {
          "type": "object",
          "description": "The metrics to set up in Prometheus. See https://prometheus.io/docs/guides/go-application/ for details.",
          "additionalProperties": false,
          "properties": {
            "type": {
              "description": "The metric type to collect.",
              "type": "string",
              "enum": [
                "histogram",
                "gauge",
                "counter",
                "summary"
              ]
            },
            "namespace": {
              "type": "string",
              "description": "The collector's namespace."
            },
            "subsystem": {
              "type": "string",
              "description": "The collector's subsystem."
            },
            "help": {
              "type": "string",
              "description": "The collector's help message."
            },
            "labels": {
              "description": "The collector's metrics labels. These must be in the format supported by Prometheus. See https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels",
              "type": "array",
              "minItems": 1,
              "items": {
                "type": "string",
                "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$"
              }
            },
            "buckets": {
              "description": "The collector's buckets for the histogram type. Values must be in increasing order. The +Inf bucket is added implicitly at the end. If this array is undefined or empty, the default buckets are used.",
              "type": "array",
              "uniqueItems": true,
              "items": {
                "minimum": 0,
                "type": "number"
              },
              "default": [
                0.005,
                0.01,
                0.025,
                0.05,
                0.1,
                0.25,
                0.5,
                1,
                2.5,
                5,
                10
              ]
            },
            "objectives": {
              "description": "The collector's objectives for the summary type. Keys in this map must be a number between 0 and 1. The default value is an empty map, resulting in a summary without quantiles.",
              "type": "object",
              "additionalProperties": false,
              "patternProperties": {
                "^(0(\\.[0-9]+)?|1(\\.0+)?)$": {
                  "type": "number"
                }
              }
            }
          }
        }
      }
    }
  }
}