diff --git a/docs/sources/glossary.md b/docs/sources/glossary.md deleted file mode 100644 index 0afd0055748..00000000000 --- a/docs/sources/glossary.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -title: "Glossary" -description: "" -weight: 999 ---- - -### Blocks storage - -The blocks storage is a Mimir storage engine based on Prometheus TSDB, which only requires an object store (eg. AWS S3, Google GCS, ...) as backend storage. - -While when running Mimir with the [blocks storage](#blocks-storage) a single chunk contains timestamp-value pairs for several series. - -For more information, see the [Mimir blocks storage](../blocks-storage/_index.md) documentation. - -### Chunk - -A chunk is an object containing encoded timestamp-value pairs for one series. - -### Churn - -Churn is the frequency at which series become idle. - -A series become idle once it's not exported anymore by the monitored targets. Typically, series become idle when the monitored target itself disappear (eg. the process or node gets terminated). - -### Flushing - -Series flushing is the operation run by ingesters to offload time series from memory and store them in the long-term storage. - -### HA Tracker - -The HA Tracker is a feature of Mimir distributor which is used to deduplicate received series coming from two (or more) Prometheus servers configured in HA pairs. - -For more information, please refer to the guide "[Config for sending HA Pairs data to Mimir](../guides/ha-pair-handling.md)". - -### Hash ring - -The hash ring is a distributed data structure used by Mimir for sharding, replication and service discovery. The hash ring data structure gets shared across Mimir replicas via gossip or a key-value store. - -For more information, please refer to the [Architecture](../architecture.md#the-hash-ring) documentation. - -### Org - -_See [Tenant](#tenant)._ - -### Ring - -_See [Hash ring](#hash-ring)._ - -### Sample - -A sample is a single timestamped value in a time series. - -For example, given the series `node_cpu_seconds_total{instance="10.0.0.1",mode="system"}` its stream of values (samples) could be: - -``` -# Display format: @ -11775 @1603812134 -11790 @1603812149 -11805 @1603812164 -11819 @1603812179 -11834 @1603812194 -``` - -### Series - -In the Prometheus ecosystem, a series (or time series) is a single stream of timestamped values belonging to the same metric, with the same set of label key-value pairs. - -For example, given a single metric `node_cpu_seconds_total` you may have multiple series, each one uniquely identified by the combination of metric name and unique label key-value pairs: - -``` -node_cpu_seconds_total{instance="10.0.0.1",mode="system"} -node_cpu_seconds_total{instance="10.0.0.1",mode="user"} -node_cpu_seconds_total{instance="10.0.0.2",mode="system"} -node_cpu_seconds_total{instance="10.0.0.2",mode="user"} -``` - -### Tenant - -A tenant (also called "user" or "org") is the owner of a set of series written to and queried from Mimir. Mimir multi-tenancy support allows you to isolate series belonging to different tenants. For example, if you have two tenants `team-A` and `team-B`, `team-A` series will be isolated from `team-B`, and each team will be able to query only their own series. - -For more information, please refer to: - -- [HTTP API authentication](../api/_index.md#authentication) -- [About tenant IDs]({{}}) - -### Time series - -_See [Series](#series)._ - -### User - -_See [Tenant](#tenant)._ - -### WAL - -The Write-Ahead Log (WAL) is an append only log stored on disk used by ingesters to recover their in-memory state after the process gets restarted, either after a clear shutdown or an abruptly termination. The WAL is supported by blocks storage engines. - -For more information, see [Ingesters with WAL](../blocks-storage/_index.md#the-write-path). diff --git a/docs/sources/reference-glossary.md b/docs/sources/reference-glossary.md new file mode 100644 index 00000000000..8933c78beee --- /dev/null +++ b/docs/sources/reference-glossary.md @@ -0,0 +1,108 @@ +--- +title: "Reference: Glossary" +description: "" +weight: 10000 +--- + +# Reference: Glossary + +## Blocks storage + +Blocks storage is the Mimir storage engine based on the Prometheus TSDB. +Grafana Mimir stores blocks in object stores such as AWS S3, Google Cloud Storage (GCS), Azure blob storage, or OpenStack Object Storage (Swift). +For the full list of supported backends and more information, refer to [Blocks storage]({{}}) + +## Chunk + +A chunk is an object containing encoded timestamp-value pairs for one series. + +## Churn + +Churn is the frequency at which series become idle. + +A series becomes idle once it's no longer exported by the monitored targets. +Typically, series become idle when a monitored target process or node gets terminated. + +## Flushing + +Flushing is the operation run by ingesters to offload time series from memory and store them in the long-term storage. + +## Gossip + +Gossip is a protocol by which components coordinate without the need for a centralized [key-value store]({{}}). + +## HA tracker + +The HA tracker is a feature of the Grafana Mimir distributor. +It deduplicates time series received from two or more Prometheus servers that are configured to scrape the same targets. +To configure HA tracking, refer to [Configure HA deduplication]({{}}). + +## Hash ring + +The hash ring is a distributed data structure used by Grafana Mimir for sharding, replication, and service discovery. +Components use a [key-value store]({{}}) or [gossip]({{}}) to share the hash ring data structure. +For more information, refer to the [About the hash ring]({{}}). + +## Key-value store + +A key-value store is a database that associates keys with values. +To understand how Grafana Mimir uses key-value stores, refer to [About the key-value store]({{}}). + +## Memberlist + +Memberlist manages cluster membership and member failure detection using [gossip]({{}}). + +## Org + +Refer to [Tenant]({{}}). + +## Ring + +Refer to [Hash ring]({{}}). + +## Sample + +A sample is a single timestamped value in a time series. + +Given the series `node_cpu_seconds_total{instance="10.0.0.1",mode="system"}` its stream of samples may look like: + +``` +# Display format: @ +11775 @1603812134 +11790 @1603812149 +11805 @1603812164 +11819 @1603812179 +11834 @1603812194 +``` + +## Series + +A series is a single stream of [samples]({{}}) belonging to the same metric, with the same set of label key-value pairs. + +Given a single metric `node_cpu_seconds_total` you may have multiple series, each one uniquely identified by the combination of metric name and unique label key-value pairs: + +``` +node_cpu_seconds_total{instance="10.0.0.1",mode="system"} +node_cpu_seconds_total{instance="10.0.0.1",mode="user"} +node_cpu_seconds_total{instance="10.0.0.2",mode="system"} +node_cpu_seconds_total{instance="10.0.0.2",mode="user"} +``` + +## Tenant + +A tenant is the owner of a set of series written to and queried from Grafana Mimir. +Grafana Mimir isolates series and alerts belonging to different tenants. +To understand how Grafana Mimir authenticates tenants, refer to [About authentication and authorization]({{}}). + +## Time series + +Refer to [Series]({{}}). + +## User + +Refer to [Tenant]({{}}). + +## Write-ahead log (WAL) + +The write-ahead Log (WAL) is an append only log stored on disk by ingesters to recover their in-memory state after the process gets restarted. +For more information, refer to [The write path]({{}}).