Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/doublemarket/grafana-rrd-server

A HTTP server that helps Grafana read RRD files via Grafana Simple JSON Datasource plugin
https://github.com/doublemarket/grafana-rrd-server

go grafana rrdtool

Last synced: about 2 months ago
JSON representation

A HTTP server that helps Grafana read RRD files via Grafana Simple JSON Datasource plugin

Host: GitHub
URL: https://github.com/doublemarket/grafana-rrd-server
Owner: doublemarket
License: mit
Created: 2017-01-11T09:30:23.000Z (about 8 years ago)
Default Branch: master
Last Pushed: 2023-11-03T12:57:03.000Z (over 1 year ago)
Last Synced: 2024-12-10T00:42:15.554Z (about 2 months ago)
Topics: go, grafana, rrdtool
Language: Go
Homepage:
Size: 178 KB
Stars: 154
Watchers: 20
Forks: 38
Open Issues: 24
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Grafana RRD Server

A simple HTTP server that reads RRD files and responds to requests from Grafana with [Grafana Simple JSON Datasource plugin](https://grafana.net/plugins/grafana-simple-json-datasource).

[![CircleCI](https://img.shields.io/circleci/project/github/doublemarket/grafana-rrd-server.svg)](https://circleci.com/gh/doublemarket/grafana-rrd-server)
[![Coveralls](https://img.shields.io/coveralls/doublemarket/grafana-rrd-server.svg)](https://coveralls.io/github/doublemarket/grafana-rrd-server)
[![GitHub release](https://img.shields.io/github/release/doublemarket/grafana-rrd-server.svg)](https://github.com/doublemarket/grafana-rrd-server/releases)

This server supports all endpoints (urls) defined in the [Grafana Simple JSON Datasource plugin documentation](https://grafana.net/plugins/grafana-simple-json-datasource) but:

- You can use `*` as a wildcard in the `target` values (but not for `ds`) for the `/query` endpoint.

# Requirement

- librrd-dev (rrdtool)
- Go
- Grafana 3.0 and newer + Simple JSON Datasource plugin 1.0.0 and newer

# Usage

1. Install librrd-dev (rrdtool).

On Ubuntu/Debian:

```
sudo apt install librrd-dev
```

On CentOS:

```
sudo yum install rrdtool-devel
```

On openSUSE
```
sudo zypper in rrdtool-devel
```

On Mac:

```
brew install rrdtool
```

2. Get the package.

```
go get github.com/doublemarket/grafana-rrd-server
```

Otherwise, download [the latest release](https://github.com/doublemarket/grafana-rrd-server/releases/latest), gunzip it, and put the file in a directory included in `$PATH`:

```
gunzip grafana-rrd-server_linux_amd64.gz
```

3. Run the server.

```
grafana-rrd-server
```

You can use the following options:

- `-h` : Shows help messages.
- `-p` : Specifies server port. (default: 9000)
- `-i` : Specifies server listen address. (default: any)
- `-r` : Specifies a directory path keeping RRD files. (default: "./sample/")
- The server recursively searches RRD files under the directory and returns a list of them for the `/search` endpoint.
- `-a` : Specifies the annotations file. It should be a CSV file which has a title line at the top like [the sample file](https://github.com/doublemarket/grafana-rrd-server/tree/master/sample/annotations.csv).
- `-s` : Default graph step in second. (default: 10)
- You can see the step for your RRD file using:
```
$ rrdtool info [rrd file] | grep step
step = 300
```

4. Optionally set up systemd unit:

```
useradd grafanarrd
cat > /etc/systemd/system/grafana-rrd-server.service <