https://github.com/prismamedia/metrics

Symfony bundle to expose your own metrics to Prometheus
https://github.com/prismamedia/metrics

php-library prometheus-exporter symfony-bundle

Last synced: 30 days ago
JSON representation

Symfony bundle to expose your own metrics to Prometheus

• Host: GitHub
• URL: https://github.com/prismamedia/metrics
• Owner: prismamedia
• License: bsd-3-clause
• Created: 2019-05-07T14:42:03.000Z (over 5 years ago)
• Default Branch: 2.x
• Last Pushed: 2024-07-19T07:54:35.000Z (4 months ago)
• Last Synced: 2024-09-30T16:23:04.349Z (about 1 month ago)
• Topics: php-library, prometheus-exporter, symfony-bundle
• Language: PHP
• Homepage:
• Size: 41 KB
• Stars: 14
• Watchers: 4
• Forks: 5
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Prometheus exporter for your own metrics

This package is a Symfony bundle for [exporting metrics to Prometheus](https://prometheus.io/docs/instrumenting/writing_exporters/).

Create your own `MetricGenerator` services to generate values on-demand, the bundle  will expose them under the `/metrics` endpoint.

*It does not provide any metric by default, you have to code your own.*

## Usage

Require the package

```

composer require prismamedia/metrics

```

Register the bundle

```php

# config/bundles.php

return [

    // ...

    PrismaMedia\Metrics\Bundle\PrismaMediaMetricsBundle::class => ['all' => true],

    // ...

];

```

Import routing file

```yaml

# config/routes.yaml

metrics:

    resource: '@PrismaMediaMetricsBundle/Resources/config/routes.xml'

```

### Implement your own metric generator

Your metrics are generated on demand by a class implementing `PrismaMedia\Metrics\MetricGenerator` interface.

The best practice is to create a distinct classes for distinct metric names.

Each class can return several values with distinct labels.

In the following example, we expose a metric named `app_article_total`

labelled with each `status`. In Prometheus (& Grafana), the values can be added

in order to get the overall total.

```php

connection = $connection;

    }

    /**

     * @return Metric[]

     */

    public function getMetrics(): \Traversable

    {

        // SELECT a.status, COUNT(*) as total FROM article GROUP BY a.status

        $qbd = $this->connection->createQueryBuilder();

        $qbd->select('a.status, COUNT(*) as total')

            ->from('article', 'a')

            ->groupBy('a.status');

        foreach ($qbd->execute()->fetchAll() as $row) {

            // app_article_total{status=} 

            yield new Metric('app_article_total', (int) $row['total'], [

                'status' => $row['status'],

            ]);

        }

    }

}

```

Declare the class as a service in you `config/services.yaml` or `config/services.php`.

It will be automatically tagged `prisma_media.metric` and added to the aggregator.

The `/metrics` endpoint will return something like this:

```console

# curl https://localhost:8080/metrics

app_article_total{status=published} 230

app_article_total{status=review} 2

app_article_total{status=draft} 5

```

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

## License

[BSD 3-Clause](https://choosealicense.com/licenses/bsd-3-clause/)