Create an annotation event on the given annotation stream :name. If the annotation stream does not exist, it will be created automatically

Options

namedescriptionrequiredchoices
user Librato account username true
api_key Librato account api key true
name
  • The annotation stream name
  • If the annotation stream does not exist, it will be created automatically
title
  • The title of an annotation is a string and may contain spaces
  • The title should be a short, high-level summary of the annotation e.g. v45 Deployment
true
source 1. string which describes the originating source of an annotation when that annotation is tracked across multiple members of a population
description
  • The description contains extra meta-data about a particular annotation
  • The description should contain specifics on the individual annotation e.g. Deployed 9b562b2 shipped new feature foo!
start_time The unix timestamp indicating the the time at which the event referenced by this annotation started
end_time
  • The unix timestamp indicating the the time at which the event referenced by this annotation ended
  • For events that have a duration, this is a useful way to annotate the duration of the event
links See examples true

Author

Seth Edwards (@sedward)