mirror of
https://github.com/VictoriaMetrics/VictoriaMetrics.git
synced 2024-11-21 14:44:00 +00:00
77c3bbf3fc
### Describe Your Changes
* `sort` param is unused by the current website engine, and was present only for compatibility
with previous website engine. It is time to remove it as it makes no effect
* re-structure guides content into folders to simplify assets management
### Checklist
The following checks are **mandatory**:
- [ ] My change adheres [VictoriaMetrics contributing
guidelines](https://docs.victoriametrics.com/contributing/).
(cherry picked from commit 35d77a3bed)
88 lines
3.4 KiB
Markdown
88 lines
3.4 KiB
Markdown
---
|
|
title: vmagent
|
|
weight: 2
|
|
menu:
|
|
docs:
|
|
identifier: data-ingestion-vmagent
|
|
parent: data-ingestion
|
|
weight: 2
|
|
aliases:
|
|
- /data-ingestion/vmagent.html
|
|
- /data-ingestion/VMAgent.html
|
|
---
|
|
|
|
vmagent can receive data via the same protocols as VictoriaMetrics Single or Cluster versions,
|
|
as well as scrape Prometheus endpoints. In other words,
|
|
it supports both [Push](https://docs.victoriametrics.com/keyconcepts/#push-model) and [Pull](https://docs.victoriametrics.com/keyconcepts/#pull-model) models.
|
|
|
|
This section of the documentation only covers forwarding data from vmagent to another destination.
|
|
For extra information about vmagent as well as quickstart guide please refer to the [vmagent documentation](https://docs.victoriametrics.com/vmagent/).
|
|
|
|
To configure vmagent to push metrics to VictoriaMetrics via Prometheus remote write protocol,
|
|
configure the `-remoteWrite.url` cmd-line flag:
|
|
|
|
```sh
|
|
/path/to/vmagent -remoteWrite.url=https://<victoriametrics_url>/api/v1/write
|
|
```
|
|
|
|
For pushing data to VictoriaMetrics cluster the `-remoteWrite.url` should point to vminsert and include
|
|
the [tenantID](https://docs.victoriametrics.com/cluster-victoriametrics/#url-format):
|
|
```sh
|
|
/path/to/vmagent -remoteWrite.url=https://<vminsert-addr>/insert/<tenant_id>/prometheus/api/v1/write
|
|
```
|
|
|
|
> Note: read more about [multitenancy](https://docs.victoriametrics.com/cluster-victoriametrics/#multitenancy)
|
|
> or [multitenancy via labels](https://docs.victoriametrics.com/cluster-victoriametrics/#multitenancy-via-labels).
|
|
|
|
Please note, `-remoteWrite.url` cmd-line flag can be specified multiple times with different values. In this case,
|
|
vmagent will [replicate](https://docs.victoriametrics.com/vmagent/#replication-and-high-availability) data to each
|
|
specified destination. In addition, it is possible to configure [metrics sharding](https://docs.victoriametrics.com/vmagent/#sharding-among-remote-storages)
|
|
across `-remoteWrite.url` destinations.
|
|
|
|
## Remote write with basic authentication
|
|
|
|
This requires setting the `-remoteWrite.basicAuth.username` and `-remoteWrite.basicAuth.password` command line flags:
|
|
|
|
```sh
|
|
/path/to/vmagent -remoteWrite.url=https://<victoriametrics_url>/api/v1/write \
|
|
-remoteWrite.basicAuth.username=<username> \
|
|
-remoteWrite.basicAuth.password=<password>
|
|
```
|
|
|
|
## Remote write with bearer Authentication
|
|
|
|
```sh
|
|
/path/to/vmagent -remoteWrite.url=https://<victoriametrics_url>/api/v1/write \
|
|
-remoteWrite.bearerToken=<token>
|
|
```
|
|
|
|
The token can be placed in a file and accessed via the `-remoteWrite.bearerTokenFile` command line argument.
|
|
The file needs to be readable by the user vmagent is running as. The token file should only contain the token as seen below:
|
|
|
|
```
|
|
<token>
|
|
```
|
|
|
|
The command to run vmagent with a token file will be the following:
|
|
|
|
```sh
|
|
/path/to/vmagent -remoteWrite.url=https://<victoriametrics_url>/api/v1/write \
|
|
-remoteWrite.bearerTokenFile=/path/to/tokenfile
|
|
|
|
```
|
|
|
|
## Ignore TLS/SSL errors
|
|
|
|
If you are using self-signed certificates you can either ignore certificates issues using
|
|
the `-remoteWrite.tlsInsecureSkipVerify`, which is a security risk, or use `-remoteWrite.tlsCAFile` to point
|
|
to a file containing the self-signed CA certificate:
|
|
|
|
```sh
|
|
/path/to/vmagent -remoteWrite.url=https://<victoriametrics_url>/api/v1/write \
|
|
-remoteWrite.tlsInsecureSkipVerify
|
|
```
|
|
|
|
## References
|
|
|
|
- [vmagent docs](https://docs.victoriametrics.com/vmagent/)
|
|
- [vmagent commandline flags](https://docs.victoriametrics.com/vmagent/#advanced-usage)
|