Schema to use when posting data points to the Metrics Integration API
{
"metric": "your-metric",
"data": 10,
"source": "www.your-source.com",
"key": "dev",
"tags": { "key": "value" },
"utc_offset": "GMT-07:00"
}
Required fields
data
float
The numerical value of the data point.
metric
string
A human-readable description of the metric. A good description summarizes the exact condition that the metric measures. You can also specify this in the description itself or in the unit field described below. Examples include:
"en0 bandwidth util %"
`"myApp response time msec"
"myWebService 4xx https responses/sec %"
"myService available"
When Moogsoft creates or updates an alert with a new metric, this description becomes the alert description.
source
string
The server, node, or other entity that generated the metric. This can be any unique, human-readable name such as a hostname, fully qualified domain name, or URL.
In some cases, a process or application might trigger a metric that has no node identification. In this case, specify a unique identifier of the generating instance such as a database name, container name, or cluster node name.
Optional fields
class
string
The high-level classification of the metric. Examples include Application, Storage, Network, Operating System, Middleware, Hardware, Virtualization, Serverless, Database, Cloud, and API.
This field determines the class field in the resulting alert. Alert classes can be useful for correlating alerts into incidents. See Correlate Alerts into Incidents.
key
string
This field is useful for classifying different metrics that share the same description. For example, the metric name might be "throughput in bps" and the key might be "eth0".
tags
JSON object
Include additional information about an event using the tags key. Specify data as an array or as a series of key-value pairs.
time
UTC timestamp
You can specify the time in either seconds or milliseconds. If the payload does not include a time, Moogsoft uses the datum arrival time.
utc-offset
string
The difference in hours from Coordinated Universal Time (UTC) for the event time. If the event timestamp is in local time, make sure that the utc_offset is specified to ensure that all event times are based on the same context. Use the following format:
GMT-07:00 — GMT minus 7 hours
GMT+07:30 — GMT plus 7 hours 30 minutes