openmetrics-php / exposition-text Goto Github PK

Expected Behavior

The library also installs/works on PHP 7.1.

Actual Behavior

The library only installs/works on PHP >= 7.2

Specifications

• Package version: v0.1.0

Further comments

Back porting to PHP 7.1 was originally requested via Twitter

/cc @s7anley

Expected Behavior

The output of a counter metric for metric name a must be a_total by this convention.

Actual Behavior

The output of a counter metric for metric name a is a.

Specifications

• Package version: v0.2.0
• PHP version: 7.2

Description

Counters add automatically _total suffix to metric itself, but it does not work for TYPE and HELP, so in fact you get descrepancy between metric definition and actual name. I think this commit must be reverted, people should be able to manage metric names without any magic in code: 78bc5df

Expected Behavior

# TYPE your_metric_name_total counter
# HELP your_metric_name_total A helpful description of your measurement.
your_metric_name_total 1.000000

Actual Behavior

As described in README (and really works this way):

# TYPE your_metric_name counter
# HELP your_metric_name A helpful description of your measurement.
your_metric_name_total 1.000000

Steps to Reproduce the Problem

Any of examples here: https://github.com/openmetrics-php/exposition-text/blob/master/examples/counters.php

Expected Behavior

All produces metrics must be able to be parsed by the openmetrics python parser.

Actual Behavior

Metrics are only tested via unit tests.

Specifications

• Package version: v0.2.0
• PHP version: 7.2

Further comments

The following script is able to parse a file that contains exposed metrics.

Install prometheus_client and forked-path:

pip install prometheus_client forked-path

parseFile.py:

from prometheus_client.openmetrics.parser import text_string_to_metric_families
from path import path

metrics = path('/path/to/metrics.txt').bytes()

for family in text_string_to_metric_families(metrics):
  for sample in family.samples:
    print("Name: {0} Labels: {1} Value: {2} Timestamp: {3}".format(*sample))

I don't think this package should rely on psr/http-message.
It should be the client responsibility to expose the metrics.
At most some recommendations/examples can be provided.

Most likely many of the clients already use a framework that uses the psr7, meaning they should just hook it up themselves - also this can bring in conflicts for frameworks using psr/http-message: ^2.0 dependency.

Or as in my case, I have to bring in an unwanted dependency because I just want to dump the metrics directly to a file.

What do you think?

Expected Behavior

Should work on PHP 8.1+ :-)

Actual Behavior

Deprecated: Return type of OpenMetricsPhp\Exposition\Text\Collections\LabelCollection::getIterator(): iterable should either be compatible with IteratorAggregate::getIterator(): Traversable, or the #[\ReturnTypeWillChange] attribute should be used to temporarily suppress the notice in /var/www/html/vendor/openmetrics-php/exposition-text/src/Collections/LabelCollection.php on line 65

There are probably some more.

Steps to Reproduce the Problem

1. Use lib with PHP 8.1
2. do something with labels
3. recognize deprecation warning

Specifications

• Package version: 0.3.1
• PHP version: 8.1.
• Platform/OS: Docker
• Subsystem: php:8.1-apache

Further comments