NAME
Plack::Middleware::Statsd - send statistics to statsd
VERSION
version v0.3.2
SYNOPSIS
```perl use Plack::Builder; use Net::Statsd::Client;
builder {
enable "Statsd", client => Net::Statsd::Tiny->new( ... ), sample_rate => 1.0;
...
sub { my ($env) = @_;
# Send statistics via other middleware
if (my $stats = $env->{'psgix.monitor.statsd'}) {
$stats->increment('myapp.wibble');
}
};
}; ```
DESCRIPTION
This middleware gathers metrics from the application send sends them to a statsd server.
ATTRIBUTES
client
This is a statsd client, such as an instance of Net::Statsd::Tiny.
If one is omitted, then it will default to one defined in the
environment hash at psgix.monitor.statsd
.
psgix.monitor.statsd
will be set to the current client if it is not
set.
The only restriction on the client is that it has the same API as Net::Statsd::Tiny or similar modules, by supporting the following methods:
increment
timing_ms
ortiming
set_add
This has been tested with Net::Statsd::Lite and Net::Statsd::Client.
Other statsd client modules may be used via a wrapper class.
sample_rate
The default sampling rate to used, which should be a value between 0 and 1. This will override the default rate of the "client", if there is one.
The default is 1
.
METRICS
The following metrics are logged:
psgi.request.method.$METHOD
This increments a counter for the request method.
psgi.request.remote_addr
The remote address is added to the set.
psgi.request.content-length
The content-length of the request, if it is specified in the header.
This is treated as a timing rather than a counter, so that statistics can be saved.
psgi.request.content-type.$TYPE.$SUBTYPE
A counter for the content type of request bodies is incremented, e.g.
psgi.request.content-type.application.x-www-form-urlencoded
.Any modifiers in the type, e.g.
charset
, will be ignored.psgi.response.content-length
The content-length of the response, if it is specified in the header.
This is treated as a timing rather than a counter, so that statistics can be saved.
psgi.response.content-type.$TYPE.$SUBTYPE
A counter for the content type is incremented, e.g. for a JPEG image, the counter
psgi.response.content-type.image.jpeg
is incremented.Any modifiers in the type, e.g.
charset
, will be ignored.psgi.response.status.$CODE
A counter for the HTTP status code is incremented.
psgi.response.time
The response time, in ms.
As of v0.3.1, this is no longer rounded up to an integer. If this causes problems with your statsd daemon, then you may need to use a subclassed version of your statsd client to work around this.
psgi.response.x-sendfile
This counter is incremented when the
X-Sendfile
header is added.The header is configured using the
plack.xsendfile.type
environment key, ortherwise theHTTP_X_SENDFILE_TYPE
environment variable.See Plack::Middleware::XSendfile for more information.
psgix.harakiri
This counter is incremented when the harakiri flag is set.
If you want to rename these, or modify sampling rates, then you will need to use a wrapper class for the "client".
EXAMPLES
Using from Catalyst
You can access the configured statsd client from Catalyst:
```perl sub finalize { my $c = shift;
if (my $statsd = $c->req->env->{'psgix.monitor.statsd'}) { ...
}
$c->next::method(@_); } ```
KNOWN ISSUES
Support for older Perl versions
This module requires Perl v5.10 or newer.
Pull requests to support older versions of Perl are welcome. See "SOURCE".
SEE ALSO
SOURCE
The development version is on github at https://github.com/robrwo/Plack-Middleware-Statsd and may be cloned from git://github.com/robrwo/Plack-Middleware-Statsd.git
BUGS
Please report any bugs or feature requests on the bugtracker website https://github.com/robrwo/Plack-Middleware-Statsd/issues
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.
AUTHOR
Robert Rothenberg rrwo@cpan.org
The initial development of this module was sponsored by Science Photo Library https://www.sciencephoto.com.
COPYRIGHT AND LICENSE
This software is Copyright (c) 2018 by Robert Rothenberg.
This is free software, licensed under:
The Artistic License 2.0 (GPL Compatible)