master
json 156 lines 4.97 KB
Raw
1 {
2 "jsonSchema": {
3 "$schema": "http://json-schema.org/draft-07/schema#",
4 "title": "OracleDB collector configuration.",
5 "type": "object",
6 "properties": {
7 "update_every": {
8 "title": "Update every",
9 "description": "Data collection interval, measured in seconds.",
10 "type": "integer",
11 "minimum": 1,
12 "default": 1
13 },
14 "autodetection_retry": {
15 "title": "Detection retry",
16 "description": "Recheck interval in seconds. Zero means no recheck will be scheduled.",
17 "type": "integer",
18 "minimum": 0,
19 "default": 60
20 },
21 "dsn": {
22 "title": "DSN",
23 "description": "Oracle server Data Source Name specifying the connection details.",
24 "type": "string",
25 "default": ""
26 },
27 "timeout": {
28 "title": "Timeout",
29 "description": "Query timeout, in seconds.",
30 "type": "number",
31 "minimum": 0.5,
32 "default": 1
33 },
34 "vnode": {
35 "title": "Vnode",
36 "description": "Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes).",
37 "type": "string"
38 },
39 "functions": {
40 "title": "Functions",
41 "description": "Configuration for Netdata functions exposed by this collector.",
42 "type": "object",
43 "properties": {
44 "top_queries": {
45 "title": "Top Queries",
46 "description": "Configuration for the top-queries function.",
47 "type": "object",
48 "properties": {
49 "disabled": {
50 "title": "Disabled",
51 "description": "Disable the top-queries function.",
52 "type": "boolean",
53 "default": false
54 },
55 "timeout": {
56 "title": "Timeout",
57 "description": "Query timeout in seconds. Set to 0 to use the collector's timeout.",
58 "type": "number",
59 "minimum": 0
60 },
61 "limit": {
62 "title": "Limit",
63 "description": "Maximum number of queries to return. Set to 0 to use the default (500).",
64 "type": "integer",
65 "minimum": 0,
66 "maximum": 5000,
67 "default": 500
68 }
69 }
70 },
71 "running_queries": {
72 "title": "Running Queries",
73 "description": "Configuration for the running-queries function.",
74 "type": "object",
75 "properties": {
76 "disabled": {
77 "title": "Disabled",
78 "description": "Disable the running-queries function.",
79 "type": "boolean",
80 "default": false
81 },
82 "timeout": {
83 "title": "Timeout",
84 "description": "Query timeout in seconds. Set to 0 to use the collector's timeout.",
85 "type": "number",
86 "minimum": 0
87 },
88 "limit": {
89 "title": "Limit",
90 "description": "Maximum number of queries to return. Set to 0 to use the default (500).",
91 "type": "integer",
92 "minimum": 0,
93 "maximum": 5000,
94 "default": 500
95 }
96 }
97 }
98 }
99 }
100 },
101 "required": [
102 "dsn"
103 ]
104 },
105 "uiSchema": {
106 "uiOptions": {
107 "fullPage": true
108 },
109 "ui:flavour": "tabs",
110 "ui:options": {
111 "tabs": [
112 {
113 "title": "Base",
114 "fields": [
115 "update_every",
116 "autodetection_retry",
117 "dsn",
118 "timeout",
119 "vnode"
120 ]
121 },
122 {
123 "title": "Functions",
124 "fields": [
125 "functions"
126 ]
127 }
128 ]
129 },
130 "vnode": {
131 "ui:placeholder": "To use this option, first create a Virtual Node and then reference its name here."
132 },
133 "autodetection_retry": {
134 "ui:help": "This option determines how frequently (in seconds) Netdata will retry data collection jobs that failed initially, with the value of 60 meaning it retries to start data collection jobs every 60 seconds, while setting it to 0 disables this retry mechanism entirely."
135 },
136 "dsn": {
137 "ui:help": "Format is `oracle://username:password@host:port/service`.",
138 "ui:placeholder": "oracle://username:password@host:port/service?param1=value1&...&paramN=valueN"
139 },
140 "timeout": {
141 "ui:help": "Accepts decimals for precise control (e.g., type 1.5 for 1.5 seconds)."
142 },
143 "functions": {
144 "top_queries": {
145 "disabled": {
146 "ui:help": "WARNING: Query text may contain unmasked sensitive literals (PII)."
147 }
148 },
149 "running_queries": {
150 "disabled": {
151 "ui:help": "WARNING: Query text may contain unmasked sensitive literals (PII)."
152 }
153 }
154 }
155 }
156 }