Ingestion Endpoints

Our BYOC backend supports ingestion of various standard formats for metrics, traces and logs. It can be used to ingest telemetry from outside your kubernetes clusters, displaying it natively inside the groundcover platform.

Prerequisites

Every ingestion endpoint below requires two things:

1. BYOC endpoint - Your unique groundcover ingestion endpoint

2. ingestion-key - used to authenticate with your backend

Fetching the BYOC endpoint

Your BYOC site is part of the configuration provided to you by groundcover when setting up the managed BYOC backend. It can be located in the installation values, marked below as {BYOC_ENDPOINT}:

global:
  ingress:
    site: {BYOC_ENDPOINT}

Your BYOC endpoint can be found in the ingestion keys tab

Creating an ingestion-key

You can create or get an ingestion key in the ingestion keys tab

The ingestion-key printed will be referenced below as {ingestion-key}

Supported authentication methods

We support several methods of authentication when pushing data into groundcover. This applies for all endpoints, formats and protocols.

Header Key-Value

Add a header with one of the following keys, containing the {ingestion-key} value:

1. token

2. apikey

3. dd-api-key

4. X-Amz-Firehose-Access-Key

5. Authorization

Basic Authentication

When using basic authentication, use the following params:

Username: groundcover

Password: {ingestion-key}

Supported endpoints

All endpoints are accepted over HTTPS or gRPCS on port 443

Prometheus

Name	Endpoint
Prometheus remote write	https://{BYOC_ENDPOINT}/api/v1/write
Prometheus exposition format	https://{BYOC_ENDPOINT}/api/v1/import/prometheus

OpenTelemetry

Name	Endpoint
gRPC (Logs, Traces, Metrics)	{BYOC_ENDPOINT}
HTTP Logs	https://{BYOC_ENDPOINT}/v1/logs
HTTP Traces	https://{BYOC_ENDPOINT}/v1/traces
HTTP Metrics	https://{BYOC_ENDPOINT}/v1/metrics

DataDog

Name	Endpoint
Metrics V1	https://{BYOC_ENDPOINT}/datadog/api/v1/series
Metrics V2	https://{BYOC_ENDPOINT}/datadog/api/v2/series
Traces V0.3	https://{BYOC_ENDPOINT}/v0.3/traces
Traces V0.4	https://{BYOC_ENDPOINT}/v0.4/traces
Traces V0.5	https://{BYOC_ENDPOINT}/v0.5/traces
Traces V0.7	https://{BYOC_ENDPOINT}/v0.7/traces

AWS Firehose

Firehose ingestion requires setting up of a public endpoint, which was not available by default for BYOC deployments provisioned before July 31st 2024.

Please contact us if your deployment is older in order to provision the needed endpoint.

Name	Endpoint
Firehose Logs	https://{BYOC_ENDPOINT}/firehose/logs

JSON Logs

Name	Endpoint
JSON Logs	https://{BYOC_ENDPOINT}/json/logs