Skip to content

[DOCS] PMM-14678 Document vmagent remote-write routing - #5952

Open
4nte wants to merge 2 commits into
doc-3.10.0from
docs-vmagent-remote-write-PMM-14678
Open

4nte wants to merge 2 commits into
doc-3.10.0from
docs-vmagent-remote-write-PMM-14678

Conversation

@4nte

@4nte 4nte commented Sep 15, 2026 •

Copy link
Copy Markdown
Contributor

Documents the vmagent remote-write routing rework (PMM-14678): how PMM Clients deliver metrics in PMM High Availability, and what the PMM_VM_URL and VMAGENT_remoteWrite_* settings now mean.

Changes

  • reference/third-party/victoria.md: PMM_VM_URL with and without credentials, precedence of VMAGENT_remoteWrite_basicAuth_* over URL credentials, credentials reaching vmagent through its environment only, the VMAGENT_remoteWrite_url override (PMM sends none of its own credentials to an endpoint it did not choose), the http:///https:// scheme requirement, and that an injected credential replaces the URL's entirely, so both halves of a basic-auth pair must be set.
  • install-pmm/.../docker/env_var.md: corrected the vmagent variables table (VMAGENT_remoteWrite_url, basic-auth defaults, tlsInsecureSkipVerify default) added a caution on redirecting remote write, listed the log levels vmagent accepts (DEBUG is not one of them), and documented that any injected credential replaces PMM's default one and that an empty VMAGENT_* variable is ignored with a startup warning.
  • install-pmm/install-HA-clustered.md: new How client metrics reach VictoriaMetrics section (writes go to the PMM Server address through HAProxy to vmauth, never through the PMM Server pods), the renamed pmm-secret keys PMM_HA_VM_USERNAME / PMM_HA_VM_PASSWORD with a rename note for Technical Preview installs (the chart refuses to render while the old keys remain), the chart-first upgrade order.

Related

Describe PMM_VM_URL with and without credentials, the precedence of
VMAGENT_remoteWrite_basicAuth_* over URL credentials, and the global
VMAGENT_remoteWrite_url override. In the HA guide, explain how client
metrics reach VictoriaMetrics through HAProxy, the renamed secret
keys, the chart-first upgrade order, and drop the PMM-14705 known
issue.

Targets doc-3.10.0 because user docs are released ahead of the code.
The code change is #5887.

Signed-off-by: Ante Gulin <ante.gulin@percona.com>
An empty VMAGENT_* variable is ignored with a startup warning, any
injected credential replaces PMM's default one entirely (so both
halves of a basic-auth pair must be set), PMM_VM_URL must carry an
http or https scheme, and the pmm-ha chart refuses to render while the
Technical Preview secret keys remain.

vmagent accepts INFO, WARN, ERROR, FATAL and PANIC as log levels and
exits on DEBUG, which the table and the debugging example suggested.

Signed-off-by: Ante Gulin <ante.gulin@percona.com>

This branch was successfully deployed

1 active deployment
docs-vmagent-remote-write-PMM-14678 - pmm-3.10.0 PR #5952 — db5af5af Deployed Sep 17, 2026 by ademidoff
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Documentation changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants