summaryrefslogtreecommitdiffstats
path: root/src/go/collectors/go.d.plugin/modules/docker/config_schema.json
blob: bd48c91262de07c927111ad4ac0c99b81e00c1cd (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
{
  "jsonSchema": {
    "$schema": "http://json-schema.org/draft-07/schema#",
    "title": "Docker collector configuration.",
    "type": "object",
    "properties": {
      "update_every": {
        "title": "Update every",
        "description": "Data collection interval, measured in seconds.",
        "type": "integer",
        "minimum": 1,
        "default": 1
      },
      "address": {
        "title": "Address",
        "description": "Docker daemon's Unix or TCP (listening address) socket.",
        "type": "string",
        "default": "unix:///var/run/docker.sock"
      },
      "timeout": {
        "title": "Timeout",
        "description": "Timeout for establishing a connection and communication (reading and writing) in seconds.",
        "type": "number",
        "default": 2
      },
      "collect_container_size": {
        "title": "Collect container size",
        "description": "Collect container writable layer size.",
        "type": "boolean",
        "default": false
      }
    },
    "required": [
      "address"
    ],
    "additionalProperties": false,
    "patternProperties": {
      "^name$": {}
    }
  },
  "uiSchema": {
    "uiOptions": {
      "fullPage": true
    },
    "address": {
      "ui:help": "Use `unix://{path_to_socket}` for Unix socket or `tcp://{ip}:{port}` for TCP socket."
    },
    "timeout": {
      "ui:help": "Accepts decimals for precise control (e.g., type 1.5 for 1.5 seconds)."
    }
  }
}