Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/chaseconey/laravel-datadog-helper

A Laravel Datadog helper package.
https://github.com/chaseconey/laravel-datadog-helper

Last synced: 3 days ago
JSON representation

A Laravel Datadog helper package.

Host: GitHub
URL: https://github.com/chaseconey/laravel-datadog-helper
Owner: chaseconey
License: mit
Created: 2016-08-02T14:28:46.000Z (over 8 years ago)
Default Branch: main
Last Pushed: 2022-02-09T23:40:16.000Z (almost 3 years ago)
Last Synced: 2025-01-13T12:18:00.326Z (11 days ago)
Language: PHP
Homepage:
Size: 175 KB
Stars: 74
Watchers: 4
Forks: 19
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md

Awesome Lists containing this project

README

        # laravel-datadog-helper

[![Latest Version on Packagist][ico-version]][link-packagist]

[![Software License][ico-license]](LICENSE.md)

[![Build Status][ico-travis]][link-travis]

[![Coverage Status][ico-scrutinizer]][link-scrutinizer]

[![Quality Score][ico-code-quality]][link-code-quality]

[![Total Downloads][ico-downloads]][link-downloads]

[![StyleCI](https://styleci.io/repos/64763895/shield?branch=master)](https://styleci.io/repos/64763895)

Laravel Datadog Helper helps you get your application metrics integrated into Laravel as fast as possible.

### Requirements

* Laravel >= 5

* Datadog API Key

### Features

* Adds Datadog facade that wraps the official [DataDog/php-datadogstatsd](https://github.com/DataDog/php-datadogstatsd) library

* Provides middleware for tracking response time metrics automatically

* Allows prefixing all metrics that are sent for the whole application with common prefix

## Installation

Require this package with composer.

```shell

composer require chaseconey/laravel-datadog-helper

```

Laravel 5.5 uses Package Auto-Discovery, so doesn't require you to manually add the ServiceProvider.

If you would like to install the request metric tracking middleware, add the Datadog middleware class like so:

``` php

// app/Http/Kernel.php

protected $middleware = [

    ...

    \ChaseConey\LaravelDatadogHelper\Middleware\LaravelDatadogMiddleware::class

];

```

### Without Auto-Discovery (or Laravel < 5.5)

If you don't use auto-discovery, or you are using an older version of Laravel, add the ServiceProvider to the providers array in `config/app.php`

``` php

// config/app.php

'providers' => [

    ...

    

    ChaseConey\LaravelDatadogHelper\LaravelDatadogHelperServiceProvider::class,

];

```

If you want to use the facade, add this to your facades in `config/app.php`:

``` php

// config/app.php

'aliases' => [

    ...

    

    'Datadog' => ChaseConey\LaravelDatadogHelper\Datadog::class

];

```

For configuration options, copy the package config to your local config with the publish command:

```shell

php artisan vendor:publish --provider="ChaseConey\LaravelDatadogHelper\LaravelDatadogHelperServiceProvider"

```

## Middleware

This package comes with a handy middleware that you can add to any Laravel project to get up and running in Datadog as fast as possible.

- **Metric Name:** `request_time`

- **Value:** The time it takes Laravel to respond to request

- **Tags:**:

    - `status_code`

    - `url` (toggle via `datadog.middleware_disable_url_tag` config option)

    - *any custom tags you have added to `datadog.global_tags`*

With just these metrics here are a couple of example graphs that you can make:

![](datadog-screen.png?raw=true)

Datadog Graph Config JSON



#### Max Request Time by URL

```json

{

  "viz": "heatmap",

  "requests": [

    {

      "q": "max:app.example.request_time.max{*} by {url}",

      "type": null,

      "style": {

        "palette": "dog_classic",

        "type": "solid",

        "width": "normal"

      },

      "aggregator": "avg",

      "conditional_formats": []

    }

  ],

  "autoscale": true

}

```

#### Top Pages Hit

```json

{

  "viz": "toplist",

  "requests": [

    {

      "q": "top(sum:app.example.request_time.count{*} by {url}.as_count(), 10, 'sum', 'desc')",

      "type": null,

      "style": {

        "palette": "warm",

        "type": "solid",

        "width": "normal"

      },

      "conditional_formats": []

    }

  ]

}

```

#### Slowest Endpoints/Pages

```json

{

  "viz": "toplist",

  "requests": [

    {

      "q": "top(max:app.example.request_time.max{*} by {url}, 10, 'max', 'desc')",

      "type": null,

      "style": {

        "palette": "dog_classic",

        "type": "solid",

        "width": "normal"

      },

      "conditional_formats": [

        {

          "palette": "white_on_red",

          "value": 5,

          "comparator": ">"

        },

        {

          "palette": "white_on_green",

          "value": 5,

          "comparator": "<="

        }

      ]

    }

  ]

}

```



## Examples

This library wraps the official [DataDog/php-datadogstatsd](https://github.com/DataDog/php-datadogstatsd) library. All functions are inherited from the core implementation provided by this library with the exception of replacing `Datadogstatsd` with `Datadog` (the facade).

For example:

Instead of doing `Datadogstatsd::increment('my.sweet.metrics')`, you would use `Datadog::increment('my.sweet.metrics')`.

For a full set of usage examples, [check out the library's usage README](https://github.com/DataDog/php-datadogstatsd#usage).

## Change log

Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) and [CONDUCT](CONDUCT.md) for details.

## Credits

- [Chase Coney][link-author]

- [All Contributors][link-contributors]

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

[ico-version]: https://img.shields.io/packagist/v/chaseconey/laravel-datadog-helper.svg?style=flat-square

[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square

[ico-travis]: https://img.shields.io/travis/chaseconey/laravel-datadog-helper/master.svg?style=flat-square

[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/chaseconey/laravel-datadog-helper.svg?style=flat-square

[ico-code-quality]: https://img.shields.io/scrutinizer/g/chaseconey/laravel-datadog-helper.svg?style=flat-square

[ico-downloads]: https://img.shields.io/packagist/dt/chaseconey/laravel-datadog-helper.svg?style=flat-square

[link-packagist]: https://packagist.org/packages/chaseconey/laravel-datadog-helper

[link-travis]: https://travis-ci.org/chaseconey/laravel-datadog-helper

[link-scrutinizer]: https://scrutinizer-ci.com/g/chaseconey/laravel-datadog-helper/code-structure

[link-code-quality]: https://scrutinizer-ci.com/g/chaseconey/laravel-datadog-helper

[link-downloads]: https://packagist.org/packages/chaseconey/laravel-datadog-helper

[link-author]: https://github.com/chaseconey

[link-contributors]: ../../contributors