Download the PHP package avto-dev/app-metrics-laravel without Composer

On this page you can find all versions of the php package avto-dev/app-metrics-laravel. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of avto-dev/app-metrics-laravel

Informations about the package app-metrics-laravel

Laravel

Metrics endpoint for Laravel applications

Version PHP Version Build Status Coverage Downloads count License

Using this package provides easy way for integration metrics endpoint into your Illuminate-based application.

Install

Require this package with composer using the following command:

Installed composer is required (how to install composer).

You need to fix the major version of package.

After that you should "publish" package configuration file using next command:

And configure it in the file ./config/metrics.php.

Usage

Feel free to write your own metric classes and add it after into metrics.metric_classes configuration array.

Metric class must implements MetricInterface and optionally HasDescriptionInterface/HasLabelsInterface/HasTypeInterface. In metric constructor you can request any dependencies - DI will inject it automatically.

Also metric class can implements MetricsGroupInterface (for metrics grouping).

When your metric classes are ready and successfully registered into configuration file - you can request special route (/metrics by default):

Configuration allows you to change endpoint URI, set password protection, and more.

Secret verification can be completed using sending get-parameter ?secret=XXX or HTTP header X-SECRET.

Formatters

Out of the box this package provides json and prometheus metrics formats. Feel free to write your own formatters.

Prometheus formatter

Prometheus formatter uses some constants for metric's values(Nan, +Inf, -Inf) and types(counter,summary,gauge,histogram, untyped). You can find it in HasTypeInterface

Keep in mind that Prometheus accepts only numeric metrics values. This formatter will try to cast metrics values to numeric format (integer or float). And will set Nan if casting to numeric is impossible. Examples for formatting values:

Input Output
1.2 '1.2'
1 '1'
true '1'
false '0'
'123' '123'
'12foo' 'Nan'
['10', '20'] 'Nan'
null 'Nan'
'Nan' 'Nan'
'+Inf' '+Inf'
'-Inf' '-Inf'

Skipping metrics

If during construction or formatting metrics would be thrown exception that implements AvtoDev\AppMetrics\Exceptions\ShouldBeSkippedMetricExceptionInterface then this metric would be skipped from formatters output and exception would be reported by Illuminate\Contracts\Debug\ExceptionHandler

Testing

For package testing we use phpunit framework and docker-ce + docker-compose as develop environment. So, just write into your terminal after repository cloning:

Changes log

Release date Commits since latest release

Changes log can be found here.

Support

Issues Issues

If you will find any package errors, please, make an issue in current repository.

License

This is open-sourced software licensed under the MIT License.

All versions of app-metrics-laravel with dependencies

PHP Build Version
Package Version
Requires php Version ^8.0
ext-json Version *
illuminate/support Version ~9.0 || ~10.0
illuminate/container Version ~9.0 || ~10.0
illuminate/contracts Version ~9.0 || ~10.0
illuminate/routing Version ~9.0 || ~10.0
illuminate/config Version ~9.0 || ~10.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package avto-dev/app-metrics-laravel contains the following files

Loading the files please wait ....