Merge lp:~lucio.torre/graphite/add-events into lp:~graphite-dev/graphite/main

[Lucio Torre]

Add events to graphite.

Events are instantaneous occurrences that we want to track and correlate with our current metrics. Sample events are rollouts, reboots, errors, etc.

Events store the following information: summary, date, tags and "extra data", where you can store whatever you might need. This can all be edited from the admin: http://ubuntuone.com/p/16CJ/

You can add events from the command line using curl:
$ curl -X POST http://localhost:8000/events/ -d '{"what": "Something Interesting"}'

So its very easy to integrate with other tools.

You can see the list of events from: http://localhost:8000/events/ and get to the event details by clicking on its line. (eg, http://localhost:8000/events/4)

Then, using the graphlot ui you can overlay events into a graph by selecting tags that would filter the events or just '*' to select all.

Events get overlayed in the graph, you get a tooltip with the summary when hovering over it and when you click on it you go to the details page.

In order to make developing/testing this easier, there are also some new functions that generate data, so you can see a plot for whatever date you want without having real data.

See: http://ubuntuone.com/p/16CY/

[lp:~lucio.torre/graphite/add-events]

306. By Lucio Torre on 2011-07-25

merged with trunk

307. By Lucio Torre on 2011-07-25

removed dirt.

[Sidnei da Silva (sidnei)]

Looks pretty ok to me. A few comments, but none of them blockers:

[1] arrays_equal has a few issues the way it's implemented, but should work given how it's used. There's a really nice array comparison implementation here: http://www.breakingpar.com/bkp/home.nsf/0/87256B280015193F87256BFB0077DFFD

[2] I'm worried about the use of 'autoescape off' here, since basically you could inject some javascript through post_event handler and have it rendered unsanitized into the template, but Lucio pointed out there's more templates already using 'autoescape off' in the tree. Probably deserves some checking all around. It doesn't seem like removing it from those newly introduced templates would break them though.

review: Approve

[Aman Gupta (tmm1)]

I really like the new test functions. Can you add some docs for http://readthedocs.org/docs/graphite/en/latest/functions.html

Also we should document the new dependency on django.tagging in requirements.txt and in the docs somewhere.

[Aman Gupta (tmm1)]

As discussed on IRC, it would be nice to expose these new events to the server-side graphing api as well. Probably as a new function: events(tag, tag, ...), which could query the Events model and generate a TimeSeries to graph.

[Lucio Torre (lucio.torre)]

updated js array comparison to include the one in the link
removed the autoescape for all event related templates
documented test functions
added django-tagging to requirements
added events(*tags) function for use with drawAsInfinite
fixed bug on events tooltips.

[lp:~lucio.torre/graphite/add-events]

308. By Lucio Torre on 2011-08-23

merged with trunk

309. By Lucio Torre on 2011-08-23

fixes, documentation and new events functions

310. By Lucio Torre on 2011-08-23

more doc

[chrismd (chrismd)]

Looks great, unfortunately I could not merge it into trunk because we haven't upgraded the repo to 2a format yet. The diff however applied cleanly as a patch, which I just committed to trunk.

review: Approve

[DiegoV (diego-varese)]

Looks like your code does not work with a MySQL backend:

https://bugs.launchpad.net/graphite/+bug/1068861

[Dieter P (dieter-plaetinck)]

IMHO managing annotated events has nothing do with time series data; I feel like trying to bolt that logic onto graphite is a bit awkward and requires a lot of code additions/changes precisely because this is a different problem domain.
Based on that realization I wrote a small tool for annotated event management (with similar input/output API's as graphite): http://dieter.plaetinck.be/anthracite-event-database-enrich-monitoring-dashboards-visual-numerical-analysis-events-business-impact.html