From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

MBRADSHAW / Mail-Milter-Authentication-2.20191106 / lib / Mail / Milter / Authentication / Metric / Grafana.pm 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
—
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

              
package Mail::Milter::Authentication::Metric::Grafana;
use strict;
use warnings;
our $VERSION = '2.20191106'; # VERSION
use JSON;
sub get_json {
    my ( $self, $file ) = @_;
    my $basefile = __FILE__;
    $basefile =~ s/Grafana\.pm$/$file/;
    $basefile .= '.json';
    if ( ! -e $basefile ) {
        die 'json file ' . $file . ' not found';
    }
    open my $InF, '<', $basefile;
    my @Content = <$InF>;
    close $InF;
    return join( q{}, @Content );
}
sub new {
    my ( $class ) = @_;
    my $self = {};
    bless $self, $class;
    return $self;
}
sub get_dashboard {
    my ( $self, $server ) = @_;
    my @Rows;
    # Add default system rows
    push @Rows, $self->get_json( 'RowThroughput' );
    push @Rows, $self->get_json( 'RowProcesses' );
    push @Rows, $self->get_json( 'RowProcessingTime' );
    push @Rows, $self->get_json( 'RowErrors' );
    push @Rows, $self->get_json( 'RowUptime' );
    foreach my $Handler ( sort keys %{ $server->{ 'handler' } } ) {
        my $HandlerObj = $server->{ 'handler' }->{ $Handler };
        if ( $HandlerObj->can( 'grafana_rows' ) ) {
            my $HandlerRows = $HandlerObj->grafana_rows();
            foreach my $Row ( @$HandlerRows ) {
                push @Rows, $Row if $Row;
            }
        }
    }
    my $J = JSON->new();
    $J->pretty();
    $J->canonical();
    my $Base = $self->get_json( 'Base' );
    my $BaseData = $J->decode( $Base );
    my $RowsData = $J->decode( '[' . join( ',', @Rows ) . ']' );
    $BaseData->{ 'rows' } = $RowsData;
    return $J->encode( $BaseData ) . "\n";
}
1;
__END__
=pod
=encoding UTF-8
=head1 NAME
Mail::Milter::Authentication::Metric::Grafana
=head1 VERSION
version 2.20191106
=head1 DESCRIPTION
Automatically generate a grafana dashboard for installed handlers
=head1 CONSTRUCTOR
=over
=item new()
my $object = Mail::Milter::Authentication::Metric::Grafana->new();
Creates a new object.
=back
=head1 METHODS
=over
=item get_Base()
Returns the base json for the dashboard
=item get_RowThroughput()
Returns the Row json for THroughput
=item get_RowProcesses()
Returns the Row json for Processes
=item get_RowProcessingTime()
Returns the Row json for Processing TIme
=item get_RowErrors()
Returns the Row json for Errors
=item get_RowUptime()
Returns the Row json for Uptime
=item get_json ( $file )
Retrieve json data from external file
=item get_dashboard( $server )
Returns the json for the grafana dashboard
$server is the current handler object
=back
=head1 AUTHOR
Marc Bradshaw <marc@marcbradshaw.net>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2018 by Marc Bradshaw.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut