RepoMirrors
/
prometheus
mirror of https://github.com/prometheus/prometheus
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
prometheus/pkg/textparse
History
beorn7 7a8bb8222c Style cleanup of all the changes in sparsehistogram so far 
A lot of this code was hacked together, literally during a
hackathon. This commit intends not to change the code substantially,
but just make the code obey the usual style practices.

A (possibly incomplete) list of areas:

* Generally address linter warnings.

* The `pgk` directory is deprecated as per dev-summit. No new packages should
  be added to it. I moved the new `pkg/histogram` package to `model`
  anticipating what's proposed in #9478.

* Make the naming of the Sparse Histogram more consistent. Including
  abbreviations, there were just too many names for it: SparseHistogram,
  Histogram, Histo, hist, his, shs, h. The idea is to call it "Histogram" in
  general. Only add "Sparse" if it is needed to avoid confusion with
  conventional Histograms (which is rare because the TSDB really has no notion
  of conventional Histograms). Use abbreviations only in local scope, and then
  really abbreviate (not just removing three out of seven letters like in
  "Histo"). This is in the spirit of
  https://github.com/golang/go/wiki/CodeReviewComments#variable-names

* Several other minor name changes.

* A lot of formatting of doc comments. For one, following
  https://github.com/golang/go/wiki/CodeReviewComments#comment-sentences
  , but also layout question, anticipating how things will look like
  when rendered by `godoc` (even where `godoc` doesn't render them
  right now because they are for unexported types or not a doc comment
  at all but just a normal code comment - consistency is queen!).

* Re-enabled `TestQueryLog` and `TestEndopints` (they pass now,
  leaving them disabled was presumably an oversight).

* Bucket iterator for histogram.Histogram is now created with a
  method.

* HistogramChunk.iterator now allows iterator recycling. (I think
  @dieterbe only commented it out because he was confused by the
  question in the comment.)

* HistogramAppender.Append panics now because we decided to treat
  staleness marker differently.

Signed-off-by: beorn7 <beorn@grafana.com>
 		2021-10-11 13:02:03 +02:00
..
README.md Add a README.md to textparse package about how to update lexers. 2019-10-23 23:55:42 -07:00
interface.go Style cleanup of all the changes in sparsehistogram so far 2021-10-11 13:02:03 +02:00
openmetricslex.l Fix golint issues. 2020-03-23 20:38:43 +01:00
openmetricslex.l.go Fix golint issues. 2020-03-23 20:38:43 +01:00
openmetricsparse.go Style cleanup of all the changes in sparsehistogram so far 2021-10-11 13:02:03 +02:00
openmetricsparse_test.go Merge remote-tracking branch 'upstream/main' into sparse-refactor 2021-08-05 12:16:08 +05:30
promlex.l Prepare for multiple text formats 2018-10-18 13:58:00 +01:00
promlex.l.go Add exemplar support to the openmetrics parser (#6292) 2019-11-19 09:33:30 +00:00
promparse.go Style cleanup of all the changes in sparsehistogram so far 2021-10-11 13:02:03 +02:00
promparse_test.go Testify: move to require (#8122) 2020-10-29 09:43:23 +00:00
promtestdata.nometa.txt Add an OpenMetrics parser. 2018-10-18 13:58:00 +01:00
promtestdata.txt Add an OpenMetrics parser. 2018-10-18 13:58:00 +01:00
protobufparse.go Style cleanup of all the changes in sparsehistogram so far 2021-10-11 13:02:03 +02:00
protobufparse_test.go Style cleanup of all the changes in sparsehistogram so far 2021-10-11 13:02:03 +02: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