summaryrefslogtreecommitdiffstats
path: root/integrations/schemas
diff options
context:
space:
mode:
Diffstat (limited to 'integrations/schemas')
-rw-r--r--integrations/schemas/categories.json55
-rw-r--r--integrations/schemas/collector.json411
-rw-r--r--integrations/schemas/deploy.json116
-rw-r--r--integrations/schemas/distros.json153
-rw-r--r--integrations/schemas/exporter.json63
-rw-r--r--integrations/schemas/notification.json87
-rw-r--r--integrations/schemas/shared.json327
7 files changed, 1212 insertions, 0 deletions
diff --git a/integrations/schemas/categories.json b/integrations/schemas/categories.json
new file mode 100644
index 00000000..9ebb852f
--- /dev/null
+++ b/integrations/schemas/categories.json
@@ -0,0 +1,55 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "type": "array",
+ "title": "Category information for integrations.",
+ "items": {
+ "$ref": "#/$defs/category"
+ },
+ "$defs": {
+ "category": {
+ "type": "object",
+ "description": "An entry for a single category.",
+ "properties": {
+ "id": {
+ "$ref": "./shared.json#/$defs/id"
+ },
+ "name": {
+ "type": "string",
+ "minLength": 1,
+ "description": "The display name for the category."
+ },
+ "description": {
+ "type": "string",
+ "description": "A description of the category."
+ },
+ "most_popular": {
+ "type": "boolean",
+ "description": "Indicates if the category should show up in the initial list of categories, or only in the full expanded list."
+ },
+ "priority": {
+ "type": "integer",
+ "description": "Indicates sort order for categories that are marked as most popular."
+ },
+ "collector_default": {
+ "type": "boolean",
+ "description": "Indicates that the category should be added to collector integrations that list no categories."
+ },
+ "children": {
+ "type": "array",
+ "description": "A list of categories that are children of this category.",
+ "items": {
+ "$ref": "#/$defs/category"
+ }
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "description",
+ "most_popular",
+ "priority",
+ "children"
+ ]
+ }
+ }
+}
diff --git a/integrations/schemas/collector.json b/integrations/schemas/collector.json
new file mode 100644
index 00000000..ba5d9f9d
--- /dev/null
+++ b/integrations/schemas/collector.json
@@ -0,0 +1,411 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "type": "object",
+ "title": "Netdata agent collector metadata.",
+ "properties": {
+ "plugin_name": {
+ "type": "string"
+ },
+ "modules": {
+ "description": "A list of module templates",
+ "items": {
+ "type": "object",
+ "properties": {
+ "meta": {
+ "type": "object",
+ "properties": {
+ "plugin_name": {
+ "type": "string",
+ "description": "Plugin name (e.g. apps.plugin, proc.plugin, go.d.plugin). It must match the name of the executable file in the plugins.d directory."
+ },
+ "module_name": {
+ "type": "string",
+ "description": "Module name (e.g. apache, /proc/stat, httpcheck). It usually has the same name as the module configuration file (external plugin) or the section name in netdata.conf (internal plugin)."
+ },
+ "monitored_instance": {
+ "$ref": "./shared.json#/$defs/instance"
+ },
+ "keywords": {
+ "$ref": "./shared.json#/$defs/keywords"
+ },
+ "related_resources": {
+ "type": "object",
+ "description": "Available related resources for the monitored instance.",
+ "properties": {
+ "integrations": {
+ "type": "object",
+ "description": "All collectors that provide additional metrics for the monitored instance. This may include generic collectors, e.g. 'httpcheck' for web servers to monitor specific endpoints.",
+ "properties": {
+ "list": {
+ "type": "array",
+ "description": "List of related integrations.",
+ "items": {
+ "type": "object",
+ "properties": {
+ "plugin_name": {
+ "type": "string",
+ "description": "Related integration plugin name."
+ },
+ "module_name": {
+ "type": "string",
+ "description": "Related integration module name."
+ }
+ },
+ "required": [
+ "plugin_name",
+ "module_name"
+ ]
+ }
+ }
+ },
+ "required": [
+ "list"
+ ]
+ }
+ },
+ "required": [
+ "integrations"
+ ]
+ },
+ "info_provided_to_referring_integrations": {
+ "type": "object",
+ "description": "Information that this collector can provide about itself when other integrations mention it. This text will not be appear on this collector's page.",
+ "properties": {
+ "description": {
+ "type": "string",
+ "description": "TODO"
+ }
+ },
+ "required": [
+ "description"
+ ]
+ },
+ "most_popular": {
+ "type": "boolean",
+ "description": "Whether or not the integration is to be flagged as most-popular, meaning it will show up at the top of the menu."
+ },
+ "community": {
+ "type": "boolean",
+ "description": "Whether or not the integration should be flagged as community."
+ }
+ },
+ "required": [
+ "plugin_name",
+ "module_name",
+ "monitored_instance",
+ "keywords",
+ "related_resources",
+ "info_provided_to_referring_integrations",
+ "most_popular"
+ ]
+ },
+ "overview": {
+ "type": "object",
+ "properties": {
+ "data_collection": {
+ "type": "object",
+ "description": "An overview of the collected metrics and a detailed description of the data collection method.",
+ "properties": {
+ "metrics_description": {
+ "type": "string",
+ "description": "Brief description of what metrics are collected. A suggested approach here is to talk about the areas covered (e.g. health, performance, errors) and the metric scopes."
+ },
+ "method_description": {
+ "type": "string",
+ "description": "Description of how metrics are collected (e.g. HTTP requests, establish a TCP connection and send a command, a specific binary execution). A suggested approach here is to provide a detailed description of how the collector gathers metrics: how many connections are established, exact requests/commands executed, exact endpoints used."
+ }
+ },
+ "required": [
+ "metrics_description",
+ "method_description"
+ ]
+ },
+ "supported_platforms": {
+ "type": "object",
+ "description": "Supported OS/platforms. By default, all platforms supported by Netdata are considered supported. See https://learn.netdata.cloud/docs/installing/platform-support-policy#currently-supported-platforms.",
+ "properties": {
+ "include": {
+ "type": "array",
+ "description": "Only supported OS/platforms. Platforms supported by Netdata will be ignored, only those listed are considered supported.",
+ "items": {
+ "type": "string",
+ "minLength": 2
+ }
+ },
+ "exclude": {
+ "type": "array",
+ "description": "Unsupported OS/platforms. The result set is all platforms supported by Netdata except for those excluded.",
+ "items": {
+ "type": "string",
+ "minLength": 2
+ }
+ }
+ },
+ "required": [
+ "include",
+ "exclude"
+ ]
+ },
+ "multi_instance": {
+ "type": "boolean",
+ "description": "Whether this collector supports collecting metrics from multiple (for example, local and remote) instances."
+ },
+ "additional_permissions": {
+ "type": "object",
+ "description": "Information about additional permissions other than those required by the Netdata process (e.g. setuid, specific Linux capabilities).",
+ "properties": {
+ "description": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "description"
+ ]
+ },
+ "default_behavior": {
+ "type": "object",
+ "description": "Descriptions of how the data collector works with the default configuration.",
+ "properties": {
+ "auto_detection": {
+ "type": "object",
+ "description": "Information about detecting (discovering) monitored instances with default configuration. Example: tries to connect to Apache running on localhost on ports 80, 443 and 8080.",
+ "properties": {
+ "description": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "description"
+ ]
+ },
+ "limits": {
+ "type": "object",
+ "description": "Information about limiting data collection, taking into account the default values of any configuration settings that restrict data collection (including filtering metrics).",
+ "properties": {
+ "description": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "description"
+ ]
+ },
+ "performance_impact": {
+ "type": "object",
+ "description": "Information about the known impact on the performance of the monitored application or system.",
+ "properties": {
+ "description": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "description"
+ ]
+ }
+ },
+ "required": [
+ "auto_detection",
+ "limits",
+ "performance_impact"
+ ]
+ }
+ },
+ "required": [
+ "data_collection",
+ "supported_platforms",
+ "multi_instance",
+ "additional_permissions",
+ "default_behavior"
+ ]
+ },
+ "setup": {
+ "$ref": "./shared.json#/$defs/full_setup"
+ },
+ "troubleshooting": {
+ "$ref": "./shared.json#/$defs/troubleshooting"
+ },
+ "alerts": {
+ "type": "array",
+ "description": "The list of configured alerts shipped with Netdata for this collector.",
+ "items": {
+ "type": "object",
+ "description": "Information about the configured alert.",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Alert's 'alarm' or 'template' value (https://learn.netdata.cloud/docs/alerting/health-configuration-reference#alarm-line-alarm-or-template)."
+ },
+ "link": {
+ "type": "string",
+ "description": "Link to github .conf file that this alert originates from"
+ },
+ "metric": {
+ "type": "string",
+ "description": "Alert's 'on' value (https://learn.netdata.cloud/docs/alerting/health-configuration-reference#alarm-line-on)."
+ },
+ "info": {
+ "type": "string",
+ "description": "Alert's 'info' value (https://learn.netdata.cloud/docs/alerting/health-configuration-reference#alarm-line-info)."
+ },
+ "os": {
+ "type": "string",
+ "description": "Alert's 'os' value (https://learn.netdata.cloud/docs/alerting/health-configuration-reference#alarm-line-os)."
+ }
+ },
+ "required": [
+ "name",
+ "link",
+ "metric",
+ "info"
+ ]
+ }
+ },
+ "metrics": {
+ "type": "object",
+ "description": "Collected metrics grouped by scope. The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.",
+ "properties": {
+ "folding": {
+ "$ref": "./shared.json#/$defs/_folding"
+ },
+ "description": {
+ "type": "string",
+ "description": "General description of collected metrics/scopes."
+ },
+ "availability": {
+ "type": "array",
+ "description": "Metrics collection availability conditions. Some metrics are only available when certain conditions are met. For example, Apache exposes additional metrics when Extended status is configured, Consul exposes different set of metrics depends on its mode. This field should list the available conditions that will later be matched for each of the metrics.",
+ "items": {
+ "type": "string",
+ "description": "Availability condition name."
+ }
+ },
+ "scopes": {
+ "type": "array",
+ "description": "List of scopes and their metrics.",
+ "items": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Scope name."
+ },
+ "description": {
+ "type": "string",
+ "description": "Scope description."
+ },
+ "labels": {
+ "type": "array",
+ "description": "Label set of the scope.",
+ "items": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Label name."
+ },
+ "description": {
+ "type": "string",
+ "description": "Label description."
+ }
+ },
+ "required": [
+ "name",
+ "description"
+ ]
+ }
+ },
+ "metrics": {
+ "type": "array",
+ "description": "List of collected metrics (chart contexts) in the scope.",
+ "items": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Metric name (chart context)."
+ },
+ "availability": {
+ "type": "array",
+ "description": "Metric collection availability conditions. An empty list means that it is available for all conditions defined in 'metrics.availability'.",
+ "items": {
+ "type": "string",
+ "description": "Availability condition name."
+ }
+ },
+ "description": {
+ "type": "string",
+ "description": "Metric description (chart title)."
+ },
+ "unit": {
+ "type": "string",
+ "description": "Metric description (chart unit)."
+ },
+ "chart_type": {
+ "type": "string",
+ "description": "Metric description (chart type).",
+ "enum": [
+ "line",
+ "area",
+ "stacked"
+ ]
+ },
+ "dimensions": {
+ "type": "array",
+ "description": "",
+ "items": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Dimension name."
+ }
+ },
+ "required": [
+ "name"
+ ]
+ }
+ }
+ },
+ "required": [
+ "name",
+ "description",
+ "unit",
+ "chart_type",
+ "dimensions"
+ ]
+ }
+ }
+ },
+ "required": [
+ "name",
+ "description",
+ "labels",
+ "metrics"
+ ]
+ }
+ }
+ },
+ "required": [
+ "folding",
+ "description",
+ "availability",
+ "scopes"
+ ]
+ }
+ },
+ "required": [
+ "meta",
+ "overview",
+ "setup",
+ "troubleshooting",
+ "alerts",
+ "metrics"
+ ]
+ }
+ }
+ },
+ "required": [
+ "plugin_name",
+ "modules"
+ ]
+}
diff --git a/integrations/schemas/deploy.json b/integrations/schemas/deploy.json
new file mode 100644
index 00000000..b2bd7206
--- /dev/null
+++ b/integrations/schemas/deploy.json
@@ -0,0 +1,116 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "type": "array",
+ "title": "Netdata deployment information meta.",
+ "items": {
+ "type": "object",
+ "description": "Individual entries for deployment information.",
+ "properties": {
+ "id": {
+ "$ref": "./shared.json#/$defs/id"
+ },
+ "meta": {
+ "$ref": "./shared.json#/$defs/instance"
+ },
+ "keywords": {
+ "$ref": "./shared.json#/$defs/keywords"
+ },
+ "most_popular": {
+ "type": "boolean",
+ "description": "If true, the integration is sorted to the top of the list of integrations."
+ },
+ "install_description": {
+ "type": "string",
+ "description": "Describes basic information about how to deploy on this platform."
+ },
+ "methods": {
+ "type": "array",
+ "description": "Describes the various ways to deploy on this platform.",
+ "items": {
+ "type": "object",
+ "properties": {
+ "method": {
+ "type": "string",
+ "description": "The name of the installation method."
+ },
+ "commands": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "channel": {
+ "type": "string",
+ "description": "The release channel that this command is used for.",
+ "enum": [
+ "nightly",
+ "stable"
+ ]
+ },
+ "command": {
+ "type": "string",
+ "description": "The command to run for installing using this method."
+ }
+ },
+ "required": [
+ "channel",
+ "command"
+ ]
+ }
+ }
+ },
+ "required": [
+ "method",
+ "commands"
+ ]
+ }
+ },
+ "additional_info": {
+ "type": "string",
+ "description": "Any additional information about this platform."
+ },
+ "related_resources": {
+ "type": "object",
+ "description": "TBD"
+ },
+ "platform_info": {
+ "type": "object",
+ "description": "References what platform this deployment info is for. In the parsed output, this will be replaced with a markdown string covering basic support information for this platform.",
+ "properties": {
+ "group": {
+ "type": "string",
+ "description": "Identifies the group that the platform is in. 'include' is used for platforms that are in auto-generated CI. 'no_include' is used for platforms that are not in auto-generated CI. An empty string indicates no associated platform information.",
+ "enum": [
+ "include",
+ "no_include",
+ ""
+ ]
+ },
+ "distro": {
+ "type": "string",
+ "description": "Identifies the platform within the group, based on the value of the 'distro' key."
+ }
+ },
+ "required": [
+ "group",
+ "distro"
+ ]
+ },
+ "quick_start": {
+ "type": "integer",
+ "description": "Indicates where the deploy integration should appear in the add nodes dialogue. A value less than 0 indicates that it should not appear on this dialogue."
+ }
+ },
+ "required": [
+ "id",
+ "meta",
+ "keywords",
+ "most_popular",
+ "install_description",
+ "methods",
+ "additional_info",
+ "related_resources",
+ "platform_info",
+ "quick_start"
+ ]
+ }
+}
diff --git a/integrations/schemas/distros.json b/integrations/schemas/distros.json
new file mode 100644
index 00000000..51040865
--- /dev/null
+++ b/integrations/schemas/distros.json
@@ -0,0 +1,153 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "type": "object",
+ "title": "Platform support information for the Netdata agent.",
+ "properties": {
+ "platform_map": {
+ "type": "object",
+ "description": "Maps CPU architectures to Docker platform strings. Used by CI when generating build matrices.",
+ "patternProperties": {
+ "^.+$": {
+ "type": "string",
+ "minLength": 1
+ }
+ },
+ "additionalProperties": false
+ },
+ "arch_order": {
+ "type": "array",
+ "description": "Defines the CPU architecture sort order used when generating build matrices in CI.",
+ "items": {
+ "type": "string",
+ "minLength": 1
+ }
+ },
+ "include": {
+ "type": "array",
+ "description": "Defines data for platforms that are included in CI.",
+ "items": {
+ "$ref": "#/$defs/platform"
+ }
+ }
+ },
+ "required": [
+ "platform_map",
+ "arch_order",
+ "include"
+ ],
+ "$defs": {
+ "platform": {
+ "type": "object",
+ "description": "Describes a platform.",
+ "properties": {
+ "distro": {
+ "type": "string",
+ "description": "The name of the platform.",
+ "pattern": "^[a-z][a-z0-9]*$"
+ },
+ "version": {
+ "type": "string",
+ "description": "Version identifier for the platform.",
+ "pattern": "^[a-z0-9][a-z.0-9]*$"
+ },
+ "support_type": {
+ "type": "string",
+ "description": "Defines the support tier that the platform is in.",
+ "enum": [
+ "Core",
+ "Intermediate",
+ "Community",
+ "Third-Party",
+ "Unsupported"
+ ]
+ },
+ "notes": {
+ "type": "string",
+ "description": "Any additional notes about the platform."
+ },
+ "eol_check": {
+ "description": "Indicates if EOL checks should be done for this platform. Only relevant if the platform is included in CI. If the value is a string, that value is used for the EOL check lookup, otherwise the value of the distro key is used.",
+ "oneOf": [
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "string",
+ "pattern": "^[a-z][a-z0-9._-]*$"
+ }
+ ]
+ },
+ "base_image": {
+ "type": "string",
+ "description": "A string specifying the Docker image to be used for testing this platform.",
+ "pattern": "^[a-z][a-z0-9._/:-]*$"
+ },
+ "env_prep": {
+ "type": "string",
+ "description": "A string containing any shell commands that need to be run to prep the platform for testing in CI."
+ },
+ "jsonc_removal": {
+ "type": "string",
+ "description": "A string containing a shell command to uninstall JSON-C development files during CI checks."
+ },
+ "test": {
+ "type": "object",
+ "description": "Contains additional data for usage by CI.",
+ "properties": {
+ "ebpf-core": {
+ "type": "boolean",
+ "description": "If true, then eBPF CO-RE CI jobs should be run for this platform."
+ }
+ }
+ },
+ "packages": {
+ "type": "object",
+ "description": "Additional information about native packages for this platform.",
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "Indicates the type of native packages to build for the platform.",
+ "enum": [
+ "deb",
+ "rpm",
+ ""
+ ]
+ },
+ "arches": {
+ "type": "array",
+ "description": "A list of CPU architectures (specified in the usual manner for the platform) that native packages are built for for this platform.",
+ "items": {
+ "type": "string",
+ "minLength": 1
+ }
+ },
+ "repo_distro": {
+ "type": "string",
+ "description": "Identifies the repository name to be used when publishing packages for this platform.",
+ "minLength": 1
+ },
+ "alt_links": {
+ "type": "array",
+ "description": "A list of alternative repository names to be used when publishing packages for this platform.",
+ "items": {
+ "type": "string",
+ "minLength": 1
+ }
+ }
+ },
+ "required": [
+ "type",
+ "arches"
+ ]
+ }
+ },
+ "additionalProperties": false,
+ "required": [
+ "distro",
+ "version",
+ "support_type",
+ "notes"
+ ]
+ }
+ }
+}
diff --git a/integrations/schemas/exporter.json b/integrations/schemas/exporter.json
new file mode 100644
index 00000000..51c45cab
--- /dev/null
+++ b/integrations/schemas/exporter.json
@@ -0,0 +1,63 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "title": "Netdata Agent data exporter metadata.",
+ "oneOf": [
+ {
+ "$ref": "#/$defs/entry"
+ },
+ {
+ "type": "array",
+ "minLength": 1,
+ "items": {
+ "$ref": "#/$defs/entry"
+ }
+ }
+ ],
+ "$defs": {
+ "entry": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "$ref": "./shared.json#/$defs/id"
+ },
+ "meta": {
+ "$ref": "./shared.json#/$defs/instance"
+ },
+ "keywords": {
+ "$ref": "./shared.json#/$defs/keywords"
+ },
+ "overview": {
+ "type": "object",
+ "description": "General information about the exporter.",
+ "properties": {
+ "exporter_description": {
+ "type": "string",
+ "description": "General description of what the exporter does."
+ },
+ "exporter_limitations": {
+ "type": "string",
+ "description": "Explanation of any limitations of the exporter."
+ }
+ },
+ "required": [
+ "exporter_description",
+ "exporter_limitations"
+ ]
+ },
+ "setup": {
+ "$ref": "./shared.json#/$defs/full_setup"
+ },
+ "troubleshooting": {
+ "$ref": "./shared.json#/$defs/troubleshooting"
+ }
+ },
+ "required": [
+ "id",
+ "meta",
+ "keywords",
+ "overview",
+ "setup"
+ ]
+ }
+ }
+}
diff --git a/integrations/schemas/notification.json b/integrations/schemas/notification.json
new file mode 100644
index 00000000..2596ca44
--- /dev/null
+++ b/integrations/schemas/notification.json
@@ -0,0 +1,87 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "title": "Netdata notification mechanism metadata.",
+ "oneOf": [
+ {
+ "$ref": "#/$defs/entry"
+ },
+ {
+ "type": "array",
+ "minLength": 1,
+ "items": {
+ "$ref": "#/$defs/entry"
+ }
+ }
+ ],
+ "$defs": {
+ "entry": {
+ "type": "object",
+ "description": "Data for a single notification method.",
+ "properties": {
+ "id": {
+ "$ref": "./shared.json#/$defs/id"
+ },
+ "meta": {
+ "$ref": "./shared.json#/$defs/instance"
+ },
+ "keywords": {
+ "$ref": "./shared.json#/$defs/keywords"
+ },
+ "overview": {
+ "type": "object",
+ "description": "General information about the notification method.",
+ "properties": {
+ "notification_description": {
+ "type": "string",
+ "description": "General description of what the notification method does."
+ },
+ "notification_limitations": {
+ "type": "string",
+ "description": "Explanation of any limitations of the notification method."
+ }
+ },
+ "required": [
+ "notification_description",
+ "notification_limitations"
+ ]
+ },
+ "global_setup": {
+ "type": "object",
+ "description": "Flags that show which global setup sections are relevant for this notification method.",
+ "properties": {
+ "severity_filtering": {
+ "type": "boolean"
+ },
+ "http_proxy": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "severity_filtering",
+ "http_proxy"
+ ]
+ },
+ "setup": {
+ "oneOf": [
+ {
+ "$ref": "./shared.json#/$defs/short_setup"
+ },
+ {
+ "$ref": "./shared.json#/$defs/full_setup"
+ }
+ ]
+ },
+ "troubleshooting": {
+ "$ref": "./shared.json#/$defs/troubleshooting"
+ }
+ },
+ "required": [
+ "id",
+ "meta",
+ "keywords",
+ "overview",
+ "setup"
+ ]
+ }
+ }
+}
diff --git a/integrations/schemas/shared.json b/integrations/schemas/shared.json
new file mode 100644
index 00000000..5aa926c3
--- /dev/null
+++ b/integrations/schemas/shared.json
@@ -0,0 +1,327 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "title": "Shared definitions used for all integrations schemas.",
+ "$defs": {
+ "id": {
+ "type": "string",
+ "minLength": 1,
+ "description": "A unique ID for the item. Must be URL safe."
+ },
+ "instance": {
+ "type": "object",
+ "description": "Information about the integration instance.",
+ "properties": {
+ "name": {
+ "description": "Integration display name. Use official spelling for applications.",
+ "type": "string"
+ },
+ "link": {
+ "description": "Link to the instance official website if any.",
+ "type": "string"
+ },
+ "categories": {
+ "type": "array",
+ "description": "Category IDs that this integration falls into. IDs can be found in integrations/categories.yaml",
+ "items": {
+ "type": "string",
+ "description": "String defining integration category"
+ }
+ },
+ "icon_filename": {
+ "type": "string",
+ "description": "The filename of the integration's icon, as sourced from https://github.com/netdata/website/tree/master/themes/tailwind/static/img."
+ },
+ "variables": {
+ "type": "object",
+ "description": "A mapping of variables to be used when templating other keys.",
+ "patternProperties": {
+ "^[a-zA-Z_][a-zA-Z0-9_]*$": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "integer"
+ },
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "number"
+ }
+ ]
+ }
+ },
+ "additionalProperties": false
+ }
+ },
+ "required": [
+ "name",
+ "link",
+ "categories",
+ "icon_filename"
+ ]
+ },
+ "keywords": {
+ "type": "array",
+ "description": "An array of terms related to the integration.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "short_setup": {
+ "type": "object",
+ "description": "Simplified information about how to enable and configure the integration.",
+ "properties": {
+ "description": {
+ "type": "string",
+ "description": "A description of how to enable and configure the integration."
+ }
+ },
+ "required": [
+ "description"
+ ]
+ },
+ "full_setup": {
+ "type": "object",
+ "description": "Complete information that is needed to enable and configure the integration.",
+ "properties": {
+ "prerequisites": {
+ "type": "object",
+ "description": "Actions the user must take to make the integration work, if any. It includes both configuring Netdata (e.g. if the integration is disabled by default) and configuring any external components the integration interacts with.",
+ "properties": {
+ "list": {
+ "type": "array",
+ "description": "List of prerequisites.",
+ "items": {
+ "type": "object",
+ "properties": {
+ "title": {
+ "type": "string",
+ "description": "Title should reflect the description, be short and in the form of a command (e.g. Create netdata user, Enable build-in web server)."
+ },
+ "description": {
+ "type": "string",
+ "description": "Steps to follow to meet this prerequisite."
+ }
+ },
+ "required": [
+ "title",
+ "description"
+ ]
+ }
+ }
+ },
+ "required": [
+ "list"
+ ]
+ },
+ "configuration": {
+ "description": "Information on how to configure the integration and available configuration options.",
+ "type": "object",
+ "properties": {
+ "file": {
+ "type": "object",
+ "description": "Configuration file.",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Configuration file name."
+ },
+ "section_name": {
+ "type": "string",
+ "description": "The name of the section in the configuration file. Only for data collectors whose configuration is in netdata.conf (e.g. proc.plugin modules)."
+ }
+ },
+ "required": [
+ "name"
+ ]
+ },
+ "options": {
+ "type": "object",
+ "description": "All information about the available configuration options.",
+ "properties": {
+ "description": {
+ "type": "string",
+ "description": "Optional common information about options."
+ },
+ "folding": {
+ "$ref": "./shared.json#/$defs/_folding"
+ },
+ "list": {
+ "type": "array",
+ "description": "List of configuration options.",
+ "items": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Option name."
+ },
+ "description": {
+ "type": "string",
+ "description": "Option description. Must be short. Use 'detailed_description' for a long description."
+ },
+ "detailed_description": {
+ "type": "string",
+ "description": "Option detailed description. Use it to describe in details complex options."
+ },
+ "default_value": {
+ "type": [
+ "string",
+ "number",
+ "boolean"
+ ],
+ "description": "Default value. Leave empty if none."
+ },
+ "required": {
+ "type": "boolean",
+ "description": "Indicates whether this option is required or not. The option is required if the integration does not work if it is not set."
+ }
+ },
+ "required": [
+ "name",
+ "description",
+ "default_value",
+ "required"
+ ]
+ }
+ }
+ },
+ "required": [
+ "description",
+ "folding",
+ "list"
+ ]
+ },
+ "examples": {
+ "type": "object",
+ "description": "Configuration examples. The more examples the better!",
+ "properties": {
+ "folding": {
+ "$ref": "./shared.json#/$defs/_folding"
+ },
+ "list": {
+ "type": "array",
+ "description": "List of configuration examples.",
+ "items": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Example name."
+ },
+ "folding": {
+ "$ref": "./shared.json#/$defs/_folding_relaxed"
+ },
+ "description": {
+ "type": "string",
+ "description": "Example description."
+ },
+ "config": {
+ "type": "string",
+ "description": "Example configuration."
+ }
+ },
+ "required": [
+ "name",
+ "description",
+ "config"
+ ]
+ }
+ }
+ },
+ "required": [
+ "folding",
+ "list"
+ ]
+ }
+ },
+ "required": [
+ "file",
+ "options",
+ "examples"
+ ]
+ }
+ },
+ "required": [
+ "prerequisites",
+ "configuration"
+ ]
+ },
+ "troubleshooting": {
+ "type": "object",
+ "description": "Information needed to troubleshoot issues with this collector.",
+ "properties": {
+ "problems": {
+ "type": "object",
+ "description": "Common problems that users face again and again... and their solutions.",
+ "properties": {
+ "list": {
+ "type": "array",
+ "description": "List of common problems.",
+ "items": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Problem name."
+ },
+ "description": {
+ "type": "string",
+ "description": "Explanation of the problem and its solution."
+ }
+ }
+ },
+ "required": [
+ "name",
+ "description"
+ ]
+ }
+ },
+ "required": [
+ "list"
+ ]
+ }
+ },
+ "required": [
+ "problems"
+ ]
+ },
+ "_folding": {
+ "type": "object",
+ "description": "Content folding settings.",
+ "properties": {
+ "title": {
+ "description": "Folded content summary title.",
+ "type": "string"
+ },
+ "enabled": {
+ "description": "Determines if this content should be folded.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "title",
+ "enabled"
+ ]
+ },
+ "_folding_relaxed": {
+ "type": "object",
+ "description": "Content folding settings with optional title.",
+ "properties": {
+ "title": {
+ "description": "Folded content summary title.",
+ "type": "string"
+ },
+ "enabled": {
+ "description": "Determines if this content should be folded.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "enabled"
+ ]
+ }
+ }
+}
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-11 01:16:06 +0000