summaryrefslogtreecommitdiffstats
path: root/src/go/collectors/go.d.plugin/modules/openvpn/config_schema.json
blob: 0ad04b1dcb1cab28c0a70f1ab3228b7f02c2c417 (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
{
  "jsonSchema": {
    "$schema": "http://json-schema.org/draft-07/schema#",
    "title": "OpenVPN 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": "The IP address and port where the OpenVPN [Management Interface](https://openvpn.net/community-resources/management-interface/) listens for connections.",
        "type": "string",
        "default": "127.0.0.1:123"
      },
      "timeout": {
        "title": "Timeout",
        "description": "Timeout for establishing a connection and communication (reading and writing) in seconds.",
        "type": "number",
        "minimum": 0.5,
        "default": 1
      },
      "per_user_stats": {
        "title": "User selector",
        "description": "Configuration for monitoring specific users. If left empty, no user stats will be collected.",
        "type": "object",
        "properties": {
          "includes": {
            "title": "Include",
            "description": "Include users whose usernames match any of the specified inclusion [patterns](https://github.com/netdata/netdata/tree/master/src/go/collectors/go.d.plugin/pkg/matcher#readme).",
            "type": "array",
            "items": {
              "title": "Username pattern",
              "type": "string"
            },
            "uniqueItems": true
          },
          "excludes": {
            "title": "Exclude",
            "description": "Exclude users whose usernames match any of the specified exclusion [patterns](https://github.com/netdata/netdata/tree/master/src/go/collectors/go.d.plugin/pkg/matcher#readme).",
            "type": "array",
            "items": {
              "title": "Username pattern",
              "type": "string"
            },
            "uniqueItems": true
          }
        }
      }
    },
    "required": [
      "address"
    ]
  },
  "uiSchema": {
    "uiOptions": {
      "fullPage": true
    },
    "timeout": {
      "ui:help": "Accepts decimals for precise control (e.g., type 1.5 for 1.5 seconds)."
    },
    "per_user_stats": {
      "ui:help": "The logic for inclusion and exclusion is as follows: `(include1 OR include2) AND !(exclude1 OR exclude2)`."
    },
    "ui:flavour": "tabs",
    "ui:options": {
      "tabs": [
        {
          "title": "Base",
          "fields": [
            "update_every",
            "address",
            "timeout"
          ]
        },
        {
          "title": "User stats",
          "fields": [
            "per_user_stats"
          ]
        }
      ]
    }
  }
}