Plugins 〉SurrealDB


Developer

Grafana Labs

Sign up to receive occasional product news and updates:


Grafana Cloud
Grafana Cloud
  • Grafana, of course
  • 10k series Prometheus metrics
  • 50 GB logs
  • 50 GB traces
  • 2,232 app o11y host hours
  • ...and more
Create free account

No credit card needed, ever.


Data Source
grafana

SurrealDB

  • Overview
  • Installation
  • Change log
  • Related content

SurrealDB Datasource

The SurrealDB datasource plugin enables you to query and visualize SurrealDB data directly within Grafana, offering seamless integration and exploration of SurrealDB datasets.

⚠️ This plugin is currently experimental

This means that while we believe in its potential and are enthusiastic about its development, we are not yet ready to make a long-term commitment to maintaining it indefinitely. The plugin is still under active development and may contain bugs. We do not recommend using this plugin in production environments.

Usage

Installation

Please refer to our Data Source Management documentation for more information on installing the plugin to an instance of Grafana.

Configuration

Add a data source by filling in the following fields:

Basic fields

FieldDescription
Endpoint URLThe full address of the SurrealDB RPC endpoint to connect to, e.g. ws://localhost:8000/rpc
Database nameThe name of the database to connect to.
NamespaceThe namespace to use for the connection.

Authentication fields

FieldDescription
UsernameYour SurrealDB username
PasswordYour SurrealDB password
ScopeThe scope to use for the user. (Optional)

We strongly recommend that you make your queries with a user account that has read-only access. This practice not only safeguards your data but also helps maintain system integrity.

Querying

The query editor allows you to write SurrealQL queries. For more information about writing SurrealQL queries, please refer to SurrealDB's documentation.

In this version, only a SurrealQL Editor is provided to write queries with. A Query Builder UI is planned for a later version of the plugin.

Installing SurrealDB on Grafana Cloud:

For more information, visit the docs on plugin installation.

Installing on a local Grafana:

For local instances, plugins are installed and updated via a simple CLI command. Plugins are not updated automatically, however you will be notified when updates are available right within your Grafana.

1. Install the Data Source

Use the grafana-cli tool to install SurrealDB from the commandline:

grafana-cli plugins install 

The plugin will be installed into your grafana plugins directory; the default is /var/lib/grafana/plugins. More information on the cli tool.

2. Configure the Data Source

Accessed from the Grafana main menu, newly installed data sources can be added immediately within the Data Sources section.

Next, click the Add data source button in the upper right. The data source will be available for selection in the Type select box.

To see a list of installed data sources, click the Plugins item in the main menu. Both core data sources and installed data sources will appear.

Changelog

0.2.5

  • Dependency updates.

0.2.4

  • Dependency updates.

0.2.3

  • Add compatibility warning for SurrealDB v2.0.
  • Dependency updates.

0.2.2

  • Dependency updates.
  • Updates to error source capture.

0.2.1

  • Dependency updates.

0.2.0

  • Added support for Grafana macros.
  • Added QueryWithContext method to better handle context cancellation and timeouts.
  • Added error source and metrics capture (internally used by Grafana Cloud).
  • Added integration tests.
  • Bump Go to 1.22.6.
  • Dependency updates.

0.1.2

  • Fixed Alerting support not activated.
  • Go version update to 1.21.6.
  • Dependency updates.

0.1.1

  • Dependency updates.
  • Added README.md file to src directory for display on Grafana plugin page.

0.1.0

Initial experimental release.