summaryrefslogtreecommitdiffstats
path: root/src/go/collectors/go.d.plugin/modules/x509check/config_schema.json
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--src/go/collectors/go.d.plugin/modules/x509check/config_schema.json114
1 files changed, 114 insertions, 0 deletions
diff --git a/src/go/collectors/go.d.plugin/modules/x509check/config_schema.json b/src/go/collectors/go.d.plugin/modules/x509check/config_schema.json
new file mode 100644
index 000000000..7246cfa7a
--- /dev/null
+++ b/src/go/collectors/go.d.plugin/modules/x509check/config_schema.json
@@ -0,0 +1,114 @@
+{
+ "jsonSchema": {
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "title": "X509Check collector configuration.",
+ "type": "object",
+ "properties": {
+ "update_every": {
+ "title": "Update every",
+ "description": "Data collection interval, measured in seconds.",
+ "type": "integer",
+ "minimum": 1,
+ "default": 1
+ },
+ "source": {
+ "title": "Certificate source",
+ "description": "The source of the certificate. Allowed schemes: https, tcp, tcp4, tcp6, udp, udp4, udp6, file, smtp.",
+ "type": "string"
+ },
+ "timeout": {
+ "title": "Timeout",
+ "description": "The timeout in seconds for the certificate retrieval.",
+ "type": "number",
+ "minimum": 0.5,
+ "default": 1
+ },
+ "check_revocation_status": {
+ "title": "Revocation status check",
+ "description": "Whether to check the revocation status of the certificate.",
+ "type": "boolean"
+ },
+ "days_until_expiration_warning": {
+ "title": "Days until warning",
+ "description": "Number of days before the alarm status is set to warning.",
+ "type": "integer",
+ "minimum": 1,
+ "default": 14
+ },
+ "days_until_expiration_critical": {
+ "title": "Days until critical",
+ "description": "Number of days before the alarm status is set to critical.",
+ "type": "integer",
+ "minimum": 1,
+ "default": 7
+ },
+ "tls_skip_verify": {
+ "title": "Skip TLS verification",
+ "description": "If set, TLS certificate verification will be skipped.",
+ "type": "boolean"
+ },
+ "tls_ca": {
+ "title": "TLS CA",
+ "description": "The path to the CA certificate file for TLS verification.",
+ "type": "string",
+ "pattern": "^$|^/"
+ },
+ "tls_cert": {
+ "title": "TLS certificate",
+ "description": "The path to the client certificate file for TLS authentication.",
+ "type": "string",
+ "pattern": "^$|^/"
+ },
+ "tls_key": {
+ "title": "TLS key",
+ "description": "The path to the client key file for TLS authentication.",
+ "type": "string",
+ "pattern": "^$|^/"
+ }
+ },
+ "required": [
+ "source"
+ ],
+ "additionalProperties": false,
+ "patternProperties": {
+ "^name$": {}
+ }
+ },
+ "uiSchema": {
+ "uiOptions": {
+ "fullPage": true
+ },
+ "source": {
+ "ui:placeholder": "https://example.com:443",
+ "ui:help": " Website: `https://domainName:443`. Local file: `file:///path/to/cert.pem`. SMTP: `smtp://smtp.example.com:587`."
+ },
+ "timeout": {
+ "ui:help": "Accepts decimals for precise control (e.g., type 1.5 for 1.5 seconds)."
+ },
+ "ui:flavour": "tabs",
+ "ui:options": {
+ "tabs": [
+ {
+ "title": "Base",
+ "fields": [
+ "update_every",
+ "source",
+ "timeout",
+ "check_revocation_status",
+ "days_until_expiration_warning",
+ "days_until_expiration_critical"
+ ]
+ },
+ {
+ "title": "TLS",
+ "fields": [
+ "tls_skip_verify",
+ "tls_ca",
+ "tls_cert",
+ "tls_key"
+ ]
+ }
+ ]
+ }
+ }
+}