Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Agent Management: Small doc tweaks #5526

Merged
merged 3 commits into from
Oct 19, 2023
Merged

Agent Management: Small doc tweaks #5526

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8665aa6
Agent Management: Small doc tweaks
jcreixell Oct 18, 2023
67040d2
Fix typo
jcreixell Oct 18, 2023
5bf05d3
Reorder sections in config schema for better readability
jcreixell Oct 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/sources/static/configuration/agent-management.md
View file
Open in desktop
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