Annotation

User Guide | Data Model

---

Annotation

The Annotation object encapsulates event information that can be associated with a time series.

Name	Type	Description
scope	string	The scope of the annotation.
metric	string	The name of the time series metric associated with the event.
tags	map<string,string>	A map of tag key value pairs for the annotation.
source	string	A user supplied description of the event data source.
id	string	A user supplied unique ID generated by the event data source.
timestamp	long	The epoch timestamp at which the event occurred.
fields	map<string,string>	A map of arbitrary key-value pairs describing the event details.

Example Annotation Entity:

{
  "scope": "argus.jvm",
  "metric": "file.descriptor.open",
  "tags": {
    "host": "app4-1-argus.net"
  },
  "source": "ARGUS-ALERTS",
  "id": "ID",
  "timestamp": 1446845640000,
  "type": "ALERT",
  "fields": {
    "Notification Name": "WARNING: Argus File Descriptors",
    "Trigger Name": "Open Descriptors >= 1000",
    "Alert Name": "ARGUS: File Descriptor Alert",
    "user": "admin",
    "Tags": "{host=app4-1-argus.net}"
  }
}