From 12c39d5421cc29a4bfc13fc57fd9ccd3dbc310f0 Mon Sep 17 00:00:00 2001 From: beorn7 Date: Wed, 9 Oct 2024 14:32:12 +0200 Subject: [PATCH] docs: Some nitpicking in chunks.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - `float histogram` → `floathistogram`, as it is used in the code. - Actual link encodings to the code (to find the actual numerical values). - `` → `` for consistency. Signed-off-by: beorn7 --- tsdb/docs/format/chunks.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/tsdb/docs/format/chunks.md b/tsdb/docs/format/chunks.md index 41c91adc4e..7eb0820e44 100644 --- a/tsdb/docs/format/chunks.md +++ b/tsdb/docs/format/chunks.md @@ -29,14 +29,15 @@ in-file offset (lower 4 bytes) and segment sequence number (upper 4 bytes). # Chunk ``` -┌───────────────┬───────────────────┬──────────────┬────────────────┐ -│ len │ encoding <1 byte> │ data │ CRC32 <4 byte> │ -└───────────────┴───────────────────┴──────────────┴────────────────┘ +┌───────────────┬───────────────────┬─────────────┬────────────────┐ +│ len │ encoding <1 byte> │ data │ CRC32 <4 byte> │ +└───────────────┴───────────────────┴─────────────┴────────────────┘ ``` Notes: * `` has 1 to 10 bytes. -* `encoding`: Currently either `XOR`, `histogram`, or `float histogram`. +* `encoding`: Currently either `XOR`, `histogram`, or `floathistogram`, see + [code for numerical values](https://github.com/prometheus/prometheus/blob/02d0de9987ad99dee5de21853715954fadb3239f/tsdb/chunkenc/chunk.go#L28-L47). * `data`: See below for each encoding. ## XOR chunk data