OpenMetrics, a cloud-native, highly scalable metrics protocol
draft-richih-opsawg-openmetrics-00
Ops WG R. Hartmann, Ed.
Internet-Draft Grafana Labs
Intended status: Standards Track B. Kochie
Expires: May 29, 2021 GitLab
B. Brazil
Robust Perception
R. Skillington
Chronosphere
November 25, 2020
OpenMetrics, a cloud-native, highly scalable metrics protocol
draft-richih-opsawg-openmetrics-00
Abstract
OpenMetrics specifies today's de-facto standard for transmitting
cloud-native metrics at scale, with support for both text
representation and Protocol Buffers and brings it into IETF. It
supports both pull and push-based data collection.
Status of This Memo
This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet-
Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."
This Internet-Draft will expire on May 29, 2021.
Copyright Notice
Copyright (c) 2020 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents
(https://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect
Hartmann, et al. Expires May 29, 2021 [Page 1]
Internet-Draft OpenMetrics November 2020
to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1. Requirements Language . . . . . . . . . . . . . . . . . . 4
2. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . 4
2.1. Metrics and Time Series . . . . . . . . . . . . . . . . . 4
3. Data Model . . . . . . . . . . . . . . . . . . . . . . . . . 4
3.1. Data Types . . . . . . . . . . . . . . . . . . . . . . . 5
3.1.1. Values . . . . . . . . . . . . . . . . . . . . . . . 5
3.1.2. Timestamps . . . . . . . . . . . . . . . . . . . . . 5
3.1.3. Strings . . . . . . . . . . . . . . . . . . . . . . . 5
3.1.4. Label . . . . . . . . . . . . . . . . . . . . . . . . 5
3.1.5. LabelSet . . . . . . . . . . . . . . . . . . . . . . 5
3.1.6. MetricPoint . . . . . . . . . . . . . . . . . . . . . 5
3.1.7. Exemplars . . . . . . . . . . . . . . . . . . . . . . 6
3.1.8. Metric . . . . . . . . . . . . . . . . . . . . . . . 6
3.1.9. MetricFamily . . . . . . . . . . . . . . . . . . . . 6
3.2. Metric Types . . . . . . . . . . . . . . . . . . . . . . 8
3.2.1. Gauge . . . . . . . . . . . . . . . . . . . . . . . . 8
3.2.2. Counter . . . . . . . . . . . . . . . . . . . . . . . 8
3.2.3. StateSet . . . . . . . . . . . . . . . . . . . . . . 9
3.2.4. Info . . . . . . . . . . . . . . . . . . . . . . . . 9
3.2.5. Histogram . . . . . . . . . . . . . . . . . . . . . . 10
3.2.6. GaugeHistogram . . . . . . . . . . . . . . . . . . . 11
3.2.7. Summary . . . . . . . . . . . . . . . . . . . . . . . 11
3.2.8. Unknown . . . . . . . . . . . . . . . . . . . . . . . 12
4. Data transmission & wire formats . . . . . . . . . . . . . . 12
4.1. Protocol Negotiation . . . . . . . . . . . . . . . . . . 12
4.1.1. ABNF . . . . . . . . . . . . . . . . . . . . . . . . 13
4.1.2. Overall Structure . . . . . . . . . . . . . . . . . . 14
4.1.3. MetricFamily . . . . . . . . . . . . . . . . . . . . 17
4.1.4. MetricPoint . . . . . . . . . . . . . . . . . . . . . 18
4.1.5. Metric types . . . . . . . . . . . . . . . . . . . . 19
4.2. Protobuf format . . . . . . . . . . . . . . . . . . . . . 23
4.2.1. Overall Structure . . . . . . . . . . . . . . . . . . 23
Show full document text