https://github.com/kibatic/prometheusmetricsbuilder

This library allows to create easily a prometheus exporter for a PHP project. It creates a string with metrics.
https://github.com/kibatic/prometheusmetricsbuilder

Last synced: 17 days ago
JSON representation

This library allows to create easily a prometheus exporter for a PHP project. It creates a string with metrics.

• Host: GitHub
• URL: https://github.com/kibatic/prometheusmetricsbuilder
• Owner: kibatic
• License: mit
• Created: 2022-11-21T17:06:50.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-11-21T20:32:47.000Z (about 2 years ago)
• Last Synced: 2024-11-30T00:44:40.024Z (24 days ago)
• Language: PHP
• Size: 14.6 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Prometheus Metrics Builder

==========================

![example workflow](https://github.com/kibatic/PrometheusMetricsBuilder/actions/workflows/php.yml/badge.svg)

This library helps you to build a Prometheus metrics endpoint for your PHP application.

Quick start

-----------

### Install the library

```shell

composer require kibatic/prometheus-metrics-builder

```

### Basic usage

```php

$metricList = new MetricList();

$metricList->addMetric(new Metric('foo', 1));

$metricList->addMetric(new Metric('bar', "NaN"));

$metricList->addMetric(new Metric(

    'bar',

    1.35,

    [

        'label1' => 'value1',

        'label2' => 'value2',

    ]

));

$response = $metricList->getResponseContent();

$metricList->clearMetrics();

```

The content of the response will be:

```

foo 1

bar NaN

bar{label1="value1",label2="value2"} 1.35

```

More advanced usage

-------------------

### attributes

```php

$metric = new Metric(

    'my_metric_name',

    12,

    [

        'module' => 'invoice',

        'instance' => 'value2',

    ],

    new \DateTimeImmutable()

)

```

### timestamp with miliseconds

```php

$metric = new Metric(

    'foo',

    1,

    [],

    new \DateTimeImmutable('2020-01-01 00:00:00.012')

);

```

For developpeurs

----------------

### Run tests

```shell

# install all the needed dependencies

make composer

# run unit tests

make test

```

Roadmap

-------

- no plan for the moment

Versions

--------

2022-11-21 : v1.0.1

* add CI with github actions

2022-11-21 : v1.0.0

* initial version