• EnglishEspañol日本語한국어Português
  • Log inStart now

OpenTelemetry Collector for monitoring SingleStore metrics

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

  1. Download the example Configuration.
  2. Once downloaded, locate the singlestore directory within the other-examples/collector folder of the repository. This directory contains the specific configuration for collecting SingleStore metrics.
  3. (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:

bash
$
# 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_API_KEY

New Relic Ingest API Key

Learn about API keys

NEW_RELIC_OTLP_ENDPOINT

The default US New Relic OTLP endpoint is https://otlp.nr-data.net:4318.

Review OTLP endpoint configurations

SINGLESTORE_ORG

ID for your SingleStore Organization

SingleStore Org documentation

SINGLESTORE_WORKSPACE_GROUP

ID of the SingleStore Workspace Group you want to monitor

SingleStore Workspace Group documentation

SINGLESTORE_API_KEY

Your SingleStore API key

SingleStore API key documentation

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.

Copyright © 2024 New Relic Inc.

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.