Plugins 〉Simple Annotations


Developer

Farid Zakaria

Sign up to receive occasional product news and updates:


Grafana Cloud
ObservabilityCON on the Road: Chicago (Mar 11)

See demos of new Grafana Cloud observability workflows, hear community success stories, and leave with what you need to advance your observability roadmap.


This plugin has been deprecated as it is no longer maintained, and requires new maintainers and contributions. For an alternative, check for existing annotation support within your datasources.
Data Source
community

Simple Annotations

  • Overview
  • Installation
  • Related content

Grafana Simple Annotations Plugin

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

This is a simple annotation plugin for Grafana 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.

  "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

Screenshot 2

Development

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

Installing Simple Annotations on Grafana Cloud:

For more information, visit the docs on plugin installation.

Installing on a local Grafana:

For local instances, plugins are installed and updated via a simple CLI command. Plugins are not updated automatically, however you will be notified when updates are available right within your Grafana.

1. Install the Data Source

Use the grafana-cli tool to install Simple Annotations from the commandline:

grafana-cli plugins install 

The plugin will be installed into your grafana plugins directory; the default is /var/lib/grafana/plugins. More information on the cli tool.

2. Configure the Data Source

Accessed from the Grafana main menu, newly installed data sources can be added immediately within the Data Sources section.

Next, click the Add data source button in the upper right. The data source will be available for selection in the Type select box.

To see a list of installed data sources, click the Plugins item in the main menu. Both core data sources and installed data sources will appear.