summaryrefslogtreecommitdiffstats
path: root/web/api
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2021-12-14 16:23:58 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2021-12-14 16:28:16 +0000
commitf7737368d64b6b6d3b4075d1debe4342771faf49 (patch)
tree15c3484c1ae02ea9fbd1b4101ffc416fa6adadd9 /web/api
parentAdding upstream version 1.32.0. (diff)
downloadnetdata-f7737368d64b6b6d3b4075d1debe4342771faf49.tar.xz
netdata-f7737368d64b6b6d3b4075d1debe4342771faf49.zip
Adding upstream version 1.32.1.upstream/1.32.1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'web/api')
-rw-r--r--web/api/formatters/json_wrapper.c2
-rw-r--r--web/api/netdata-swagger.json60
-rw-r--r--web/api/netdata-swagger.yaml46
3 files changed, 107 insertions, 1 deletions
diff --git a/web/api/formatters/json_wrapper.c b/web/api/formatters/json_wrapper.c
index 1d9c2472..264377e2 100644
--- a/web/api/formatters/json_wrapper.c
+++ b/web/api/formatters/json_wrapper.c
@@ -114,7 +114,7 @@ void rrdr_json_wrapper_begin(RRDR *r, BUFFER *wb, uint32_t format, RRDR_OPTIONS
if (i)
buffer_strcat(wb, ", ");
buffer_strcat(wb, sq);
- buffer_strcat(wb, rd->rrdset->name);
+ buffer_strcat(wb, rd->rrdset->id);
buffer_strcat(wb, sq);
i++;
}
diff --git a/web/api/netdata-swagger.json b/web/api/netdata-swagger.json
index 5c2bba9a..7786b333 100644
--- a/web/api/netdata-swagger.json
+++ b/web/api/netdata-swagger.json
@@ -1067,6 +1067,24 @@
}
}
}
+ },
+ "/aclk": {
+ "get": {
+ "summary": "Get information about current ACLK state",
+ "description": "aclk endpoint returns detailed information about current state of ACLK (Agent to Cloud communication).",
+ "responses": {
+ "200": {
+ "description": "JSON object with ACLK information.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/aclk_state"
+ }
+ }
+ }
+ }
+ }
+ }
}
},
"servers": [
@@ -2059,6 +2077,48 @@
}
}
}
+ },
+ "aclk_state": {
+ "type": "object",
+ "properties": {
+ "aclk-available": {
+ "type": "boolean",
+ "description": "Describes whether this agent is capable of connection to the Cloud. False means agent has been built without ACLK component either on purpose (user choice) or due to missing dependency."
+ },
+ "aclk-implementation": {
+ "type": "string",
+ "description": "Describes which ACLK implementation is currently used.",
+ "enum": [
+ "Next Generation",
+ "Legacy"
+ ]
+ },
+ "new-cloud-protocol-supported": {
+ "type": "boolean",
+ "description": "Informs about new protobuf based Cloud/Agent protocol support of this agent. If false agent has to be compiled with protobuf and protoc available."
+ },
+ "agent-claimed": {
+ "type": "boolean",
+ "description": "Informs whether this agent has been added to a space in the cloud (User has to perform claiming). If false (user didnt perform claiming) agent will never attempt any cloud connection."
+ },
+ "claimed-id": {
+ "type": "string",
+ "format": "uuid",
+ "description": "Unique ID this agent uses to identify when connecting to cloud"
+ },
+ "online": {
+ "type": "boolean",
+ "description": "Informs if this agent was connected to the cloud at the time this request has been processed."
+ },
+ "used-cloud-protocol": {
+ "type": "string",
+ "description": "Informs which protocol is used to communicate with cloud",
+ "enum": [
+ "Old",
+ "New"
+ ]
+ }
+ }
}
}
}
diff --git a/web/api/netdata-swagger.yaml b/web/api/netdata-swagger.yaml
index 19f4ded5..83487bda 100644
--- a/web/api/netdata-swagger.yaml
+++ b/web/api/netdata-swagger.yaml
@@ -865,6 +865,18 @@ paths:
description: A plain text response based on the result of the command.
"403":
description: Bearer authentication error.
+ /aclk:
+ get:
+ summary: Get information about current ACLK state
+ description: aclk endpoint returns detailed information
+ about current state of ACLK (Agent to Cloud communication).
+ responses:
+ "200":
+ description: JSON object with ACLK information.
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/aclk_state"
servers:
- url: https://registry.my-netdata.io/api/v1
- url: http://registry.my-netdata.io/api/v1
@@ -1609,3 +1621,37 @@ components:
- WARNING
- CRITICAL
- UNKNOWN
+ aclk_state:
+ type: object
+ properties:
+ aclk-available:
+ type: string
+ description: Describes whether this agent is capable of connection to the Cloud.
+ False means agent has been built without ACLK component either on purpose (user choice) or due to missing dependency.
+ aclk-implementation:
+ type: string
+ description: Describes which ACLK implementation is currently used.
+ enum:
+ - Next Generation
+ - Legacy
+ new-cloud-protocol-supported:
+ type: boolean
+ description: Informs about new protobuf based Cloud/Agent protocol support of this agent.
+ If false agent has to be compiled with protobuf and protoc available.
+ agent-claimed:
+ type: boolean
+ description: Informs whether this agent has been added to a space in the cloud (User has to perform claiming).
+ If false (user didnt perform claiming) agent will never attempt any cloud connection.
+ claimed_id:
+ type: string
+ format: uuid
+ description: Unique ID this agent uses to identify when connecting to cloud
+ online:
+ type: boolean
+ description: Informs if this agent was connected to the cloud at the time this request has been processed.
+ used-cloud-protocol:
+ type: string
+ description: Informs which protocol is used to communicate with cloud
+ enum:
+ - Old
+ - New