https://github.com/danesparza/influx-annotate

Command line tool to add annotations to an InfluxDB database
https://github.com/danesparza/influx-annotate

annotations batch-file command-line command-line-tool grafana influxdb script

Last synced: 1 day ago
JSON representation

Command line tool to add annotations to an InfluxDB database

• Host: GitHub
• URL: https://github.com/danesparza/influx-annotate
• Owner: danesparza
• License: mit
• Archived: true
• Created: 2017-04-19T15:21:02.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-04-19T19:01:08.000Z (over 7 years ago)
• Last Synced: 2024-08-02T15:48:10.645Z (3 months ago)
• Topics: annotations, batch-file, command-line, command-line-tool, grafana, influxdb, script
• Language: Go
• Size: 7.81 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# influx-annotate [![CircleCI](https://circleci.com/gh/danesparza/influx-annotate.svg?style=svg)](https://circleci.com/gh/danesparza/influx-annotate)

Command line tool to add annotations to an InfluxDB database.  

Suitable for batch files, deployment scripts, unicorn logging

## Quick start 

* Make sure you've already got [InfluxDB](https://docs.influxdata.com/influxdb/v1.2/introduction/installation/) up and running.  In InfluxDb, [create the database](https://docs.influxdata.com/influxdb/v1.2/guides/writing_data/#creating-a-database-using-the-http-api) that you want to log to.

* Get the [latest release](https://github.com/danesparza/influx-annotate/releases/latest) for your platform (it's just a single executable) 

* Log your annotation data:

```

influx-annotate -server="http://your-influxdb-server:8086" -tags="application=Super unicorn app" -value="Build_20170414.2"

```

If you need help, just run `influx-annotate -h`.

There are a few command line parameters available:

Parameter       | Description

----------      | -----------

server          | The [InfluxDB server](https://docs.influxdata.com/influxdb/v1.2/concepts/glossary/#server) to use.  Defaults to 'http://localhost:8086'

database        | The [InfluxDB database](https://docs.influxdata.com/influxdb/v1.2/concepts/glossary/#database) to use. Defaults to 'events'

name            | The [measurement name](https://docs.influxdata.com/influxdb/v1.2/concepts/glossary/#measurement).  Defaults to 'build'

value           | The [measurement value](https://docs.influxdata.com/influxdb/v1.2/concepts/glossary/#field-value)

tags            | Comma separated list of [tags](https://docs.influxdata.com/influxdb/v1.2/concepts/glossary/#tag-set).  Example: `application=My app name,env=dev,machine=server01`