Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/robrwo/net-statsd-tiny
A lightweight statsd client
https://github.com/robrwo/net-statsd-tiny
Last synced: 11 days ago
JSON representation
A lightweight statsd client
- Host: GitHub
- URL: https://github.com/robrwo/net-statsd-tiny
- Owner: robrwo
- Created: 2018-02-02T23:26:32.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-12-12T15:23:22.000Z (11 months ago)
- Last Synced: 2024-10-11T21:56:27.001Z (about 1 month ago)
- Language: Perl
- Size: 74.2 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: Changes
Awesome Lists containing this project
README
# NAME
Net::Statsd::Tiny - A tiny StatsD client that supports multimetric packets
# VERSION
version v0.3.7
# SYNOPSIS
```perl
use Net::Statsd::Tiny;
my $stats = Net::Statsd::Tiny->new(
prefix => 'myapp.',
autoflush => 0,
max_buffer_size => 8192,
);
...
$stats->increment('this.counter');
$stats->set_add( 'this.users', $username ) if $username;
$stats->timing( $run_time * 1000 );
$stats->flush;
```
# DESCRIPTION
This is a small StatsD client that supports the
[StatsD Metrics Export Specification v0.1](https://github.com/b/statsd_spec).
It supports the following features:
- Multiple metrics can be sent in a single UDP packet.
- It supports the meter and histogram metric types.
Note that the specification requires the measured values to be
integers no larger than 64-bits, but ideally 53-bits.
The current implementation does not validate that the values you pass
to metrics conform to the spec, which allows you to take advantage of
extensions to some StatsD daemons. But the downside is that other
daemons may ignore those metrics.
For simplicity, it will allow you to specify a sampling rate for any
metric, not just the ones where it is documented below. But again,
some daemons may ignore or reject this.
# ATTRIBUTES
## `host`
The host of the statsd daemon. It defaults to `127.0.0.1`.
## `port`
The port that the statsd daemon is listening on. It defaults to
`8125`.
## `proto`
The network protocol that the statsd daemon is using. It defaults to
`udp`.
## `prefix`
The prefix to prepend to metric names. It defaults to a blank string.
## `autoflush`
A flag indicating whether metrics will be send immediately. It
defaults to true.
When it is false, metrics will be saved in a buffer and only sent when
the buffer is full, or when the ["flush"](#flush) method is called.
Note that when this is disabled, you will want to flush the buffer
regularly at the end of each task (e.g. a website request or job).
Not all StatsD daemons support receiving multiple metrics in a single
packet.
## `max_buffer_size`
Specifies the maximum buffer size. It defaults to `512`.
# METHODS
## `counter`
```
$stats->counter( $metric, $value, $rate );
```
This adds the `$value` to the counter specified by the `$metric`
name.
If a `$rate` is specified and less than 1, then a sampling rate will
be added. `$rate` must be between 0 and 1.
## `update`
This is an alias for ["counter"](#counter), for compatability with
[Etsy::StatsD](https://metacpan.org/pod/Etsy%3A%3AStatsD) or [Net::Statsd::Client](https://metacpan.org/pod/Net%3A%3AStatsd%3A%3AClient).
## `increment`
```
$stats->increment( $metric, $rate );
```
This is an alias for
```
$stats->counter( $metric, 1, $rate );
```
## `decrement`
```
$stats->decrement( $metric, $rate );
```
This is an alias for
```
$stats->counter( $metric, -1, $rate );
```
## `metric`
```
$stats->metric( $metric, $value );
```
This is a counter that only accepts positive (increasing) values. It
is appropriate for counters that will never decrease (e.g. the number
of requests processed.) However, this metric type is not supported by
many StatsD daemons.
## `gauge`
```
$stats->gauge( $metric, $value );
```
A gauge can be thought of as a counter that is maintained by the
client instead of the daemon, where `$value` is a positive integer.
However, this also supports gauge increment extensions. If the number
is prefixed by a "+", then the gauge is incremented by that amount,
and if the number is prefixed by a "-", then the gauge is decremented
by that amount.
## `timing`
```
$stats->timing( $metric, $value, $rate );
```
This logs a "timing" in milliseconds, so that statistics about the
metric can be gathered. The `$value` must be positive number,
although the specification recommends that integers be used.
In actually, any values can be logged, and this is often used as a
generic histogram for non-timing values (especially since many StatsD
daemons do not support the ["histogram"](#histogram) metric type).
If a `$rate` is specified and less than 1, then a sampling rate will
be added. `$rate` must be between 0 and 1. Note that sampling
rates for timings may not be supported by all statsd servers.
## `timing_ms`
This is an alias for ["timing"](#timing), for compatability with
[Net::Statsd::Client](https://metacpan.org/pod/Net%3A%3AStatsd%3A%3AClient).
## `histogram`
```
$stats->histogram( $metric, $value );
```
This logs a value so that statistics about the metric can be
gathered. The `$value` must be a positive number, although the
specification recommends that integers be used.
## `set_add`
```
$stats->set_add( $metric, $string );
```
This adds the the `$string` to a set, for logging the number of
unique things, e.g. IP addresses or usernames.
## `flush`
This sends the buffer to the ["host"](#host) and empties the buffer, if there
is any data in the buffer.
# SEE ALSO
[Net::Statsd::Lite](https://metacpan.org/pod/Net%3A%3AStatsd%3A%3ALite) which has a similar API but uses [Moo](https://metacpan.org/pod/Moo) and
[Type::Tiny](https://metacpan.org/pod/Type%3A%3ATiny) for data validation. It's also faster.
[https://github.com/b/statsd\_spec](https://github.com/b/statsd_spec)
# SOURCE
The development version is on github at [https://github.com/robrwo/Net-Statsd-Tiny](https://github.com/robrwo/Net-Statsd-Tiny)
and may be cloned from [git://github.com/robrwo/Net-Statsd-Tiny.git](git://github.com/robrwo/Net-Statsd-Tiny.git)
# BUGS
Please report any bugs or feature requests on the bugtracker website
[https://github.com/robrwo/Net-Statsd-Tiny/issues](https://github.com/robrwo/Net-Statsd-Tiny/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
The initial development of this module was sponsored by Science Photo
Library [https://www.sciencephoto.com](https://www.sciencephoto.com).
# CONTRIBUTOR
Michael R. Davis
# COPYRIGHT AND LICENSE
This software is Copyright (c) 2018-2023 by Robert Rothenberg.
This is free software, licensed under:
```
The Artistic License 2.0 (GPL Compatible)
```