Skip to content

Commit

Permalink
Agent Management: Small doc tweaks (#5526)
Browse files Browse the repository at this point in the history
* Agent Management: Small doc tweaks

- Remove references to v2 in the remote config endpoint (this does not have much meaning to users)
- Specify that `agent_id` is required when label management is enabled.

* Fix typo

* Reorder sections in config schema for better readability
  • Loading branch information
jcreixell authored Oct 19, 2023
1 parent 1d06721 commit 08b9a23
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/sources/static/configuration/agent-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,17 +67,17 @@ agent_management:
labels:
[ <labelname>: <labelvalue> ... ]

# Whether to use labels from the label management service. If enabled, labels from the API supersede the ones configured in the agent.
# Whether to use labels from the label management service. If enabled, labels from the API supersede the ones configured in the agent. The agent_id field must be defined.
label_management_enabled: <bool> | default = false

# Whether to accept HTTP 304 Not Modified responses from the API server. If enabled, the agent will use the cached configuration if the API server responds with HTTP 304 Not Modified. You can set this argument to `false` for debugging or testing.
accept_http_not_modified: <bool> | default = true

# A unique ID for the agent, which is used to identify the agent.
agent_id: <string>

# Whether to accept HTTP 304 Not Modified responses from the API server. If enabled, the agent will use the cached configuration if the API server responds with HTTP 304 Not Modified. You can set this argument to `false` for debugging or testing.
accept_http_not_modified: <bool> | default = true
```
## API (v2)
## API
Grafana Agents with Agent Management enabled continuously poll the API server for an up-to-date configuration. The API server is expected to implement a `GET /agent-management/api/agent/v2/namespace/:namespace/remote_config` HTTP endpoint returning a successful response with the following body format:

Expand Down

0 comments on commit 08b9a23

Please sign in to comment.