File Coverage

blib/lib/Metrics/Any/Adapter/DogStatsd.pm

Criterion	Covered	Total	%
statement	33	33	100.0
branch	4	6	66.6
condition			n/a
subroutine	7	7	100.0
pod	0	2	0.0
total	44	48	91.6

#  You may distribute under the terms of either the GNU General Public License
#  or the Artistic License (the same terms as Perl itself)
#
#  (C) Paul Evans, 2020-2026 -- [e-mail]

package Metrics::Any::Adapter::DogStatsd 0.04;

use v5.14;
use warnings;
use base qw( Metrics::Any::Adapter::Statsd );

use Carp;

# See also
#   https://metacpan.org/release/DataDog-DogStatsd/source/lib/DataDog/DogStatsd.pm

=head1 NAME

C - a metrics reporting adapter for DogStatsd

=head1 SYNOPSIS

=for highlighter language=perl

   use Metrics::Any::Adapter 'DogStatsd';

=head1 DESCRIPTION

This extension of L supports the additional tag
reporting syntax defined by F to report labelled metrics.

Additionally, distribution metrics are reported as native DogStatsd histograms
rather than the two-part count-and-sum implementation of plain statsd. Due to
limitations of the line-based protocol, certain characters are not allowed in
label names or values. Any C<:>, C<|>, C<,> or linefeeds are replaced by C<_>.

=cut

sub _tags
{
   my ( $labels, $labelvalues ) = @_;

   my @tags;
   foreach ( 0 .. $#$labels ) {
      my $name  = $labels->[$_];
      my $value = $labelvalues->[$_];
      # Replace disallowed characters with '_'
      $_ =~ s/[:|,\n]/_/g for $name, $value;

      push @tags, "$name:$value";
   }

   return "" unless @tags;
   return "|#" . join( ",", @tags );
}

sub send
{
   my $self = shift;
   my ( $stats, $labelnames, $labelvalues ) = @_;

   foreach my $name ( keys %$stats ) {
      my $value = $stats->{$name};
      my @values = ( ref $value ) ? @$value : ( $value );
      $_ .= _tags( $labelnames, $labelvalues ) for @values;
      $stats->{$name} = \@values
   }

   $self->SUPER::send( $stats );
}

# DogStatsd has a native "histogram" format; we'll use that
sub report_distribution
{
   my $self = shift;
   my ( $handle, $amount, @labelvalues ) = @_;

   my $meta = $self->{metrics}{$handle} or croak "No metric '$handle'";

   my $value = sprintf "%g|h", $amount;

   $self->send( { $meta->{name} => $value }, $meta->{labels}, \@labelvalues );
}

*inc_distribution_by = \&report_distribution;

=head1 AUTHOR

Paul Evans

=cut

0x55AA;