github-mirrors/VictoriaMetrics
1
0
Fork 0
mirror of https://github.com/VictoriaMetrics/VictoriaMetrics.git synced 2024-11-21 14:44:00 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs: udpate Datadog section (#3190)

Browse source 
The `docs-sync` command was updated to modify images path
for assets in `docs/` folder. The change allows to refer images from `docs`
without copying them to the root folder.

Signed-off-by: hagen1778 <roman@victoriametrics.com>
This commit is contained in:
Roman Khavronenko 2022-10-03 13:13:07 +02:00 committed by GitHub
parent 272f00dbb6
commit 2d11896486
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 144 additions and 236 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
Makefile
View file

@ -397,14 +397,20 @@ check-licenses: install-wwhrd
wwhrd check -f .wwhrd.yml wwhrd check -f .wwhrd.yml
copy-docs: copy-docs:
echo "---\nsort: ${ORDER}\n---\n" > ${DST} > ${DST}
@if [[ ${ORDER} > 0 ]]; then \
echo "---\nsort: ${ORDER}\n---\n" > ${DST}; \
fi
cat ${SRC} >> ${DST} cat ${SRC} >> ${DST}
sed -i '' 's/<img src=\"docs\//<img src=\"/' ${DST}
# Copies docs for all components and adds the order tag. # Copies docs for all components and adds the order tag.
# For ORDER=0 it adds no order tag.
# Images starting with <img src="docs/ are replaced with <img src="
# Cluster docs are supposed to be ordered as 9th. # Cluster docs are supposed to be ordered as 9th.
# For The rest of docs is ordered manually.t # The rest of docs is ordered manually.
docs-sync: docs-sync:
cp README.md docs/README.md SRC=README.md DST=docs/README.md ORDER=0 $(MAKE) copy-docs
SRC=README.md DST=docs/Single-server-VictoriaMetrics.md ORDER=1 $(MAKE) copy-docs SRC=README.md DST=docs/Single-server-VictoriaMetrics.md ORDER=1 $(MAKE) copy-docs
SRC=app/vmagent/README.md DST=docs/vmagent.md ORDER=3 $(MAKE) copy-docs SRC=app/vmagent/README.md DST=docs/vmagent.md ORDER=3 $(MAKE) copy-docs
SRC=app/vmalert/README.md DST=docs/vmalert.md ORDER=4 $(MAKE) copy-docs SRC=app/vmalert/README.md DST=docs/vmalert.md ORDER=4 $(MAKE) copy-docs

122
README.md
View file

