summaryrefslogtreecommitdiffstats
path: root/src/go/collectors/go.d.plugin/modules/postgres/config_schema.json
blob: 42bff329b55b5eeec87ef662734a3040193739fd (plain)
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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
{
  "jsonSchema": {
    "$schema": "http://json-schema.org/draft-07/schema#",
    "title": "Postgres collector configuration.",
    "type": "object",
    "properties": {
      "update_every": {
        "title": "Update every",
        "description": "Data collection interval, measured in seconds.",
        "type": "integer",
        "minimum": 1,
        "default": 1
      },
      "dsn": {
        "title": "DSN",
        "description": "Postgres server Data Source Name in [key/value string](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING-KEYWORD-VALUE) or [URI](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING-URIS) format.",
        "type": "string",
        "default": "postgres://netdata:password@127.0.0.1:5432/postgres"
      },
      "timeout": {
        "title": "Timeout",
        "description": "Timeout for queries, in seconds.",
        "type": "number",
        "minimum": 0.5,
        "default": 2
      },
      "collect_databases_matching": {
        "title": "Database selector",
        "description": "Configuration for monitoring specific databases using [Netdata simple patterns](https://github.com/netdata/netdata/tree/master/src/libnetdata/simple_pattern#readme). If left empty, no database metrics will be collected.",
        "type": "string"
      },
      "max_db_tables": {
        "title": "Table limit",
        "description": "Table metrics will not be collected for databases that have more tables than the limit. Set to 0 for no limit.",
        "type": "integer",
        "minimum": 0,
        "default": 50
      },
      "max_db_indexes": {
        "title": "Index limit",
        "description": "Index metrics will not be collected for databases that have more indexes than the limit. Set to 0 for no limit.",
        "type": "integer",
        "minimum": 0,
        "default": 250
      },
      "transaction_time_histogram": {
        "title": "Transaction time histogram",
        "description": "Buckets for transaction time histogram in milliseconds.",
        "type": [
          "array",
          "null"
        ],
        "items": {
          "title": "Bucket",
          "type": "number",
          "exclusiveMinimum": 0
        },
        "uniqueItems": true,
        "default": [
          0.1,
          0.5,
          1,
          2.5,
          5,
          10
        ]
      },
      "query_time_histogram": {
        "title": "Query time histogram",
        "description": "Buckets for query time histogram in milliseconds.",
        "type": [
          "array",
          "null"
        ],
        "items": {
          "title": "Bucket",
          "type": "number",
          "exclusiveMinimum": 0
        },
        "uniqueItems": true,
        "default": [
          0.1,
          0.5,
          1,
          2.5,
          5,
          10
        ]
      }
    },
    "required": [
      "dsn"
    ],
    "additionalProperties": false,
    "patternProperties": {
      "^name$": {}
    }
  },
  "uiSchema": {
    "uiOptions": {
      "fullPage": true
    },
    "ui:flavour": "tabs",
    "ui:options": {
      "tabs": [
        {
          "title": "Base",
          "fields": [
            "update_every",
            "dsn",
            "timeout"
          ]
        },
        {
          "title": "Database stats",
          "fields": [
            "max_db_tables",
            "max_db_indexes",
            "collect_databases_matching"
          ]
        },
        {
          "title": "Histograms",
          "fields": [
            "transaction_time_histogram",
            "query_time_histogram"
          ]
        }
      ]
    },
    "dsn": {
      "ui:placeholder": "postgres://username:password@host:port/dbname"
    },
    "transaction_time_histogram": {
      "ui:listFlavour": "list"
    },
    "query_time_histogram": {
      "ui:listFlavour": "list"
    }
  }
}