The Wavefront data format is supported by Wavefront proxies and by direct ingestion. This is a reference to the Wavefront data format. See Wavefront Data Naming for additional best practices.
Supported Data Formats
Direct ingestion supports only the Wavefront data format.
Wavefront proxies support:
- Wavefront data format
- Graphite data format (plaintext and pickle)
- OpenTSDB data format (Telnet interface and HTTP API (JSON))
Wavefront Data Format Syntax
<metricName> <metricValue> [<timestamp>] source=<source> [pointTags]
Fields must be space separated and each line must be terminated with the newline character (\n or ASCII hex 0A).
Wavefront Data Format Fields
|metricName||Yes||Name of the metric.||Valid characters are: a-z, A-Z, 0-9, hyphen ("-"), underscore ("_"), dot ("."). Forward slash ("/") and comma (",") are allowed if metricName is enclosed in double quotes.
|metricValue||Yes||Value of the metric.||Number that can be parsed into a double-precision floating point number or a long integer. It can be positive, negative, or 0. In charts, the Wavefront UI represents values using SI and IEC/Binary units. See Units in Chart Axes and Legends.|
|timestamp||No||Timestamp of the metric.||Number that reflects the epoch seconds of the metric (e.g. 1382754475). When this field is omitted, the timestamp is set to the current time at the Wavefront proxy when the metric arrives.|
|source||Yes||Name of an application, host, container, instance, or any other unique source that is sending the metric to Wavefront.||Valid characters are: a-z, A-Z, 0-9, hyphen ("-"), underscore ("_"), dot ("."). The length of the source field should be less than 1024 characters. Using host= instead of source= is supported for backward compatibility but not recommended.|
|pointTags||No||Custom metadata associated with the metric.||An arbitrary number of key-value pairs separated by spaces: <k1>="<v1>" ... <kn>="<vn>".
Point tags cannot be empty, i.e.
Video: Point Tags and Source Tags
Watch the following video for an introduction to point tags and source tags:
Wavefront Data Format Best Practices
Follow best practices for improved query execution speed and meaningful results.
- Make the metrics the most stable part of your data:
- Do not include source names in the metric name. Wavefront captures sources separately.
- Do not include data or timestamps in the metric name. Each point has an associated time stamp.
- Aim for a metric hierarchy:
- Partition the top level of the metric hierarchy by including at least one dot.
- Organize metric names in a meaningful hierarchy from most general to most specific (i.e.
See Wavefront Data Naming for a more detailed discussion.
Valid and Invalid Metrics Examples
The following metrics are valid:
request.count 1001 source=test.wavefront.com
system.cpu.loadavg.1m 0.03 1382754475 source=test1.wavefront.com
marketing.adsense.impressions 24056 source=campaign1
new-york.power.usage 42422 source=localhost datacenter="dc1"
The following metrics are invalid. For each metric, we explain why it’s invalid.
system.cpu.load\# 0.03 source=test.wavefront.com
- Reason: Metric name has an invalid character (‘#’)
- Reason: No metric value
- Reason: No source field