Regenerate integrations docs (#21870)
Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>
Netdata bot committed
Mar 3, 2026 at 13:54 UTC
d30a38cf22388cab113354e92d889d77e790abec
1 file changed
+52
src/go/plugin/go.d/collector/docker/integrations/docker.md
+52
@@ -97,6 +97,58 @@ Metrics:
97
98
99
100
+## Functions
101
+
102
+This collector exposes real-time functions for interactive troubleshooting in the Top tab.
103
+
104
+
105
+### Containers
106
+
107
+Retrieves container list data equivalent to `docker ps -a`.
108
+
109
+This function calls the Docker Container List API with `all=true` and returns both running and non-running containers in a table similar to Docker CLI output.
110
+
111
+Use cases:
112
+- Quickly inspect all containers (running, exited, paused, dead) from Netdata
113
+- Correlate container lifecycle with metric changes and alerts
114
+- Verify exposed ports, image tags, and container names without shell access
115
+
116
+
117
+| Aspect | Description |
118
+|:-------|:------------|
119
+| Name | `Docker:container-ls` |
120
+| Require Cloud | yes |
121
+| Performance | Executes a single Docker API request (`ContainerList` with `all=true`):<br/>• No per-container inspect requests are issued<br/>• Response size grows with total container count<br/>• Large histories with many stopped containers may return more rows |
122
+| Security | Exposes container metadata that may include sensitive details:<br/>• Container command text may include runtime arguments<br/>• Image names, ports, and container names are visible<br/>• Restrict access to authorized operators |
123
+| Availability | Available when:<br/>• Docker collector is initialized and connected<br/>• Docker API list-containers request succeeds<br/>• Returns HTTP 503 while collector is initializing<br/>• Returns HTTP 500 on Docker API errors<br/>• Returns HTTP 504 on timeout |
124
+
125
+#### Prerequisites
126
+
127
+No additional configuration is required.
128
+
129
+#### Parameters
130
+
131
+This function has no parameters.
132
+
133
+#### Returns
134
+
135
+Container inventory from Docker Engine. Each row represents one container returned by `docker ps -a`.
136
+
137
+| Column | Type | Unit | Visibility | Description |
138
+|:-------|:-----|:-----|:-----------|:------------|
139
+| CONTAINER ID | string | | | Short container ID (12 characters). |
140
+| IMAGE | string | | | Container image reference. |
141
+| COMMAND | string | | | Container command as reported by Docker API. |
142
+| CREATED | string | | | Human-readable container creation age (for example, '5 days ago'). |
143
+| STATUS | string | | | Docker status string (for example, 'Up 3 weeks' or 'Exited (0) 4 weeks ago'). |
144
+| State (Raw) | string | | hidden | Raw Docker state value (for example, running, exited, paused, restarting, dead). |
145
+| PORTS | string | | | Published or exposed ports summary. |
146
+| NAMES | string | | | Container name. |
147
+| Container ID (Full) | string | | hidden | Full 64-character container ID. |
148
+| Created (Unix) | integer | seconds | hidden | Container creation timestamp in Unix seconds. |
149
+
150
+
151
+
152
## Alerts
153
154