Replicate Multiple Grafana Accounts via the CData Sync CLI

CData Sync for Grafana is a stand-alone application that provides solutions for a variety of replication scenarios such as replicating sandbox and production instances into your database. Both Sync for Windows and Sync for Java include a command-line interface (CLI) that makes it easy to manage multiple Grafana connections. In this article we show how to use the CLI to replicate multiple Grafana accounts.

Configure Grafana Connections

You can save connection and email notification settings in an XML configuration file. To replicate multiple Grafana accounts, use multiple configuration files. Below is an example configuration to replicate Grafana to SQLite:

Windows

<?xml version="1.0" encoding="UTF-8" ?>
<CDataSync>
  <DatabaseType>SQLite</DatabaseType>
  <DatabaseProvider>System.Data.SQLite</DatabaseProvider>
  <ConnectionString>Profile=C:\profiles\Grafana.apip;ProfileSettings='Token=your_service_account_token;Domain=your_grafana_domain';</ConnectionString>
  <ReplicateAll>False</ReplicateAll>
  <NotificationUserName></NotificationUserName>
  <DatabaseConnectionString>Data Source=C:\my.db</DatabaseConnectionString>
  <TaskSchedulerStartTime>09:51</TaskSchedulerStartTime>
  <TaskSchedulerInterval>Never</TaskSchedulerInterval>
</CDataSync>

Java

<?xml version="1.0" encoding="UTF-8" ?>
<CDataSync>
<DatabaseType>SQLite</DatabaseType>
  <DatabaseProvider>org.sqlite.JDBC</DatabaseProvider>
  <ConnectionString>Profile=C:\profiles\Grafana.apip;ProfileSettings='Token=your_service_account_token;Domain=your_grafana_domain';</ConnectionString>
  <ReplicateAll>False</ReplicateAll>
  <NotificationUserName></NotificationUserName>
  <DatabaseConnectionString>Data Source=C:\my.db</DatabaseConnectionString>
</CDataSync>

Set the ProfileSettings connection property to the connection string for Grafana (see below).

Grafana API Profile Settings

In Grafana, navigate to Administration > Users and Access > Service accounts, create a service account, then click Add service account token to generate a token.

Configure Queries for Each Grafana Instance

Sync enables you to control replication with standard SQL. The REPLICATE statement is a high-level command that caches and maintains a table in your database. You can define any SELECT query supported by the Grafana API. The statement below caches and incrementally updates a table of Grafana data:

REPLICATE Alert;

You can specify a file containing the replication queries you want to use to update a particular database. Separate replication statements with semicolons. The following options are useful if you are replicating multiple Grafana accounts into the same database:

You can use a different table prefix in the REPLICATE SELECT statement:

REPLICATE PROD_Alert SELECT * FROM Alert 

Alternatively, you can use a different schema:

REPLICATE PROD.Alert SELECT * FROM Alert

Run Sync

After you have configured the connection strings and replication queries, you can run Sync with the following command-line options:

Windows

APISync.exe -g MyProductionAPIConfig.xml -f MyProductionAPISync.sql

Java

java -Xbootclasspath/p:c:\sqlitejdbc.jar -jar APISync.jar -g MyProductionAPIConfig.xml -f MyProductionAPISync.sql