forked from VictoriaMetrics/VictoriaMetrics
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
app/vmagent: initial implementation for vmagent
- Loading branch information
Showing
162 changed files
with
36,290 additions
and
693 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| # All these commands must run from repository root. | ||
|
|
||
| vmagent: | ||
| APP_NAME=vmagent $(MAKE) app-local | ||
|
|
||
| vmagent-prod: | ||
| APP_NAME=vmagent $(MAKE) app-via-docker | ||
|
|
||
| vmagent-pure-prod: | ||
| APP_NAME=vmagent $(MAKE) app-via-docker-pure | ||
|
|
||
| vmagent-amd64-prod: | ||
| APP_NAME=vmagent $(MAKE) app-via-docker-amd64 | ||
|
|
||
| vmagent-arm-prod: | ||
| APP_NAME=vmagent $(MAKE) app-via-docker-arm | ||
|
|
||
| vmagent-arm64-prod: | ||
| APP_NAME=vmagent $(MAKE) app-via-docker-arm64 | ||
|
|
||
| vmagent-ppc64le-prod: | ||
| APP_NAME=vmagent $(MAKE) app-via-docker-ppc64le | ||
|
|
||
| vmagent-386-prod: | ||
| APP_NAME=vmagent $(MAKE) app-via-docker-386 | ||
|
|
||
| package-vmagent: | ||
| APP_NAME=vmagent $(MAKE) package-via-docker | ||
|
|
||
| package-vmagent-pure: | ||
| APP_NAME=vmagent $(MAKE) package-via-docker-pure | ||
|
|
||
| package-vmagent-amd64: | ||
| APP_NAME=vmagent $(MAKE) package-via-docker-amd64 | ||
|
|
||
| package-vmagent-arm: | ||
| APP_NAME=vmagent $(MAKE) package-via-docker-arm | ||
|
|
||
| package-vmagent-arm64: | ||
| APP_NAME=vmagent $(MAKE) package-via-docker-arm64 | ||
|
|
||
| package-vmagent-ppc64le: | ||
| APP_NAME=vmagent $(MAKE) package-via-docker-ppc64le | ||
|
|
||
| package-vmagent-386: | ||
| APP_NAME=vmagent $(MAKE) package-via-docker-386 | ||
|
|
||
| publish-vmagent: | ||
| APP_NAME=vmagent $(MAKE) publish-via-docker | ||
|
|
||
| run-vmagent: | ||
| mkdir -p vmagent-data | ||
| DOCKER_OPTS='-v $(shell pwd)/vmagent-data:/vmagent-data' \ | ||
| APP_NAME=vmagent \ | ||
| $(MAKE) run-via-docker | ||
|
|
||
| vmagent-amd64: | ||
| CGO_ENABLED=1 GOOS=linux GOARCH=amd64 GO111MODULE=on go build -mod=vendor -ldflags "$(GO_BUILDINFO)" -o bin/vmagent-amd64 ./app/vmagent | ||
|
|
||
| vmagent-arm: | ||
| CGO_ENABLED=0 GOOS=linux GOARCH=arm GO111MODULE=on go build -mod=vendor -ldflags "$(GO_BUILDINFO)" -o bin/vmagent-arm ./app/vmagent | ||
|
|
||
| vmagent-arm64: | ||
| CGO_ENABLED=0 GOOS=linux GOARCH=arm64 GO111MODULE=on go build -mod=vendor -ldflags "$(GO_BUILDINFO)" -o bin/vmagent-arm64 ./app/vmagent | ||
|
|
||
| vmagent-ppc64le: | ||
| CGO_ENABLED=0 GOOS=linux GOARCH=ppc64le GO111MODULE=on go build -mod=vendor -ldflags "$(GO_BUILDINFO)" -o bin/vmagent-ppc64le ./app/vmagent | ||
|
|
||
| vmagent-386: | ||
| CGO_ENABLED=0 GOOS=linux GOARCH=386 GO111MODULE=on go build -mod=vendor -ldflags "$(GO_BUILDINFO)" -o bin/vmagent-386 ./app/vmagent | ||
|
|
||
| vmagent-pure: | ||
| APP_NAME=vmagent $(MAKE) app-local-pure |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,151 @@ | ||
| ## vmagent | ||
|
|
||
| `vmagent` collects metrics from various sources and pushes them to any remote storage for Prometheus | ||
| from [this list](https://prometheus.io/docs/operating/integrations/#remote-endpoints-and-storage). | ||
| The recommended remote storage is [VictoriaMetrics](https://github.com/VictoriaMetrics/VictoriaMetrics). | ||
|
|
||
|
|
||
| ### Features | ||
|
|
||
| * Can be used as drop-in replacement for Prometheus for scraping targets such as [node_exporter](https://github.com/prometheus/node_exporter). | ||
| Just use `-promscrape.config=/path/to/prometheus.yml` command-line flag. | ||
| * Accepts data via all the ingestion protocols supported by VictoriaMetrics: | ||
| * Influx line protocol via `http://<vmagent>:8429/write`. See [these docs](https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/README.md#how-to-send-data-from-influxdb-compatible-agents-such-as-telegraf). | ||
| * JSON lines import protocol via `http://<vmagent>:8429/api/v1/import`. See [these docs](https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/README.md#how-to-import-time-series-data). | ||
| * Graphite plaintext protocol if `-graphiteListenAddr` command-line flag is set. See [these docs](https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/README.md#how-to-send-data-from-graphite-compatible-agents-such-as-statsd). | ||
| * OpenTSDB telnet and http protocols if `-opentsdbListenAddr` command-line flag is set. See [these docs](https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/README.md#how-to-send-data-from-opentsdb-compatible-agents). | ||
| * Prometheus remote write protocol via `http://<vmagent>:8429/api/v1/write`. | ||
| * Prometheus relabeling can be applied to all the collected metrics. See [these docs](#relabeling). | ||
| * Additional labels can be added to all the collected metrics before sending them to remote storage. | ||
| Just pass these labels to `-remoteWrite.label` command-line flag: `-remoteWrite.label="labelName=labelValue"`. | ||
| * Collected metrics can be sent simultaneously to multiple remote storage systems by providing multiple `-remoteWrite.url` args. | ||
| * Works in environments with unstable connections to remote storage. If the remote storage is unavailable, the collected metrics | ||
| are buffered at `-remoteWrite.tmpDataPath` until free space is available. The buffered metrics are sent to remote storage | ||
| as soon as connection to remote storage is recovered. | ||
| * Uses lower amounts of RAM, CPU, disk IO and network bandwidth comparing to Prometheus. | ||
|
|
||
|
|
||
| ### Quick start | ||
|
|
||
| Just pass path the following flags to `vmagent` in order to start scraping Prometheus targets: | ||
|
|
||
| * `-promscrape.config` with the path to Prometheus config file (it is usually located at `/etc/prometheus/prometheus.yml`) | ||
| * `-remoteWrite.url` with the remote storage endpoint that accepts data over Prometheus remote_write API. | ||
| See [the list of supported remote storage systems](https://prometheus.io/docs/operating/integrations/#remote-endpoints-and-storage). | ||
| `vmagent` supports sending data to multiple remote storage systems in parallel. Just set multiple `-remoteWrite.url` args. | ||
|
|
||
| Example command line: | ||
|
|
||
| ``` | ||
| /path/to/vmagent -promscrape.config=/path/to/prometheus.yml -remoteWrite.url=https://victoria-metrics-host:8428/api/v1/write | ||
| ``` | ||
|
|
||
| If you need collecting only Influx data, then the following command line would be enough: | ||
|
|
||
| ``` | ||
| /path/to/vmagent -remoteWrite.url=https://victoria-metrics-host:8428/api/v1/write | ||
| ``` | ||
|
|
||
| Then send Influx data to `http://vmagent-host:8429/write`. See [these docs](https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/README.md#how-to-send-data-from-influxdb-compatible-agents-such-as-telegraf) for more details. | ||
|
|
||
|
|
||
| ### How to collect metrics in Prometheus format? | ||
|
|
||
| `vmagent` can be used as Prometheus replacement for metrics' scraping if path to [Prometheus config file](https://prometheus.io/docs/prometheus/latest/configuration/configuration/) | ||
| path is passed to `-promscrape.config` command-line flag. This file is usually named `prometheus.yml`. | ||
| `vmagent` takes into account the following sections from [Prometheus config file](https://prometheus.io/docs/prometheus/latest/configuration/configuration/): | ||
|
|
||
| * `global` | ||
| * `scrape_configs` | ||
|
|
||
| All the other section are ignored, including [remote_write](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#remote_write) section. | ||
| Use `-remoteWrite.*` command-line flags instead for configuring remote write settings: | ||
|
|
||
| * `-remoteWrite.url` for pointing to remote storage. Data to remote storage can be sent either via HTTP or HTTPS. See `-remoteWrite.tls*` flags for details. | ||
| * `-remoteWrite.label` for adding labels to metrics before sending them to remote storage. | ||
| * `-remoteWrite.relabelConfig` for applying relabeling to metrics before sending them to remote storage. | ||
|
|
||
| The following scrape types in [scrape_config](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config) section are supported: | ||
|
|
||
| * `static_configs` - for scraping statically defined targets. See [these docs](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#static_config) for details. | ||
| * `file_sd_configs` - for scraping targets defined in external files aka file-based service discover. | ||
| See [these docs](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#file_sd_config) for details. | ||
|
|
||
| File feature requests at [our issue tracker](https://github.com/VictoriaMetrics/VictoriaMetrics/issues) if you need other service discovery mechanisms to be supported by `vmagent`. | ||
|
|
||
|
|
||
| ### Adding labels to metrics | ||
|
|
||
| Labels can be added to metrics via the following mechanisms: | ||
|
|
||
| * Via `global -> external_labels` section in `-promscrape.config` file. These labels are added only to metrics scraped from targets configured in `-promscrape.config` file. | ||
| * Via `-remoteWrite.label` command-line flag. These labels are added to all the collected metrics before sending them to `-remoteWrite.url`. | ||
|
|
||
|
|
||
| ### Relabeling | ||
|
|
||
| `vmagent` supports [Prometheus relabeling](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config). | ||
| Additionally it provides the following extra actions: | ||
|
|
||
| * `replace_all`: replaces all the occurences of `regex` in the values of `source_labels` with the `replacement` | ||
| * `labelmap_all`: replaces all the occurences of `regex` in all the labels with the `replacement` | ||
|
|
||
| The relabeling can be defined in the following places: | ||
|
|
||
| * At `scrape_config -> relabel_configs` section in `-promscrape.config` file. This relabeling is applied when parsing the file during `vmagent` startup | ||
| or during config reload after sending `SIGHUP` signal to `vmagent` via `kill -HUP`. | ||
| * At `scrape_config -> metric_relabel_configs` section in `-promscrape.config` file. This relabeling is applied to metrics after each scrape for configured targets. | ||
| Changes to this section can be applied after sending `SIGHUP` signal to `vmagent`. | ||
| * At `-remoteWrite.relabelConfig` file. This relabeling is aplied to all the collected metrics before sending them to `-remoteWrite.url`. | ||
|
|
||
| Read more about relabeling in the following articles: | ||
|
|
||
| * [Life of a label](https://www.robustperception.io/life-of-a-label) | ||
| * [Discarding targets and timeseries with relabeling](https://www.robustperception.io/relabelling-can-discard-targets-timeseries-and-alerts) | ||
| * [Dropping labels at scrape time](https://www.robustperception.io/dropping-metrics-at-scrape-time-with-prometheus) | ||
| * [Extracting labels from legacy metric names](https://www.robustperception.io/extracting-labels-from-legacy-metric-names) | ||
| * [relabel_configs vs metric_relabel_configs](https://www.robustperception.io/relabel_configs-vs-metric_relabel_configs) | ||
|
|
||
|
|
||
| ### Monitoring | ||
|
|
||
| `vmagent` export various metrics in Prometheus exposition format at `/metrics` page. It is recommended setting up regular scraping of this page | ||
| either via `vmagent` itself or via Prometheus, so the exported metrics could be analyzed later. | ||
|
|
||
|
|
||
| ### Troubleshooting | ||
|
|
||
| * It is recommended increasing the maximum number of open file in the system (`ulimit -n`) when scraping big number of targets, | ||
| since `vmagent` establishes at least a single TCP connection per each target. | ||
|
|
||
| * It is recommended increasing `-remoteWrite.queues` if `vmagent` collects more than 100K samples per second | ||
| and `vmagent_remotewrite_pending_data_bytes` metric exported by `vmagent` at `/metrics` page constantly grows. | ||
|
|
||
| * `vmagent` buffers scraped data at `-remoteWrite.tmpDataPath` directory until it is sent to `-remoteWrite.url`. | ||
| The directory can grow big when remote storage is unvailable during extended periods of time. If you don't want | ||
| sending all the data from the directory to remote storage, just stop `vmagent` and delete the directory. | ||
|
|
||
|
|
||
| ### How to build from sources | ||
|
|
||
| It is recommended using [binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) - `vmagent` is located in `vmutils-*` archives there. | ||
|
|
||
|
|
||
| #### Development build | ||
|
|
||
| 1. [Install Go](https://golang.org/doc/install). The minimum supported version is Go 1.12. | ||
| 2. Run `make vmagent` from the root folder of the repository. | ||
| It builds `vmagent` binary and puts it into the `bin` folder. | ||
|
|
||
| #### Production build | ||
|
|
||
| 1. [Install docker](https://docs.docker.com/install/). | ||
| 2. Run `make vmagent-prod` from the root folder of the repository. | ||
| It builds `vmagent-prod` binary and puts it into the `bin` folder. | ||
|
|
||
| #### Building docker images | ||
|
|
||
| Run `make package-vmagent`. It builds `victoriametrics/vmagent:<PKG_TAG>` docker image locally. | ||
| `<PKG_TAG>` is auto-generated image tag, which depends on source code in the repository. | ||
| The `<PKG_TAG>` may be manually set via `PKG_TAG=foobar make package-vmagent`. | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| package common | ||
|
|
||
| import ( | ||
| "runtime" | ||
| "sync" | ||
|
|
||
| "github.com/VictoriaMetrics/VictoriaMetrics/lib/prompbmarshal" | ||
| ) | ||
|
|
||
| // PushCtx is a context used for populating WriteRequest. | ||
| type PushCtx struct { | ||
| WriteRequest prompbmarshal.WriteRequest | ||
|
|
||
| // Labels contains flat list of all the labels used in WriteRequest. | ||
| Labels []prompbmarshal.Label | ||
|
|
||
| // Samples contains flat list of all the samples used in WriteRequest. | ||
| Samples []prompbmarshal.Sample | ||
| } | ||
|
|
||
| // Reset resets ctx. | ||
| func (ctx *PushCtx) Reset() { | ||
| tss := ctx.WriteRequest.Timeseries | ||
| for i := range tss { | ||
| ts := &tss[i] | ||
| ts.Labels = nil | ||
| ts.Samples = nil | ||
| } | ||
| ctx.WriteRequest.Timeseries = ctx.WriteRequest.Timeseries[:0] | ||
|
|
||
| labels := ctx.Labels | ||
| for i := range labels { | ||
| label := &labels[i] | ||
| label.Name = "" | ||
| label.Value = "" | ||
| } | ||
| ctx.Labels = ctx.Labels[:0] | ||
|
|
||
| ctx.Samples = ctx.Samples[:0] | ||
| } | ||
|
|
||
| // GetPushCtx returns PushCtx from pool. | ||
| // | ||
| // Call PutPushCtx when the ctx is no longer needed. | ||
| func GetPushCtx() *PushCtx { | ||
| select { | ||
| case ctx := <-pushCtxPoolCh: | ||
| return ctx | ||
| default: | ||
| if v := pushCtxPool.Get(); v != nil { | ||
| return v.(*PushCtx) | ||
| } | ||
| return &PushCtx{} | ||
| } | ||
| } | ||
|
|
||
| // PutPushCtx returns ctx to the pool. | ||
| // | ||
| // ctx mustn't be used after returning to the pool. | ||
| func PutPushCtx(ctx *PushCtx) { | ||
| ctx.Reset() | ||
| select { | ||
| case pushCtxPoolCh <- ctx: | ||
| default: | ||
| pushCtxPool.Put(ctx) | ||
| } | ||
| } | ||
|
|
||
| var pushCtxPool sync.Pool | ||
| var pushCtxPoolCh = make(chan *PushCtx, runtime.GOMAXPROCS(-1)) |
Oops, something went wrong.