2017 © Pedro Peláez
 

symfony-bundle monitoring-bundle

A profiling/monitoring Symfony2 bundle for production servers - alerts on exceptions, logs profiling data & sends data to statsd/graphite

image

socloz/monitoring-bundle

A profiling/monitoring Symfony2 bundle for production servers - alerts on exceptions, logs profiling data & sends data to statsd/graphite

  • Thursday, March 3, 2016
  • by noisebynorthwest
  • Repository
  • 14 Watchers
  • 70 Stars
  • 27,720 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 7 Forks
  • 10 Open issues
  • 10 Versions
  • 5 % Grown

The README.md

SoclozMonitoringBundle

Build Status, (*1)

Warning

First stable version was released and tagged, if you don't want to change anything, you should use version 1.0.0, otherwise see CHANGELOG.md to see what has changed, (*2)

Introduction

A monitoring Symfony2 bundle for production servers that :, (*3)

  • sends emails on unhandled exceptions,
  • profiles PHP code and sends profiling information to statsd,
  • logs request profiling information,
  • new adds Request IDs/pid to log files/HTTP headers to troubleshoot bugs.

Dependencies

Exceptions catching : none., (*4)

Profiling :, (*5)

Profiled data

  • request : number of HTTP requests (handled by Symfony) / duration of requests
  • mongodb : number of mongodb calls (insert/batchInsert/update/save/remove/count/find/findOne) / total duration (requires xhprof)
  • redis : number of redis calls / total duration (only phpredis calls are tracked - http://github.com/nicolasff/phpredis) (requires xhprof)
  • sphinx : number of sphinx calls (query/runQueries/updateAttributes/buildExcerpts/buildKeywords) / total duration (requires xhprof)
  • curl : number or curl calls (curl_exec/curl_multi_exec) / total duration (requires xhprof)

For each piece of data, you get :, (*6)

  • a global graph,
  • a per route graph.

What do I get ?

Thanks to graphite, you can get some nice graphs : [TODO], (*7)

You also get the following log messages :, (*8)

[2013-06-10 10:38:31] app.INFO: /page/page_slug : 2041 ms mongodb : 6 calls/108 ms redis : 9 calls/2 ms [] {"request_id":"785317517bccd92b4da08d88b4c09fe5","pid":5503}

Debugging using Request IDs

For each HTTP request (or script), a Request ID is computed. It enabled you to correlate logs from various services (webservices, database requests, ...)., (*9)

This Request ID is forwarded to external webservices called using Guzzle using the X-RequestID HTTP header., (*10)

The Request ID is automatically :, (*11)

  • added to the HTTP response as a X-RequestID header,
  • added to all log lines (as long as the pid),
  • added to all Guzzle outgoing requests as a X-RequestID header.

If a X-RequestID HTTP header is found, its value will be used for the Request ID. If you call a SoclozMonitoringBundle powered webservice using Guzzle, the logs for the webservice will use the same request_id as the master request., (*12)

You should forward the Request ID to all the external services used. For example, you can add the Request ID to all your database queries as a SQL comment :, (*13)

$requestId = $this->get("socloz_monitoring.request_id")->getRequestId();
$sql = "SELECT /* {"request_id":"$requestId"} */ * FROM my_table WHERE col = ?";

FAQ

  1. Is it helpful ?, (*14)

    If you are not convinced that profiling on production servers is helpful, this module is not for you., (*15)

  2. What can I do to limit the overhead ?, (*16)

    On large sites, the recommended setup is :, (*17)

  • activate xhprof only on a couple servers (or on none if the overhead is really too important). The module will disable profiling if xhprof is absent.
  • enable sampling. By default, all requests are profiled; you can lower the number of requests profiled by setting socloz_monitoring.profiler.sampling (a value 50 will profile 50% of requests).

  1. Can it profile database calls ? memcached calls ?, (*18)

    Yes (as long as the calls can be identified in xprof data). Contributions are welcomed for new parsers (mysql, pgsql, ...). See Resources/config/profiler.xml for examples., (*19)

  2. I don't like receiving emails on errors. Can I use rollbar/airbrake/sentry instead ?, (*20)

    Yes. Monolog already has a decent support for those tools. Please refer to the monolog doc., (*21)

  3. Are yo hiring ?, (*22)

    Yes. If you are looking for a job in Paris, France, send a mail to techjobs AT socloz DOT com, (*23)

Setup

  • Install xhprof, statsd and a graphing backend (i.e. graphite), (*24)

  • Install & activate the module, (*25)

  • Configure the module : socloz_monitoring.mailer.from (source email of the exception alert mails), socloz_monitoring.mailer.to (destination email of the exception alert mails), socloz_monitoring.statsd.host (IP address/hostname of the statsd server), socloz_monitoring.statsd.port (port ot the statsd server), socloz_monitoring.statsd.prefix (prefix of the statsd keys), (*26)

  • Decide what you want to profile : socloz_monitoring.profiling.request (HTTP requests), socloz_monitoring.profiling.mongodb (MongoDB calls), (*27)

If you are using statsd version 0.4 or later : * set socloz_monitoring.statsd.merge_packets to true * if the statsd server isn't on the same LAN as your server, set socloz_monitoring.statsd.packet_size to 512, otherwise keep the default value, (*28)

The default configuration is :, (*29)

socloz_monitoring:
    exceptions:
        enable: true
        ignore: ['Symfony\Component\HttpKernel\Exception\NotFoundHttpException','Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException']
    profiler:
        enable: true
        sampling: 100
        mongodb: false
        request: false
        redis: false
        sphinx: false
    mailer:
        enable: true
        from: 
        to: 
    statsd:
        enable: false
        host:
        port:
        prefix: socloz_monitoring
        always_flush: false
        merge_packets: false
        packet_size: 1432
    request_id:
        enable: true
        add_pid: true
    logger:
        enable: false

Graphing application data

It is possible to send some application data to statsd :, (*30)

Counters :, (*31)

$container->get('socloz_monitoring.statsd')->updateStats("counter_name", $number);

Gauges :, (*32)

$container->get('socloz_monitoring.statsd')->gauge("gauge_name", $number);

Timers :, (*33)

$start = microtime(true);
// do some stuff
$end = microtime(true);
$container->get('socloz_monitoring.statsd')->timing("timer_name", ($end-$start)*1000);

Just make sure you don't have any name collisions between your counters/timers and the standard ones., (*34)

Stats are buffered and sent at the end of the script/request. In long running scripts, you should flush statsd regularly :, (*35)

$container->get('socloz_monitoring.statsd')->flush();

You can also configure statsd to always send data immediately :, (*36)

socloz_monitoring:
    statsd:
        always_flush: true

Finding data in graphite

The statsd data is (on unmodified configs) :, (*37)

  • stats.timers.prefix.{mongodb,request, ...}.{lower,mean_90,upper,upper_90} - timing information
  • stats.prefix.{mongodb,request, ...} / stats_counts.prefix.{mongodb,request, ...} - counters
  • stats.timers.prefix.per_route.{mongodb,request, ...}.{route}.{lower,mean_90,upper,upper_90} - per route timing information
  • stats.prefix.per_route.{mongodb,request, ...}.{route} - per route counters

Hints

Graphite hints, (*38)

  • number of mongodb calls per request : divideSeries(stats_counts.socloz_monitoring.mongodb, stats_counts.socloz_monitoring.request)

Roadmap

  • Parsers : mysql, memcached
  • Integrated graphite templates
  • Tracking of events (code releases, ...)
  • Rate limiting of mails

Thanks

Exception handling inspired by RoxWayErrorNotifyBundle, (*39)

StatsD client taken from Etsy StatsD, (*40)

Xhprof listener inpired by JnsXhprofBundle, (*41)

License

This bundle is released under the MIT license (see LICENSE)., (*42)

The Versions

03/03 2016

dev-master

9999999-dev https://github.com/SoCloz/SoclozMonitoringBundle

A profiling/monitoring Symfony2 bundle for production servers - alerts on exceptions, logs profiling data & sends data to statsd/graphite

  Sources   Download

MIT

The Requires

 

The Development Requires

by CloseToMe

email statsd graphite exceptions profiling monitoring xhprof production alerting

03/03 2016

1.2.4

1.2.4.0 https://github.com/SoCloz/SoclozMonitoringBundle

A profiling/monitoring Symfony2 bundle for production servers - alerts on exceptions, logs profiling data & sends data to statsd/graphite

  Sources   Download

MIT

The Requires

 

The Development Requires

by CloseToMe

email statsd graphite exceptions profiling monitoring xhprof production alerting

13/02 2016

1.2.3

1.2.3.0 https://github.com/SoCloz/SoclozMonitoringBundle

A profiling/monitoring Symfony2 bundle for production servers - alerts on exceptions, logs profiling data & sends data to statsd/graphite

  Sources   Download

MIT

The Requires

 

The Development Requires

by CloseToMe

email statsd graphite exceptions profiling monitoring xhprof production alerting

06/02 2016

1.2.2

1.2.2.0 https://github.com/SoCloz/SoclozMonitoringBundle

A profiling/monitoring Symfony2 bundle for production servers - alerts on exceptions, logs profiling data & sends data to statsd/graphite

  Sources   Download

MIT

The Requires

 

The Development Requires

by CloseToMe

email statsd graphite exceptions profiling monitoring xhprof production alerting

22/04 2015

1.2.1

1.2.1.0 https://github.com/SoCloz/SoclozMonitoringBundle

A profiling/monitoring Symfony2 bundle for production servers - alerts on exceptions, logs profiling data & sends data to statsd/graphite

  Sources   Download

MIT

The Requires

 

The Development Requires

by CloseToMe

email statsd graphite exceptions profiling monitoring xhprof production alerting

10/03 2015

1.2.0

1.2.0.0 https://github.com/SoCloz/SoclozMonitoringBundle

A profiling/monitoring Symfony2 bundle for production servers - alerts on exceptions, logs profiling data & sends data to statsd/graphite

  Sources   Download

MIT

The Requires

 

The Development Requires

by CloseToMe

email statsd graphite exceptions profiling monitoring xhprof production alerting

26/01 2015

1.1.2

1.1.2.0 https://github.com/SoCloz/SoclozMonitoringBundle

A profiling/monitoring Symfony2 bundle for production servers - alerts on exceptions, logs profiling data & sends data to statsd/graphite

  Sources   Download

MIT

The Requires

 

The Development Requires

by CloseToMe

email statsd graphite exceptions profiling monitoring xhprof production alerting

26/12 2014

1.1.1

1.1.1.0 https://github.com/SoCloz/SoclozMonitoringBundle

A profiling/monitoring Symfony2 bundle for production servers - alerts on exceptions, logs profiling data & sends data to statsd/graphite

  Sources   Download

MIT

The Requires

 

The Development Requires

by CloseToMe

email statsd graphite exceptions profiling monitoring xhprof production alerting

23/12 2014

1.1.0

1.1.0.0 https://github.com/SoCloz/SoclozMonitoringBundle

A profiling/monitoring Symfony2 bundle for production servers - alerts on exceptions, logs profiling data & sends data to statsd/graphite

  Sources   Download

MIT

The Requires

 

The Development Requires

by CloseToMe

email statsd graphite exceptions profiling monitoring xhprof production alerting

16/12 2014

1.0.0

1.0.0.0 https://github.com/SoCloz/SoclozMonitoringBundle

A profiling/monitoring Symfony2 bundle for production servers - alerts on exceptions, logs profiling data & sends data to statsd/graphite

  Sources   Download

MIT

The Requires

 

by CloseToMe

email statsd graphite exceptions profiling monitoring xhprof production alerting