summaryrefslogtreecommitdiffstats
path: root/integrations/schemas/logs.json
diff options
context:
space:
mode:
Diffstat (limited to 'integrations/schemas/logs.json')
-rw-r--r--integrations/schemas/logs.json97
1 files changed, 97 insertions, 0 deletions
diff --git a/integrations/schemas/logs.json b/integrations/schemas/logs.json
new file mode 100644
index 000000000..8209dc979
--- /dev/null
+++ b/integrations/schemas/logs.json
@@ -0,0 +1,97 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "title": "Netdata Logs integrations metadata.",
+ "oneOf": [
+ {
+ "$ref": "#/$defs/entry"
+ },
+ {
+ "type": "array",
+ "minLength": 1,
+ "items": {
+ "$ref": "#/$defs/entry"
+ }
+ }
+ ],
+ "$defs": {
+ "entry": {
+ "type": "object",
+ "description": "Data for a single logs integration.",
+ "properties": {
+ "id": {
+ "$ref": "./shared.json#/$defs/id"
+ },
+ "meta": {
+ "$ref": "./shared.json#/$defs/instance"
+ },
+ "keywords": {
+ "$ref": "./shared.json#/$defs/keywords"
+ },
+ "overview": {
+ "type": "object",
+ "properties": {
+ "description": {
+ "type": "string",
+ "description": "General description of what the integration does."
+ },
+ "visualization": {
+ "type": "object",
+ "properties": {
+ "description": {
+ "type": "string",
+ "description": "How the user can access the data provided by the integration"
+ }
+ },
+ "required": [
+ "description"
+ ]
+ },
+ "key_features": {
+ "type": "object",
+ "properties": {
+ "description": {
+ "type": "string",
+ "description": "The key features of the integration."
+ }
+ },
+ "required": [
+ "description"
+ ]
+ }
+ },
+ "required": [
+ "description",
+ "visualization",
+ "key_features"
+ ]
+ },
+ "setup": {
+ "type": "object",
+ "properties": {
+ "prerequisites": {
+ "type": "object",
+ "properties": {
+ "description": {
+ "type": "string",
+ "description": "Prerequisites of getting the integration working. For Log Functions only a Netdata account should be needed."
+ }
+ },
+ "required": [
+ "description"
+ ]
+ },
+ "required": [
+ "prerequisites"
+ ]
+ }
+ }
+ },
+ "required": [
+ "id",
+ "meta",
+ "keywords",
+ "overview"
+ ]
+ }
+ }
+} \ No newline at end of file