Collects SQL database metrics using GO's 'SQL' package
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.


This project will no longer be maintained by Intel. Intel will not provide or guarantee development of or support for this project, including but not limited to, maintenance, bug fixes, new releases or updates. Patches to this project are no longer accepted by Intel. If you have an ongoing need to use this project, are interested in independently developing it, or would like to maintain patches for the community, please create your own fork of the project.

Snap collector plugin - dbi

This plugin connects to various databases, executes SQL statements and reads back the results.

The plugin is a generic plugin. You can configure how each column is to be interpreted and the plugin will generate one or more data sets from each row returned according. These rules are defined in separated json file (read more about this in Configuration and Usage section).

Depending on the configuration, the returned values are converted into metrics.

The plugin is used in the [Snap framework] (

  1. Getting Started
  1. Documentation
  1. Community Support
  2. Contributing
  3. License
  4. Acknowledgements

Getting Started

System Requirements

  • Linux system
  • Access to database (currently the following SQL Drivers are supported: MySQL, PostgreSQL)


Download the plugin binary:

You can get the pre-built binaries for your OS and architecture from the plugin's GitHub Releases page. Download the plugin from the latest release and load it into snapteld (/opt/snap/plugins is the default location for Snap packages).

To build the plugin binary:

Clone repo into $GOPATH/src/

$ git clone<yourGithubID>/snap-plugin-collector-dbi.git

Build the Snap dbi plugin by running make within the cloned repo:

$ make

This builds the plugin in ./build/

Configuration and Usage

  • Set up the Snap framework

  • Create configuration file (called as a setfile) in which will be defined databases, queries and rules how interpret the results, see exemplary in examples/configs/setfiles

  • Set up field setfile in Global Config as a path to dbi plugin configuration file, see exemplary Snap Global Config: in [examples/configs/snap-config-sample.json] (examples/configs/snap-config-sample.json)

Notice that this plugin is a generic plugin, i.e. it cannot work without configuration, because there is no reasonable default behavior.


Setfile fields

  • queries - contains all defined queries put in query block which includes:

    • name - identify query block, needs to be unique
    • statement - SQL statement to be executed
    • results - block which defines results of statement
  • results - contains how the returned data should be interpreted, including:

    • name - name of result, acceptable empty if only one result is defined; in other case must be given in order to distinguish results
    • instance_from - name of column whose values will be used to specify an instance
    • instance_prefix - prepended prefix to instance name
    • value_from - name of column whose content is used as the actual metric value
  • databases - contains all defined databases which will be established connection, database block includes:

    • name - identify database block, needs to be unique
    • driver - database's driver ("mysql" | "postgres"),
    • driver_option - block which defines dns option such like hostname, port (if not given, the defaults for the driver will be set), username, password and name of database)
    • selectdb - name of database to which the plugin will switch after the connection is established (optional)
    • dbqueries - block of queries associates with this database connection

Collected Metrics

Metric's namespace is /intel/dbi/<metric_name>/.

Depending on the configuration, the returned values are then converted into metrics. In examples there are ready configuration setfiles with prepared queries about:

a) Openstack Cinder services
b) Openstack Neutron agents
c) Openstack Nova services
d) Openstack Nova cluster status

Plus all of above in one config file dbi_openstack.json

Task manifest contains names of metrics which will be collected

By default metrics are gathered once per second.


Example of running Snap dbi collector retrieving the metrics about cinder services and writing the results to file.

