# # Copyright 2021 Centreon (http://www.centreon.com/) # # Centreon is a full-fledged industry-strength solution that meets # the needs in IT infrastructure and application monitoring for # service performance. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # package cloud::prometheus::exporters::nodeexporter::mode::memory; use base qw(centreon::plugins::templates::counter); use strict; use warnings; sub custom_usage_perfdata { my ($self, %options) = @_; my $label = 'used'; my $value_perf = $self->{result_values}->{used}; my %total_options = (); if ($self->{instance_mode}->{option_results}->{units} eq '%') { $total_options{total} = $self->{result_values}->{total}; $total_options{cast_int} = 1; } $self->{output}->perfdata_add( label => $label, unit => 'B', nlabel => 'memory.usage.bytes', value => $value_perf, warning => $self->{perfdata}->get_perfdata_for_output(label => 'warning-' . $self->{thlabel}, %total_options), critical => $self->{perfdata}->get_perfdata_for_output(label => 'critical-' . $self->{thlabel}, %total_options), min => 0, max => $self->{result_values}->{total}, instances => $self->use_instances(extra_instance => $options{extra_instance}) ? $self->{result_values}->{display} : undef, ); } sub custom_usage_threshold { my ($self, %options) = @_; my ($exit, $threshold_value); $threshold_value = $self->{result_values}->{used}; if ($self->{instance_mode}->{option_results}->{units} eq '%') { $threshold_value = $self->{result_values}->{prct_used}; } $exit = $self->{perfdata}->threshold_check(value => $threshold_value, threshold => [ { label => 'critical-' . $self->{thlabel}, exit_litteral => 'critical' }, { label => 'warning-'. $self->{thlabel}, exit_litteral => 'warning' } ]); return $exit; } sub custom_usage_output { my ($self, %options) = @_; my ($total_size_value, $total_size_unit) = $self->{perfdata}->change_bytes(value => $self->{result_values}->{total}); my ($total_used_value, $total_used_unit) = $self->{perfdata}->change_bytes(value => $self->{result_values}->{used}); my $msg = sprintf("Ram Total: %s, Used (-buffers/cache): %s (%.2f%%)", $total_size_value . " " . $total_size_unit, $total_used_value . " " . $total_used_unit, $self->{result_values}->{prct_used}); return $msg; } sub custom_usage_calc { my ($self, %options) = @_; $self->{result_values}->{display} = $options{new_datas}->{$self->{instance} . '_display'}; $self->{result_values}->{total} = $options{new_datas}->{$self->{instance} . '_total'}; $self->{result_values}->{available} = $options{new_datas}->{$self->{instance} . '_available'}; $self->{result_values}->{buffer} = $options{new_datas}->{$self->{instance} . '_buffer'}; $self->{result_values}->{cached} = $options{new_datas}->{$self->{instance} . '_cached'}; $self->{result_values}->{used} = $self->{result_values}->{total} - $self->{result_values}->{available} - $self->{result_values}->{buffer} - $self->{result_values}->{cached}; $self->{result_values}->{prct_used} = ($self->{result_values}->{total} > 0) ? $self->{result_values}->{used} * 100 / $self->{result_values}->{total} : 0; return 0; } sub set_counters { my ($self, %options) = @_; $self->{maps_counters_type} = [ { name => 'nodes', type => 1, cb_prefix_output => 'prefix_nodes_output', message_multiple => 'All nodes memory usage are ok' }, ]; $self->{maps_counters}->{nodes} = [ { label => 'usage', set => { key_values => [ { name => 'total' }, { name => 'available' }, { name => 'buffer' }, { name => 'cached' }, { name => 'display' } ], closure_custom_calc => $self->can('custom_usage_calc'), closure_custom_output => $self->can('custom_usage_output'), closure_custom_perfdata => $self->can('custom_usage_perfdata'), closure_custom_threshold_check => $self->can('custom_usage_threshold'), } }, { label => 'buffer', nlabel => 'buffer.usage.bytes', set => { key_values => [ { name => 'buffer' }, { name => 'display' } ], output_template => 'Buffer: %.2f %s', output_change_bytes => 1, perfdatas => [ { label => 'buffer', value => 'buffer', template => '%s', min => 0, unit => 'B', label_extra_instance => 1, instance_use => 'display' }, ], } }, { label => 'cached', nlabel => 'cache.usage.bytes', set => { key_values => [ { name => 'cached' }, { name => 'display' } ], output_template => 'Cached: %.2f %s', output_change_bytes => 1, perfdatas => [ { label => 'cached', value => 'cached', template => '%s', min => 0, unit => 'B', label_extra_instance => 1, instance_use => 'display' }, ], } }, ]; } sub prefix_nodes_output { my ($self, %options) = @_; return "Node '" . $options{instance_value}->{display} . "' "; } sub new { my ($class, %options) = @_; my $self = $class->SUPER::new(package => __PACKAGE__, %options); bless $self, $class; $options{options}->add_options(arguments => { "instance:s" => { name => 'instance', default => 'instance=~".*"' }, "units:s" => { name => 'units', default => '%' }, "extra-filter:s@" => { name => 'extra_filter' }, "metric-overload:s@" => { name => 'metric_overload' }, }); return $self; } sub check_options { my ($self, %options) = @_; $self->SUPER::check_options(%options); $self->{metrics} = { 'total' => "^node_memory_MemTotal.*", 'available' => "^node_memory_MemFree.*", 'cached' => "^node_memory_Cached.*", 'buffer' => "^node_memory_Buffers.*", }; foreach my $metric (@{$self->{option_results}->{metric_overload}}) { next if ($metric !~ /(.*),(.*)/); $self->{metrics}->{$1} = $2 if (defined($self->{metrics}->{$1})); } $self->{labels} = {}; foreach my $label (('instance')) { if ($self->{option_results}->{$label} !~ /^(\w+)[!~=]+\".*\"$/) { $self->{output}->add_option_msg(short_msg => "Need to specify --" . $label . " option as a PromQL filter."); $self->{output}->option_exit(); } $self->{labels}->{$label} = $1; } $self->{extra_filter} = ''; foreach my $filter (@{$self->{option_results}->{extra_filter}}) { $self->{extra_filter} .= ',' . $filter; } } sub manage_selection { my ($self, %options) = @_; $self->{nodes} = {}; my $results = $options{custom}->query( queries => [ 'label_replace({__name__=~"' . $self->{metrics}->{total} . '",' . $self->{option_results}->{instance} . $self->{extra_filter} . '}, "__name__", "total", "", "")', 'label_replace({__name__=~"' . $self->{metrics}->{available} . '",' . $self->{option_results}->{instance} . $self->{extra_filter} . '}, "__name__", "available", "", "")', 'label_replace({__name__=~"' . $self->{metrics}->{cached} . '",' . $self->{option_results}->{instance} . $self->{extra_filter} . '}, "__name__", "cached", "", "")', 'label_replace({__name__=~"' . $self->{metrics}->{buffer} . '",' . $self->{option_results}->{instance} . $self->{extra_filter} . '}, "__name__", "buffer", "", "")' ] ); foreach my $result (@{$results}) { $self->{nodes}->{$result->{metric}->{$self->{labels}->{instance}}}->{display} = $result->{metric}->{$self->{labels}->{instance}}; $self->{nodes}->{$result->{metric}->{$self->{labels}->{instance}}}->{$result->{metric}->{__name__}} = ${$result->{value}}[1]; } if (scalar(keys %{$self->{nodes}}) <= 0) { $self->{output}->add_option_msg(short_msg => "No nodes found."); $self->{output}->option_exit(); } } 1; __END__ =head1 MODE Check memory usage. =over 8 =item B<--instance> Filter on a specific instance (Must be a PromQL filter, Default: 'instance=~".*"') =item B<--warning-*> Threshold warning. Can be: 'usage', 'buffer', 'cached'. =item B<--critical-*> Threshold critical. Can be: 'usage', 'buffer', 'cached'. =item B<--units> Units of thresholds (Default: '%') ('%', 'B'). =item B<--extra-filter> Add a PromQL filter (Can be multiple) Example : --extra-filter='name=~".*pretty.*"' =item B<--metric-overload> Overload default metrics name (Can be multiple) Example : --metric-overload='metric,^my_metric_name$' By default, 'node_memory_MemFree' node's metric will be used for 'available' metric as it is more commonly used for now. The best being to use 'node_memory_MemAvailable' in the future. Default : - total: ^node_memory_MemTotal.* - available: ^node_memory_MemFree.* - cached: ^node_memory_Cached.* - buffer: ^node_memory_Buffers.* =item B<--filter-counters> Only display some counters (regexp can be used). Example: --filter-counters='usage' =back =cut