@ -337,100 +337,86 @@ See also [vmagent](https://docs.victoriametrics.com/vmagent.html), which can be
## How to send data from DataDog agent ## How to send data from DataDog agent
VictoriaMetrics accepts data from [DataDog agent](https://docs.datadoghq.com/agent/) or [DogStatsD](https://docs.datadoghq.com/developers/dogstatsd/) via ["submit metrics" API](https://docs.datadoghq.com/api/latest/metrics/#submit-metrics) at `/datadog/api/v1/series` path. VictoriaMetrics accepts data from [DataDog agent](https://docs.datadoghq.com/agent/)
or [DogStatsD](https://docs.datadoghq.com/developers/dogstatsd/)
via ["submit metrics" API](https://docs.datadoghq.com/api/latest/metrics/#submit-metrics)
at `/datadog/api/v1/series` path.
### Single-node VictoriaMetrics: ### Sending metrics to VictoriaMetrics
Run DataDog agent with environment variable `DD_DD_URL=http://victoriametrics-host:8428/datadog`. Alternatively, set `dd_url` param at [DataDog agent configuration file](https://docs.datadoghq.com/agent/guide/agent-configuration-files/) to `http://victoriametrics-host:8428/datadog`. DataDog agent allows configuring destinations for metrics sending via ENV variable `DD_DD_URL`
or via [configuration file](https://docs.datadoghq.com/agent/guide/agent-configuration-files/) in section `dd_url`.
### Cluster version of VictoriaMetrics: <p align="center">
<img src="docs/Single-server-VictoriaMetrics-sending_DD_metrics_to_VM.png" width="800">
Run DataDog agent with environment variable `DD_DD_URL=http://vinsert-host:8480/insert/0/datadog`. Alternatively, set `dd_url` param at [DataDog agent configuration file](https://docs.datadoghq.com/agent/guide/agent-configuration-files/) to `DD_DD_URL=http://vinsert-host:8480/insert/0/datadog`. </p>
VictoriaMetrics doesn't check `DD_API_KEY` param, so it can be set to arbitrary value.
Example of how to send data to VictoriaMetrics via [DataDog "submit metrics"](https://docs.victoriametrics.com/url-examples.html#datadogapiv1series) from command line:
### Single-node VictoriaMetrics:
```console
echo '
{
"series": [
{
"host": "test.example.com",
"interval": 20,
"metric": "system.load.1",
"points": [[
0,
0.5
]],
"tags": [
"environment:test"
],
"type": "rate"
}
]
}
' | curl -X POST --data-binary @- http://victoriametrics-host:8428/datadog/api/v1/series
```
### Cluster version of VictoriaMetrics:
To configure DataDog agent via ENV variable add the following prefix:
<div class="with-copy" markdown="1"> <div class="with-copy" markdown="1">
```console ```
echo ' DD_DD_URL=http://victoriametrics:8428/datadog
{
"series": [
{
"host": "test.example.com",
"interval": 20,
"metric": "system.load.1",
"points": [[
0,
0.5
]],
"tags": [
"environment:test"
],
"type": "rate"
}
]
}
' | curl -X POST --data-binary @- http://vminsert-host:8480/insert/0/datadog/api/v1/series
``` ```
</div> </div>
_Choose correct URL for VictoriaMetrics [here](https://docs.victoriametrics.com/url-examples.html#datadog)._
The imported data can be read via [export API](https://docs.victoriametrics.com/url-examples.html#apiv1export): To configure DataDog agent via [configuration file](https://docs.datadoghq.com/agent/guide/agent-configuration-files)
add the following line:
### Single-node VictoriaMetrics:
<div class="with-copy" markdown="1"> <div class="with-copy" markdown="1">
```console ```
curl http://victoriametrics-host:8428/api/v1/export -d 'match[]=system.load.1' dd_url: http://victoriametrics:8428/datadog
``` ```
</div> </div>
### Cluster version of VictoriaMetrics: vmagent also can accept Datadog metrics format. Depending on where vmagent will forward data,
pick [single-node or cluster URL]((https://docs.victoriametrics.com/url-examples.html#datadog)) formats.
### Sending metrics to Datadog and VictoriaMetrics
DataDog allows configuring [Dual Shipping](https://docs.datadoghq.com/agent/guide/dual-shipping/) for metrics
sending via ENV variable `DD_ADDITIONAL_ENDPOINTS` or via configuration file `additional_endpoints`.
<p align="center">
<img src="docs/Single-server-VictoriaMetrics-sending_DD_metrics_to_VM_and_DD.png" width="800">
</p>
Run DataDog using the following ENV variable with VictoriaMetrics as additional metrics receiver:
<div class="with-copy" markdown="1"> <div class="with-copy" markdown="1">
```console ```
curl http://vmselect-host:8481/select/0/prometheus/api/v1/export -d 'match[]=system.load.1' DD_ADDITIONAL_ENDPOINTS='{\"http://victoriametrics:8428/datadog\"}'
``` ```
</div> </div>
This command should return the following output if everything is OK: _Choose correct URL for VictoriaMetrics [here](https://docs.victoriametrics.com/url-examples.html#datadog)._
To configure DataDog Dual Shipping via [configuration file](https://docs.datadoghq.com/agent/guide/agent-configuration-files)
add the following line:
<div class="with-copy" markdown="1">
```json
{"metric":{"__name__":"system.load.1","environment":"test","host":"test.example.com"},"values":[0.5],"timestamps":[1632833641000]}
``` ```
additional_endpoints: http://victoriametrics:8428/datadog
```
</div>
### Send via cURL
See how to send data to VictoriaMetrics via
[DataDog "submit metrics"](https://docs.victoriametrics.com/url-examples.html#datadogapiv1series) from command line.
The imported data can be read via [export API](https://docs.victoriametrics.com/url-examples.html#apiv1export).
### Additional details
VictoriaMetrics automatically sanitizes metric names for the data ingested via DataDog protocol VictoriaMetrics automatically sanitizes metric names for the data ingested via DataDog protocol
according to [DataDog metric naming recommendations](https://docs.datadoghq.com/metrics/custom_metrics/#naming-custom-metrics). according to [DataDog metric naming recommendations](https://docs.datadoghq.com/metrics/custom_metrics/#naming-custom-metrics).
@ -451,7 +437,7 @@ See [these docs](https://docs.victoriametrics.com/vmagent.html#adding-labels-to-
## How to send data from InfluxDB-compatible agents such as [Telegraf](https://www.influxdata.com/time-series-platform/telegraf/) ## How to send data from InfluxDB-compatible agents such as [Telegraf](https://www.influxdata.com/time-series-platform/telegraf/)
Use `http://<victoriametric-addr>:8428` url instead of InfluxDB url in agents' configs. Use `http://<victoriametrics-addr>:8428` url instead of InfluxDB url in agents' configs.
For instance, put the following lines into `Telegraf` config, so it sends data to VictoriaMetrics instead of InfluxDB: For instance, put the following lines into `Telegraf` config, so it sends data to VictoriaMetrics instead of InfluxDB:
```toml ```toml

122
docs/README.md
View file

@ -337,100 +337,86 @@ See also [vmagent](https://docs.victoriametrics.com/vmagent.html), which can be
## How to send data from DataDog agent ## How to send data from DataDog agent
VictoriaMetrics accepts data from [DataDog agent](https://docs.datadoghq.com/agent/) or [DogStatsD](https://docs.datadoghq.com/developers/dogstatsd/) via ["submit metrics" API](https://docs.datadoghq.com/api/latest/metrics/#submit-metrics) at `/datadog/api/v1/series` path. VictoriaMetrics accepts data from [DataDog agent](https://docs.datadoghq.com/agent/)
or [DogStatsD](https://docs.datadoghq.com/developers/dogstatsd/)
via ["submit metrics" API](https://docs.datadoghq.com/api/latest/metrics/#submit-metrics)
at `/datadog/api/v1/series` path.
### Single-node VictoriaMetrics: ### Sending metrics to VictoriaMetrics
Run DataDog agent with environment variable `DD_DD_URL=http://victoriametrics-host:8428/datadog`. Alternatively, set `dd_url` param at [DataDog agent configuration file](https://docs.datadoghq.com/agent/guide/agent-configuration-files/) to `http://victoriametrics-host:8428/datadog`. DataDog agent allows configuring destinations for metrics sending via ENV variable `DD_DD_URL`
or via [configuration file](https://docs.datadoghq.com/agent/guide/agent-configuration-files/) in section `dd_url`.
### Cluster version of VictoriaMetrics: <p align="center">
<img src="Single-server-VictoriaMetrics-sending_DD_metrics_to_VM.png" width="800">
Run DataDog agent with environment variable `DD_DD_URL=http://vinsert-host:8480/insert/0/datadog`. Alternatively, set `dd_url` param at [DataDog agent configuration file](https://docs.datadoghq.com/agent/guide/agent-configuration-files/) to `DD_DD_URL=http://vinsert-host:8480/insert/0/datadog`. </p>
VictoriaMetrics doesn't check `DD_API_KEY` param, so it can be set to arbitrary value.
Example of how to send data to VictoriaMetrics via [DataDog "submit metrics"](https://docs.victoriametrics.com/url-examples.html#datadogapiv1series) from command line:
### Single-node VictoriaMetrics:
```console
echo '
{
"series": [
{
"host": "test.example.com",
"interval": 20,
"metric": "system.load.1",
"points": [[
0,
0.5
]],
"tags": [
"environment:test"
],
"type": "rate"
}
]
}
' | curl -X POST --data-binary @- http://victoriametrics-host:8428/datadog/api/v1/series
```
### Cluster version of VictoriaMetrics:
To configure DataDog agent via ENV variable add the following prefix:
<div class="with-copy" markdown="1"> <div class="with-copy" markdown="1">
```console ```
echo ' DD_DD_URL=http://victoriametrics:8428/datadog
{
"series": [
{
"host": "test.example.com",
"interval": 20,
"metric": "system.load.1",
"points": [[
0,
0.5
]],
"tags": [
"environment:test"
],
"type": "rate"
}
]
}
' | curl -X POST --data-binary @- http://vminsert-host:8480/insert/0/datadog/api/v1/series
``` ```
</div> </div>
_Choose correct URL for VictoriaMetrics [here](https://docs.victoriametrics.com/url-examples.html#datadog)._
The imported data can be read via [export API](https://docs.victoriametrics.com/url-examples.html#apiv1export): To configure DataDog agent via [configuration file](https://docs.datadoghq.com/agent/guide/agent-configuration-files)
add the following line:
### Single-node VictoriaMetrics:
<div class="with-copy" markdown="1"> <div class="with-copy" markdown="1">
```console ```
curl http://victoriametrics-host:8428/api/v1/export -d 'match[]=system.load.1' dd_url: http://victoriametrics:8428/datadog
``` ```
</div> </div>
### Cluster version of VictoriaMetrics: vmagent also can accept Datadog metrics format. Depending on where vmagent will forward data,
pick [single-node or cluster URL]((https://docs.victoriametrics.com/url-examples.html#datadog)) formats.
### Sending metrics to Datadog and VictoriaMetrics
DataDog allows configuring [Dual Shipping](https://docs.datadoghq.com/agent/guide/dual-shipping/) for metrics
sending via ENV variable `DD_ADDITIONAL_ENDPOINTS` or via configuration file `additional_endpoints`.
<p align="center">
<img src="Single-server-VictoriaMetrics-sending_DD_metrics_to_VM_and_DD.png" width="800">
</p>
Run DataDog using the following ENV variable with VictoriaMetrics as additional metrics receiver:
<div class="with-copy" markdown="1"> <div class="with-copy" markdown="1">
```console ```
curl http://vmselect-host:8481/select/0/prometheus/api/v1/export -d 'match[]=system.load.1' DD_ADDITIONAL_ENDPOINTS='{\"http://victoriametrics:8428/datadog\"}'
``` ```
</div> </div>
This command should return the following output if everything is OK: _Choose correct URL for VictoriaMetrics [here](https://docs.victoriametrics.com/url-examples.html#datadog)._
To configure DataDog Dual Shipping via [configuration file](https://docs.datadoghq.com/agent/guide/agent-configuration-files)
add the following line:
<div class="with-copy" markdown="1">
```json
{"metric":{"__name__":"system.load.1","environment":"test","host":"test.example.com"},"values":[0.5],"timestamps":[1632833641000]}
``` ```
additional_endpoints: http://victoriametrics:8428/datadog
```
</div>
### Send via cURL
See how to send data to VictoriaMetrics via
[DataDog "submit metrics"](https://docs.victoriametrics.com/url-examples.html#datadogapiv1series) from command line.
The imported data can be read via [export API](https://docs.victoriametrics.com/url-examples.html#apiv1export).
### Additional details
VictoriaMetrics automatically sanitizes metric names for the data ingested via DataDog protocol VictoriaMetrics automatically sanitizes metric names for the data ingested via DataDog protocol
according to [DataDog metric naming recommendations](https://docs.datadoghq.com/metrics/custom_metrics/#naming-custom-metrics). according to [DataDog metric naming recommendations](https://docs.datadoghq.com/metrics/custom_metrics/#naming-custom-metrics).
@ -451,7 +437,7 @@ See [these docs](https://docs.victoriametrics.com/vmagent.html#adding-labels-to-
## How to send data from InfluxDB-compatible agents such as [Telegraf](https://www.influxdata.com/time-series-platform/telegraf/) ## How to send data from InfluxDB-compatible agents such as [Telegraf](https://www.influxdata.com/time-series-platform/telegraf/)
Use `http://<victoriametric-addr>:8428` url instead of InfluxDB url in agents' configs. Use `http://<victoriametrics-addr>:8428` url instead of InfluxDB url in agents' configs.
For instance, put the following lines into `Telegraf` config, so it sends data to VictoriaMetrics instead of InfluxDB: For instance, put the following lines into `Telegraf` config, so it sends data to VictoriaMetrics instead of InfluxDB:
```toml ```toml

0
docs/Sending_DD_metrics_to_VM.png → docs/Single-server-VictoriaMetrics-sending_DD_metrics_to_VM.png
View file

Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 60 KiB

After

Width:  |  Height:  |  Size: 60 KiB

0
docs/Sending_DD_metrics_to_VM_and_DDhq.png → docs/Single-server-VictoriaMetrics-sending_DD_metrics_to_VM_and_DD.png
View file

Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 80 KiB

After

Width:  |  Height:  |  Size: 80 KiB

124
docs/Single-server-VictoriaMetrics.md
View file

@ -341,19 +341,21 @@ See also [vmagent](https://docs.victoriametrics.com/vmagent.html), which can be
## How to send data from DataDog agent ## How to send data from DataDog agent
VictoriaMetrics accepts data from [DataDog agent](https://docs.datadoghq.com/agent/) or [DogStatsD](https://docs.datadoghq.com/developers/dogstatsd/) via ["submit metrics" API](https://docs.datadoghq.com/api/latest/metrics/#submit-metrics) at `/datadog/api/v1/series` path. VictoriaMetrics accepts data from [DataDog agent](https://docs.datadoghq.com/agent/)
or [DogStatsD](https://docs.datadoghq.com/developers/dogstatsd/)
via ["submit metrics" API](https://docs.datadoghq.com/api/latest/metrics/#submit-metrics)
at `/datadog/api/v1/series` path.
### Sending metrics to VictoriaMetrics ### Sending metrics to VictoriaMetrics
DataDog agent allows configuring destinations for metrics sending via ENV variable `DD_DD_URL` or via [configuration file](https://docs.datadoghq.com/agent/guide/agent-configuration-files/) in section `dd_url`. DataDog agent allows configuring destinations for metrics sending via ENV variable `DD_DD_URL`
or via [configuration file](https://docs.datadoghq.com/agent/guide/agent-configuration-files/) in section `dd_url`.
<p align="center"> <p align="center">
<img src="Sending_DD_metrics_to_VM.png" width="800"> <img src="Single-server-VictoriaMetrics-sending_DD_metrics_to_VM.png" width="800">
</p> </p>
Depending on where you want to send metrics, the [URL for VictoriaMetrics](https://docs.victoriametrics.com/url-examples.html#datadog) will be different: To configure DataDog agent via ENV variable add the following prefix:
1. Run DataDog using this ENV variable for sending metrics to VictoriaMetrics
<div class="with-copy" markdown="1"> <div class="with-copy" markdown="1">
``` ```
@ -362,7 +364,10 @@ DD_DD_URL=http://victoriametrics:8428/datadog
</div> </div>
Alternatively add this `dd_url` to DataDog YAML configuration file. _Choose correct URL for VictoriaMetrics [here](https://docs.victoriametrics.com/url-examples.html#datadog)._
To configure DataDog agent via [configuration file](https://docs.datadoghq.com/agent/guide/agent-configuration-files)
add the following line:
<div class="with-copy" markdown="1"> <div class="with-copy" markdown="1">
@ -372,17 +377,19 @@ dd_url: http://victoriametrics:8428/datadog
</div> </div>
2. vmagent also can accept Datadog metrics format. Depending on where vmagent will forward data, pick the single-node or cluster URL formats. vmagent also can accept Datadog metrics format. Depending on where vmagent will forward data,
pick [single-node or cluster URL]((https://docs.victoriametrics.com/url-examples.html#datadog)) formats.
### Sending metrics to Datadog and VictoriaMetrics ### Sending metrics to Datadog and VictoriaMetrics
DataDog allows configuring [Dual Shipping](https://docs.datadoghq.com/agent/guide/dual-shipping/) for metrics sending via ENV variable `DD_ADDITIONAL_ENDPOINTS` or via configuration file `additional_endpoints` described in section YAML configuration. DataDog allows configuring [Dual Shipping](https://docs.datadoghq.com/agent/guide/dual-shipping/) for metrics
sending via ENV variable `DD_ADDITIONAL_ENDPOINTS` or via configuration file `additional_endpoints`.
<p align="center"> <p align="center">
<img src="Sending_DD_metrics_to_VM_and_DDhq.png" width="800"> <img src="Single-server-VictoriaMetrics-sending_DD_metrics_to_VM_and_DD.png" width="800">
</p> </p>
Run DataDog using this ENV variable for sending metrics to the single-node VictoriaMetrics on top of DataDoghq. Run DataDog using the following ENV variable with VictoriaMetrics as additional metrics receiver:
<div class="with-copy" markdown="1"> <div class="with-copy" markdown="1">
@ -392,103 +399,26 @@ DD_ADDITIONAL_ENDPOINTS='{\"http://victoriametrics:8428/datadog\"}'
</div> </div>
Alternatively add an `additional_endpoints` to [DataDog agent configuration file](https://docs.datadoghq.com/agent/guide/agent-configuration-files/). _Choose correct URL for VictoriaMetrics [here](https://docs.victoriametrics.com/url-examples.html#datadog)._
To configure DataDog Dual Shipping via [configuration file](https://docs.datadoghq.com/agent/guide/agent-configuration-files)
add the following line:
<div class="with-copy" markdown="1"> <div class="with-copy" markdown="1">
``` ```
dd_url: http://victoriametrics:8428/datadog additional_endpoints: http://victoriametrics:8428/datadog
``` ```
</div> </div>
### Send via cURL ### Send via cURL
Example of how to send data to VictoriaMetrics via [DataDog "submit metrics"](https://docs.victoriametrics.com/url-examples.html#datadogapiv1series) from command line: See how to send data to VictoriaMetrics via
[DataDog "submit metrics"](https://docs.victoriametrics.com/url-examples.html#datadogapiv1series) from command line.
### Single-node VictoriaMetrics: The imported data can be read via [export API](https://docs.victoriametrics.com/url-examples.html#apiv1export).
<div class="with-copy" markdown="1">
```console
echo '
{
"series": [
{
"host": "test.example.com",
"interval": 20,
"metric": "system.load.1",
"points": [[
0,
0.5
]],
"tags": [
"environment:test"
],
"type": "rate"
}
]
}
' | curl -X POST --data-binary @- http://victoriametrics:8428/datadog/api/v1/series
```
</div>
### Cluster version of VictoriaMetrics:
<div class="with-copy" markdown="1">
```console
echo '
{
"series": [
{
"host": "test.example.com",
"interval": 20,
"metric": "system.load.1",
"points": [[
0,
0.5
]],
"tags": [
"environment:test"
],
"type": "rate"
}
]
}
' | curl -X POST --data-binary @- http://vminsert:8480/insert/0/datadog/api/v1/series
```
</div>
The imported data can be read via [export API](https://docs.victoriametrics.com/url-examples.html#apiv1export):
### Single-node VictoriaMetrics:
<div class="with-copy" markdown="1">
```console
curl http://victoriametrics:8428/api/v1/export -d 'match[]=system.load.1'
```
</div>
### Cluster version of VictoriaMetrics:
<div class="with-copy" markdown="1">
```console
curl http://vmselect:8481/select/0/prometheus/api/v1/export -d 'match[]=system.load.1'
```
</div>
This command should return the following output if everything is OK:
```json
{"metric":{"__name__":"system.load.1","environment":"test","host":"test.example.com"},"values":[0.5],"timestamps":[1632833641000]}
```
### Additional details ### Additional details