jsgrafana

1.0.5 • Public • Published

jsGrafana

jsGrafana is a Javascript module for working with the Grafana API.

Requirements

  • Tested against Grafana HTTP API
  • For Node.js you will need the xmlhttprequest library.

Documentation

Getting Started

If you are using Node.js, install jsGrafana using npm:

$ npm install jsgrafana

You can now require and use jsgrafana like so:

let GrafanaAPI = require('jsgrafana')

const GRAFANA_URL = process.env.GRAFANA_URL
const GRAFANA_LOGIN = process.env.GRAFANA_LOGIN
const GRAFANA_PASSWORD = process.env.GRAFANA_PASSWORD
const GRAFANA_TOKEN = process.env.GRAFANA_TOKEN

let gfapi1 = new GrafanaAPI(GRAFANA_URL, GRAFANA_LOGIN, GRAFANA_PASSWORD)
let gfapi2 = new GrafanaAPI(GRAFANA_URL, GRAFANA_TOKEN)

gfapi1.getOrganizations().then((data) => {
  console.log(data)
})

gfapi2.getCurrentOrganization().then((data) => {
  console.log(data)
})

Refer to the Grafana API Documentation and the jsGrafana Example for more information.

Browser

You can also load this script on your browser like so:

<script src='https://cdn.jsdelivr.net/npm/jsgrafana/jsGrafana.js'></script>

You can now use the class GrafanaAPI normally on the page, like you would on Node.js.

License

jsGrafana - Grafana API Javascript Library.
Copyright (C) 2019  Guilherme Caulada (Sighmir)

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.

Readme

Keywords

Package Sidebar

Install

npm i jsgrafana

Weekly Downloads

2

Version

1.0.5

License

GPL-3.0

Unpacked Size

52.8 kB

Total Files

6

Last publish

Collaborators

  • sighmir