mudhorn/prometheus
1
0
Fork 0
mirror of https://github.com/prometheus/prometheus.git synced 2025-01-12 06:17:27 -08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

Merge pull request #250 from simonpasquier/update-doc

Browse source 
Update doc
This commit is contained in:
Goutham Veeramachaneni 2018-04-03 12:19:29 +05:30 committed by GitHub
parent 195bc0d286 7206a8456f
commit 3733f14dc5
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 23 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -3,3 +3,5 @@
This repository contains the new Prometheus storage layer that will be used in its 2.0 release. This repository contains the new Prometheus storage layer that will be used in its 2.0 release.
A writeup of its design can be found [here](https://fabxc.org/blog/2017-04-10-writing-a-tsdb/). A writeup of its design can be found [here](https://fabxc.org/blog/2017-04-10-writing-a-tsdb/).
See also the [format documentation](docs/format/README.md).

5
docs/format/README.md Normal file
View file

@ -0,0 +1,5 @@
## TSDB format
* [Index](index.md)
* [Chunks](chunks.md)
* [Tombstones](tombstones.md)

20
docs/format/index.md
View file

@ -54,7 +54,7 @@ Strings are referenced by sequential indexing. The strings are sorted in lexicog
│ ├──────────────────────┴───────────────┤ │ │ ├──────────────────────┴───────────────┤ │
│ │ . . . │ │ │ │ . . . │ │
│ ├──────────────────────┬───────────────┤ │ │ ├──────────────────────┬───────────────┤ │
│ │ len(str_n) <uvarint> │ str_1 <bytes> │ │ │ │ len(str_n) <uvarint> │ str_n <bytes> │ │
│ └──────────────────────┴───────────────┘ │ │ └──────────────────────┴───────────────┘ │
├──────────────────────────────────────────┤ ├──────────────────────────────────────────┤
│ CRC32 <4b> │ │ CRC32 <4b> │
@ -119,8 +119,8 @@ After the labels, the number of indexed chunks is encoded, followed by a sequenc
### Label Index ### Label Index
A label index section indexes the existing (combined) values for one or more label names. A label index section indexes the existing (combined) values for one or more label names.
The `#names` field determines the number indexed label names, followed by the total number of entries in the `#entries` field. The body holds `#entries` symbol table reference tuples of length of length `#names`. The value tuples are sorted in lexicographically increasing order. The `#names` field determines the number of indexed label names, followed by the total number of entries in the `#entries` field. The body holds #entries / #names tuples of symbol table references, each tuple being of #names length. The value tuples are sorted in lexicographically increasing order.
``` ```
┌───────────────┬────────────────┬────────────────┐ ┌───────────────┬────────────────┬────────────────┐
@ -139,11 +139,19 @@ The `#names` field determines the number indexed label names, followed by the to
└─────────────────────────────────────────────────┘ └─────────────────────────────────────────────────┘
``` ```
The sequence of label index sections is finalized by an offset table pointing to the beginning of each label index section for a given set of label names. For instance, a single label name with 4 different values will be encoded as:
```
┌────┬───┬───┬──────────────┬──────────────┬──────────────┬──────────────┬───────┐
│ 24 │ 1 │ 4 │ ref(value_0) | ref(value_1) | ref(value_2) | ref(value_3) | CRC32 |
└────┴───┴───┴──────────────┴──────────────┴──────────────┴──────────────┴───────┘
```
The sequence of label index sections is finalized by an [offset table](#offset-table) pointing to the beginning of each label index section for a given set of label names.
### Postings ### Postings
Postings sections store monotonically increasing lists of series references that contain a given label pair associated with the list. Postings sections store monotonically increasing lists of series references that contain a given label pair associated with the list.
``` ```
┌────────────────────┬────────────────────┐ ┌────────────────────┬────────────────────┐
@ -161,7 +169,7 @@ Postings sections store monotonically increasing lists of series references that
└─────────────────────────────────────────┘ └─────────────────────────────────────────┘
``` ```
The sequence of postings sections is finalized by an offset table pointing to the beginning of each postings section for a given set of label names. The sequence of postings sections is finalized by an [offset table](#offset-table) pointing to the beginning of each postings section for a given set of label names.
### Offset Table ### Offset Table

2
encoding_helpers.go
View file

@ -11,7 +11,7 @@ import (
var errInvalidSize = errors.New("invalid size") var errInvalidSize = errors.New("invalid size")
// enbuf is a helper type to populate a byte slice with various types. // encbuf is a helper type to populate a byte slice with various types.
type encbuf struct { type encbuf struct {
b []byte b []byte
c [binary.MaxVarintLen64]byte c [binary.MaxVarintLen64]byte

2
querier.go
View file

@ -117,7 +117,7 @@ func (q *querier) Close() error {
return merr.Err() return merr.Err()
} }
// NewBlockQuerier returns a queries against the readers. // NewBlockQuerier returns a querier against the reader.
func NewBlockQuerier(b BlockReader, mint, maxt int64) (Querier, error) { func NewBlockQuerier(b BlockReader, mint, maxt int64) (Querier, error) {
indexr, err := b.Index() indexr, err := b.Index()
if err != nil { if err != nil {