This guide explains how to collect metrics from your SingleStore deployment using the OpenTelemetry Collector. The collector gathers, processes, and sends telemetry data (including metrics, logs, and traces) to various observability backends, including New Relic.
The setup example below leverages the Prometheus receiver within the collector. It retrieves service metrics directly from SingleStore's management API and exports them to New Relic's OpenTelemetry endpoint.
Follow the steps below to collect and export SingleStore metrics to New Relic.
Review the requirements
Before you start, you'll need the following:
- A running Docker daemon service
- An installed Docker Compose tool
- Your SingleStore API key
- Your New Relic for the account you want to report data to
Download or clone the example configuration
- Download the example Configuration.
- Once downloaded, locate the
singlestore
directory within theother-examples/collector
folder of the repository. This directory contains the specific configuration for collecting SingleStore metrics. - (Optional) Refer to the README for additional details and instructions related to the SingleStore example.
Set environment variables and run the collector
In the .env
file:
Set the SingleStore API key, workspace group, and Org variables
Set the New Relic API key variable to your New Relic license key
Once the variables are set, you can run the example by using the following command:
$# Open the SingleStore example directory$ cd newrelic-opentelemetry-examples/other-examples/collector/singlestore$
$ # run the collector in docker$ docker compose up
Environment variable information
If you need more information on the environment variables set above, see the documentation in the following table.
Variable | Description | Docs |
---|---|---|
| New Relic Ingest API Key | |
| The default US New Relic OTLP endpoint is | |
| ID for your SingleStore Organization | |
| ID of the SingleStore Workspace Group you want to monitor | |
| Your SingleStore API key |
View your data in New Relic
To view your data in New Relic, use the data explorer and filter for singlestore
. This data can be added to any custom alert or dashboard.