Skip to content

Commit

Permalink
Update changelog and documentation, #2, #3
Browse files Browse the repository at this point in the history
  • Loading branch information
hollodotme committed Nov 22, 2018
1 parent 40bc46c commit 70cd251
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 8 deletions.
13 changes: 13 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,16 @@
All notable changes to this project will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/) and [Keep a CHANGELOG](http://keepachangelog.com).

## [0.3.0] - YYYY-MM-DD

### Fixed

* Counters must always be exposed with `<metric_name>_total` - [#2]

### Added

* Integration tests to check metrics output against [openmetrics' python parser](https://github.com/prometheus/client_python/blob/master/prometheus_client/openmetrics/parser.py) - [#3]

## [0.2.0] - 2018-11-16

### Added
Expand All @@ -13,7 +23,10 @@ This project adheres to [Semantic Versioning](http://semver.org/) and [Keep a CH

First stable release.

[0.3.0]: https://github.com/openmetrics-php/exposition-text/compare/v0.2.0...v0.3.0
[0.2.0]: https://github.com/openmetrics-php/exposition-text/compare/v0.1.0...v0.2.0
[0.1.0]: https://github.com/openmetrics-php/exposition-text/tree/v0.1.0

[#3]: https://github.com/openmetrics-php/exposition-text/issues/3
[#2]: https://github.com/openmetrics-php/exposition-text/issues/2
[#1]: https://github.com/openmetrics-php/exposition-text/issues/1
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,14 +94,14 @@ HttpResponse::fromMetricCollections($counters)->respond();
```
# TYPE your_metric_name counter
# HELP your_metric_name A helpful description of your measurement.
your_metric_name 1.000000
your_metric_name 2.000000 1541323663
your_metric_name{label1="label_value"} 3.000000
your_metric_name{label2="label_value"} 4.000000 1541323663
your_metric_name 5.000000
your_metric_name 6.000000 1541323663
your_metric_name{label3="label_value"} 7.000000
your_metric_name{label4="label_value", label5="label_value"} 8.000000 1541323663
your_metric_name_total 1.000000
your_metric_name_total 2.000000 1541323663
your_metric_name_total{label1="label_value"} 3.000000
your_metric_name_total{label2="label_value"} 4.000000 1541323663
your_metric_name_total 5.000000
your_metric_name_total 6.000000 1541323663
your_metric_name_total{label3="label_value"} 7.000000
your_metric_name_total{label4="label_value", label5="label_value"} 8.000000 1541323663
```

### Create a collection of gauges and respond it
Expand Down

0 comments on commit 70cd251

Please sign in to comment.