Giter VIP home page Giter VIP logo

sidewinder-grafana's Introduction

Sidewinder Grafana Datasource

Grafana Datasource for Sidewinder Time Series Database

About Sidewinder

Sidewinder is an open source fast time series database designed for real-time analytics. It can be used for a variety of usage cases that need storage of metrics data like APM and IoT. You can learn more about Sidewinder at http://sidewinder.srotya.com or https://github.com/srotya/sidewinder

How to build?

To build this plugin:

  1. git clone https://github.com/srotya/sidewinder-grafana.git
  2. cd sidewinder-grafana
  3. npm -g install yarn; yarn install; npm run build
  4. cp -r ./dist /var/lib/grafana/plugins/sidewinder on Linux

How to use?

Pre-requisites

Make sure you have deployed Sidewinder and have the REST URL available. By default Sidewinder runs on port 8080

Create Datasource

To create a new Sidewinder Grafana datasource:

  1. open Grafana
  2. Click Grafana Icon->Data Sources
  3. Click Add data source
  4. Give the data source a name
  5. Select Type to Sidewinder
  6. Provide the Url to http://sidewinder-host:sidewinder-port/database-name
  7. Leave Access to proxy
  8. [Optional] Configure Basic Auth if authentication is enabled on Sidewinder
  9. Click Add
Note: If you don't have a database created, you can use the _internal database used to store DB's performance metrics

Here's how an example data source should look like: Data Source Create

Create a Query Visually

Sidewinder support visual query building using an editor. There is support for auto-complete for all non-numeric fields (Measurement, Value Field, Tags). Please refer to Sidewinder data model to understand the significance of different concepts.

Note: As of plugin version 0.2.0, Tag Key Value support is added to the Grafana plugin. Sidewinder version 0.0.38+ is needed for Key Value support

Here's how an example Visual Query should look like: Data Source Edit

Create a Query using TSQL

You can also use the Time Series Query Language to create panels. Please note that because Grafana provides the time ranges, you can't provide start and end time in the TSQL string. Please refer to the docs for more details on TSQL.

Here's how an example TSQL Query should look like: Data Source Edit Raw

Create Templates

Because Sidewinder supports TSQL, grafana templated dashboards can be created. You can create auto-complete suggestions for variables:

  1. For FIELD name suggestion simply type measurementname in the "metric name or tag query field"
  2. For TAG suggestion simply type measurementname.* in the "metric name or tag query field"

Here's how an example Templated Dashboard should look like: Data Source Template Edit

sidewinder-grafana's People

Contributors

ambud avatar daniellee avatar

Watchers

 avatar

sidewinder-grafana's Issues

plugin at risk of deprecation

Hi there from Grafana Labs ๐Ÿ‘‹

Firstly, thank you for contributing to the Grafana plugin ecosystem.

I'm reaching out as this plugin is at risk of being deprecated from the Grafana plugin catalog as it depends on Angular, which is deprecated and support for which is about to end.

We recognise that priorities change and that it may no longer be possible to keep plugins up to date. For your awareness, deprecation has no impact on existing users of the plugin, but discourages further adoption to prevent users from starting to rely on a component which won't receive updates.

Please advise if you have plans to update this plugin, or alternatively that you agree the plugin should be deprecated. In the case of the latter, if there is any specific guidance you would like to offer users of the plugin - please let me know and we can include this in the deprecation notice.

Feel free to email me at [email protected] if preferred; apologies, we don't have an email address associated with this plugin so I had to raise an issue.

If we don't hear from you within 30 days, I'll go ahead and deprecate the plugin.

Thank you again
David

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.