mudhorn/prometheus
1
0
Fork 0
mirror of https://github.com/prometheus/prometheus.git synced 2024-12-27 22:49:40 -08:00
Code Issues Actions 8 Packages Projects Releases Wiki Activity
prometheus/model/textparse
History
Ondrej Kokes 2e30f1231b docs: textparse.Parser return type mismatch 
The docs suggest the Next method returns a bool, but that's not the case (`Entry` is an int).

```
	// Next advances the parser to the next sample. It returns false if no
	// more samples were read or an error occurred.
	Next() (Entry, error)
```

The docs were first added in d80a3de235 in 2017. Back then the signature was
indeed `func (p *Parser) Next() bool`. But then it got refactored in 76a4a46cb0
and the signature changed with it, yet docs stayed the same - and eventually made their way into the `Parser` interface.

However, the Protobuf parser does have the right wording: 5de2df752f

```
// Next advances the parser to the next "sample" (emulating the behavior of a
// text format parser). It returns (EntryInvalid, io.EOF) if no samples were
// read.
```

Changing all other implementations (and the interface itself) to match this doc.

Signed-off-by: Ondrej Kokes <ondrej.kokes@gmail.com>
2024-02-29 16:45:05 +01:00
..
interface.go docs: textparse.Parser return type mismatch 2024-02-29 16:45:05 +01:00
interface_test.go model/textparse: parsers take a labels SymbolTable 2024-02-26 11:45:25 +00:00
openmetricslex.l UTF-8: Add support for parsing UTF8 metric and label names 2024-02-15 14:34:37 -05:00
openmetricslex.l.go UTF-8: Add support for parsing UTF8 metric and label names 2024-02-15 14:34:37 -05:00
openmetricsparse.go docs: textparse.Parser return type mismatch 2024-02-29 16:45:05 +01:00
openmetricsparse_test.go refactor: metrics parsing: extract common checking code 2024-02-26 16:37:41 +00:00
promlex.l UTF-8: Add support for parsing UTF8 metric and label names 2024-02-15 14:34:37 -05:00
promlex.l.go UTF-8: Add support for parsing UTF8 metric and label names 2024-02-15 14:34:37 -05:00
promparse.go docs: textparse.Parser return type mismatch 2024-02-29 16:45:05 +01:00
promparse_test.go refactor: metrics parsing: extract common checking code 2024-02-26 16:37:41 +00:00
promtestdata.nometa.txt Move packages out of deprecated pkg directory 2021-11-09 08:03:10 +01:00
promtestdata.txt Move packages out of deprecated pkg directory 2021-11-09 08:03:10 +01:00
protobufparse.go model/textparse: parsers take a labels SymbolTable 2024-02-26 11:45:25 +00:00
protobufparse_test.go model/textparse: parsers take a labels SymbolTable 2024-02-26 11:45:25 +00:00
README.md Move packages out of deprecated pkg directory 2021-11-09 08:03:10 +01:00

README.md

Making changes to textparse lexers

In the rare case that you need to update the textparse lexers, edit promlex.l or openmetricslex.l and then run the following command: golex -o=promlex.l.go promlex.l

Note that you need golex installed: go get -u modernc.org/golex