Download the PHP package myoperator/metrics without Composer
On this page you can find all versions of the php package myoperator/metrics. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download myoperator/metrics
More information about myoperator/metrics
Files in myoperator/metrics
Package metrics
Short Description Metrics wrapper that pushes your metrics to StatsD server
License GPL
Informations about the package metrics
Metrics
This library serves as a base for application metrics for myoperator PHP based applications.
Dependencies
- codeasashu/statsd-php (Composer package)
- php >= 7.2
- UDP statsd connection
Quick Start
Install this library as composer dependecy in any project you want to add metrics to.
or simple add this to your composer.json
Then initialise Metrics
instance in your bootstrap script or any init'able script
Then you can get Metrics
instance anywhere in your application and can send metrics.
For instance, to send timing
metrics for a time taking function:
NOTE This repo is extension of source code at https://github.com/codeasashu/statsd-php
To see all documentation, please go through https://github.com/codeasashu/statsd-php documentation and see the availble methods and logging mechanism
Metric Types
Following metric types are supported, and their method names are same as well
Counter
Counter sends a arbitary count of anything, which can only increase by time
for example:
counters can be used to log:
- Number of requests served
- Tasks completed (user login, invoices generated)
- Errors or exceptions
Gauge
Gauges are used to metric any arbitary random number which can increase or decrease by time
for example:
Gauges can be used to log:
- Number of items in queues
- Memory size of cache
- Number of active process/threads/containers
Timers
Timers forms a very cruitial component for any metrics, add it forms the basis of SLOs. Also, timing can be used to calculate averages, sum etc.
Timing can be recorded in following ways:
Start and Stop based timers
Here, we start the timer and stop when the task is done. This is best suited for cases where we are doing the task in same script.
Self time calculation
If you want to time your metric yourself, you can do so by using timing
method: