https://github.com/fzakaria/simple-annotations-plugin

A simple Grafana annotations plugin that works with any datasource.
https://github.com/fzakaria/simple-annotations-plugin

angular grafana grafana-dashboard grafana-datasource javascript typescript

Last synced: about 2 months ago
JSON representation

A simple Grafana annotations plugin that works with any datasource.

• Host: GitHub
• URL: https://github.com/fzakaria/simple-annotations-plugin
• Owner: fzakaria
• License: mit
• Created: 2017-09-03T18:35:28.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2023-12-15T15:26:33.000Z (9 months ago)
• Last Synced: 2024-06-03T00:34:54.377Z (4 months ago)
• Topics: angular, grafana, grafana-dashboard, grafana-datasource, javascript, typescript
• Language: TypeScript
• Size: 252 KB
• Stars: 6
• Watchers: 5
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Authors: AUTHORS

Awesome Lists containing this project

README

        
# Grafana Simple Annotations Plugin

> **This repository is seeking a maintainer.** The plugin also needs to be updated to React in accordance with [Issue 2](https://github.com/fzakaria/simple-annotations-plugin/issues/2).

> Please cut an issue if you are interested and put forward a PR to show your willingness. Thank you.

*Frustrated with using a datasource that doesn't support annotations?*

This is a *simple annotation* plugin for [Grafana](https://grafana.com/) that works with **any** Datasource!

It works by using the `dashboard.json` itself as the store for annotations -- this means that you can easily backup / save / share your annotations.

```json

  "annotations": {

    "list": [

      {

        "datasource": "${DS_SIMPLE_ANNOTATION}",

        "enable": true,

        "hide": false,

        "iconColor": "rgba(255, 96, 96, 1)",

        "limit": 100,

        "name": "Deployments",

        "queries": [

          {

            "date": "2017-09-03T19:56:36.000Z",

            "text": "First Deployment"

          },

          {

            "date": "2017-09-03T20:56:53.000Z",

            "text": "Second Deployment"

          },

          {

            "date": "2017-09-03T21:56:56.000Z",

            "text": "Third Deployment"

          }

        ],

        "showIn": 0,

        "type": "alert"

      }

    ]

  },

```

![Screenshot 1](https://raw.githubusercontent.com/fzakaria/simple-annotations-plugin/master/dist/img/screenshot_1.png "Screenshot 1")

![Screenshot 2](https://raw.githubusercontent.com/fzakaria/simple-annotations-plugin/master/dist/img/screenshot_2.png "Screenshto 2")

## Development

```bash

mkdir grafana

export GOPATH=`pwd`

go get github.com/grafana/grafana

cd $GOPATH/src/github.com/grafana/grafana

go run build.go setup

go run build.go build

npm install

npm install -g grunt-cli

grunt

mkdir -p data/plugins

ln -s ~/Development/simple-annotations data/plugins/simple-annotations

./bin/grafana-server

```