Pushing Metrics using Remote Write

Push Prometheus metrics directly to groundcover.

Send Prometheus metrics to groundcover using the Remote Write protocol for direct ingestion from external sources or non-Kubernetes environments.

Sending from Kubernetes

The recommended way to ship data via remote write in Kubernetes it by writing directly to the sensors deployed by groundcover.

No ingestion key is needed when sending data inside Kubernetes clusters.

Setting up remote write

Prometheus (prometheus.yml):

remote_write:
  - url: "http://groundcover-sensor.groundcover.svc.cluster.local:8428/api/v1/write"

vmagent (flags):

-remoteWrite.url=http://groundcover-sensor.groundcover.svc.cluster.local:8428/api/v1/write

Sending from Non-Kubernetes

The recommended way to ship data from Non-Kubernetes hosts is to the BYOC ingestion endpoint.

Get your BYOC endpoint

Find your BYOC endpoint in the ingestion keys tab.

Create an ingestion key

See how in the ingestion key docs.

Set up Remote Write

You can enrich your metrics with additional context using special headers. For detailed information, see our Enriching Data with Headers guide.

Examples

Prometheus (prometheus.yml):

remote_write:
  - url: "https://{BYOC_ENDPOINT}/api/v1/write"
    headers:
      apikey: "{ingestion-key}"
      x-groundcover-service-name: "my-service-name"
      x-groundcover-env-name: "my-env"

vmagent (flags):

-remoteWrite.url=https://{BYOC_ENDPOINT}/api/v1/write
-remoteWrite.headers=apikey:{ingestion-key}^^x-groundcover-service-name:my-service-name^^x-groundover-env-name:my-env