Create configuration file (setfile) for dbi plugin (see examples/configs/setfiles/dbi_cinder_services.json).

    "databases": [
            "name": "cinder",
            "driver": "mysql",
            "driver_option": {
                "host": "123.456.78.9",
                "port": "3306",
                "username": "cinder",
                "password": "passwd",
                "dbname": "cinder"
            "dbqueries": [
                    "query": "cinder_services_up"
                    "query": "cinder_services_down"
                    "query": "cinder_services_disabled"
    "queries": [
            "name": "cinder_services_down",
            "statement": "select concat_ws('/', 'services', replace(replace(s1.binary, 'nova-', ''), 'cinder-', ''), 'down') as metric, count( as value from services s1 left outer join services s2 on = and s1.disabled=0 and s1.deleted=0 and timestampdiff(SECOND,s1.updated_at,utc_timestamp())>120 group by s1.binary",
            "results": [
                    "instance_from": "metric",
                    "value_from": "value"
            "name": "cinder_services_up",
            "statement": "select concat_ws('/', 'services', replace(replace(s1.binary, 'nova-', ''), 'cinder-', ''), 'up') as metric, count( as value from services s1 left outer join services s2 on = and s1.disabled=0 and s1.deleted=0 and timestampdiff(SECOND,s1.updated_at,utc_timestamp())<=120 group by s1.binary",
            "results": [
                    "instance_from": "metric",
                    "value_from": "value"
            "name": "cinder_services_disabled",
            "statement": "select concat_ws('/', 'services', replace(replace(s1.binary, 'nova-', ''), 'cinder-', ''), 'disabled') as metric, count( as value from services s1 left outer join services s2 on = and s2.disabled = 1 and s1.deleted=0 group by s1.binary",
            "results": [
                    "instance_from": "metric",
                    "value_from": "value"

Create global configuration file for Snap and set path to setfile (see examples/configs/snap-config-sample.json):

    "control": {
        "plugins": {
            "collector": {
                "dbi": {
                    "all": {
                        "setfile": "/path/to/dbi_cinder_services.json"
            "publisher": {},
            "processor": {}

Run the Snap daemon with created global config:

$ snapteld -l 1 -t 0 --config snap-config-sample.json

Download and load dbi plugin for collecting and file publisher:

$ wget
$ wget
$ chmod 755 snap-plugin-*
$ snaptel plugin load snap-plugin-collector-dbi
Plugin loaded
Name: dbi
Version: 4
Type: collector
Signed: false
Loaded Time: Tue, 05 Apr 2016 07:49:53 UTC
$ snaptel plugin load snap-plugin-publisher-file
Plugin loaded
Name: file
Version: 4
Type: publisher
Signed: false
Loaded Time: Tue, 05 Apr 2016 07:49:54 UTC

See available metrics:

$ snaptel metric list

NAMESPACE                                        VERSIONS
/intel/dbi/cinder/services/backup/disabled       4
/intel/dbi/cinder/services/backup/down           4
/intel/dbi/cinder/services/backup/up             4
/intel/dbi/cinder/services/scheduler/disabled    4
/intel/dbi/cinder/services/scheduler/down        4
/intel/dbi/cinder/services/scheduler/up          4
/intel/dbi/cinder/services/volume/disabled       4
/intel/dbi/cinder/services/volume/down           4
/intel/dbi/cinder/services/volume/up             4

Create and load example task file, which describes collection of cinder services dbi metrics (see examples/tasks/dbi_cinder_services-file.json):

    "version": 1,
    "schedule": {
        "type": "simple",
        "interval": "1s"
    "workflow": {
        "collect": {
            "metrics": {
                "/intel/dbi/cinder/services/backup/disabled": {},
                "/intel/dbi/cinder/services/backup/down": {},
                "/intel/dbi/cinder/services/backup/up": {},
                "/intel/dbi/cinder/services/scheduler/disabled": {},
                "/intel/dbi/cinder/services/scheduler/down": {},
                "/intel/dbi/cinder/services/scheduler/up": {},
                "/intel/dbi/cinder/services/volume/disabled": {},
                "/intel/dbi/cinder/services/volume/down": {},
                "/intel/dbi/cinder/services/volume/up": {}
            "config": {},
            "process": null,
            "publish": [
                    "plugin_name": "file",
                    "config": {
                        "file": "/tmp/published_dbi_cinder_services.txt"
$ snaptel task create -t dbi_cinder_services-file.json
Using task manifest to create task
Task created
ID: da9188b4-d592-4b45-b108-de06a8fdee1a
Name: Task-da9188b4-d592-4b45-b108-de06a8fdee1a
State: Running

See sample output from snaptel task watch <task_id>

$ snaptel task watch da9188b4-d592-4b45-b108-de06a8fdee1a

Watching Task (da9188b4-d592-4b45-b108-de06a8fdee1a):
NAMESPACE                                        DATA                    TIMESTAMP                                       SOURCE
/intel/dbi/cinder/services/backup/disabled       0                       2016-04-05 08:43:12.135743129 +0000 UTC         node-22.domain.tld
/intel/dbi/cinder/services/backup/down           0                       2016-04-05 08:43:12.135787905 +0000 UTC         node-22.domain.tld
/intel/dbi/cinder/services/backup/up             1                       2016-04-05 08:43:12.135734564 +0000 UTC         node-22.domain.tld
/intel/dbi/cinder/services/scheduler/disabled    0                       2016-04-05 08:43:12.135790187 +0000 UTC         node-22.domain.tld
/intel/dbi/cinder/services/scheduler/down        0                       2016-04-05 08:43:12.135674327 +0000 UTC         node-22.domain.tld
/intel/dbi/cinder/services/scheduler/up          1                       2016-04-05 08:43:12.135736637 +0000 UTC         node-22.domain.tld
/intel/dbi/cinder/services/volume/disabled       0                       2016-04-05 08:43:12.135716351 +0000 UTC         node-22.domain.tld
/intel/dbi/cinder/services/volume/down           0                       2016-04-05 08:43:12.135738704 +0000 UTC         node-22.domain.tld
/intel/dbi/cinder/services/volume/up             1                       2016-04-05 08:43:12.135785904 +0000 UTC         node-22.domain.tld

(ctrl+c terminates task watcher)

Metrics are published to file (in this example in /tmp/published_dbi_cinder_services.txt).

Stopping task:

$ snaptel task stop da9188b4-d592-4b45-b108-de06a8fdee1a
Task stopped:
ID: da9188b4-d592-4b45-b108-de06a8fdee1a


There isn't a current roadmap for this plugin, but it is in active development. As we launch this plugin, we do not have any outstanding requirements for the next release.

If you have a feature request, please add it as an issue.

Community Support

This repository is one of many plugins in the Snap Framework: a powerful telemetry agent framework. The full project is at

To reach out to other users, head to the main framework or visit Slack.


We love contributions!

There's more than one way to give back, from examples to blogs to code updates. See our recommended process in


Snap, along with this plugin, is an Open Source software released under the Apache 2.0 License.


List authors, co-authors and anyone you'd like to mention

Thank you! Your contribution is incredibly important to us.