Plugins 〉Firestore


Developer

pgollangi

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
community

Firestore

  • Overview
  • Installation
  • Change log
  • Related content

Firestore

Google Firestore Data Source Plugin for Grafana.

Grafana Firestore Data Source Plugin enables integrating data on Firestore on to Grafana dashboards.

It uses FireQL to capture user query that translated to issue queries on Firestore and construct results.

FireQL is a Go library to query Google Firestore database using SQL syntax.

Features

  • Use Google Firestore as a data source for Grafana dashboards
  • Configure Firestore data source with GCP Project Id and Service Account for authentication
  • Store Service Account data source configuration in Grafana encrypted storage Secure JSON Data
  • Query Firestore collections and path to collections
  • Auto detect data types: string, number, boolean, json, time.Time
  • Query selected fields from the collection
  • Order query results
  • Limit query results
  • Query Collection Groups

Firestore data source configuration

Using datasource

Migration instructions from version <=0.1.0 to 0.2.0

Starting from version 0.2.0 firestore datasource plugin started using FireQL, a SQL query language to query collections on Google Firestore. Util 0.1 version it was just collection ID that can configured in the query section, where as starting from 0.2.0, it is query editor.

For example, if you have collection test_collection configured in v0.1, you have to change it to select * from test_collection in v0.2.0.

Installing Firestore 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 Firestore 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

1.0.0 (Unreleased)

Initial release.