From 702672c00c7d2c9896117d200e967dd90dd17232 Mon Sep 17 00:00:00 2001 From: Julien Danjou Date: Wed, 11 May 2016 16:59:13 +0200 Subject: [PATCH] doc: add a glossary Change-Id: I3bf4d6be8996c3ede0ae58dd14c054bd53982659 --- doc/source/glossary.rst | 33 +++++++++++++++++++++++++++++++++ doc/source/index.rst | 1 + 2 files changed, 34 insertions(+) create mode 100644 doc/source/glossary.rst diff --git a/doc/source/glossary.rst b/doc/source/glossary.rst new file mode 100644 index 000000000..4dcb0b451 --- /dev/null +++ b/doc/source/glossary.rst @@ -0,0 +1,33 @@ +======== +Glossary +======== + +.. glossary:: + + Resource + An entity representing anything in your infrastructure that you will + associate metric(s) with. It is identified by a unique ID and can contain + attributes. + + Metric + An entity storing measures identified by an UUID. It can be attached to a + resource using a name. How a metric stores its measure is defined by the + archive policy it is associated to. + + Measure + A datapoint tuple composed of timestamp and a value. + + Archive policy + A measure storage policy attached to a metric. It determines how long + measures will be kept in a metric and how they will be aggregated. + + Granularity + The time between two measures in an aggregated timeseries of a metric. + + Timeseries + A list of measures. + + Aggregation method + Function used to aggregate multiple measures in one. For example, the + `min` aggregation method will aggregate the values of different measures + to the minimum value of all the measures in time range. diff --git a/doc/source/index.rst b/doc/source/index.rst index e16e5e113..a23ef034f 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -67,5 +67,6 @@ Documentation rest statsd grafana + glossary .. _`OpenStack`: http://openstack.org