336 lines
14 KiB
Perl
336 lines
14 KiB
Perl
#
|
|
# 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::microsoft::office365::sharepoint::mode::usersactivity;
|
|
|
|
use base qw(centreon::plugins::templates::counter);
|
|
|
|
use strict;
|
|
use warnings;
|
|
use Time::Local;
|
|
|
|
sub custom_active_perfdata {
|
|
my ($self, %options) = @_;
|
|
|
|
my %total_options = ();
|
|
if ($self->{instance_mode}->{option_results}->{units} eq '%') {
|
|
$total_options{total} = $self->{result_values}->{total};
|
|
$total_options{cast_int} = 1;
|
|
}
|
|
|
|
if ($self->{result_values}->{report_date} =~ /^([0-9]{4})-([0-9]{2})-([0-9]{2})$/) {
|
|
$self->{output}->perfdata_add(label => 'perfdate', value => timelocal(0,0,12,$3,$2-1,$1-1900));
|
|
}
|
|
|
|
$self->{output}->perfdata_add(
|
|
label => 'active_users', nlabel => 'sharepoint.users.active.count',
|
|
value => $self->{result_values}->{active},
|
|
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),
|
|
unit => 'users', min => 0, max => $self->{result_values}->{total}
|
|
);
|
|
}
|
|
|
|
sub custom_active_threshold {
|
|
my ($self, %options) = @_;
|
|
|
|
my $threshold_value = $self->{result_values}->{active};
|
|
if ($self->{instance_mode}->{option_results}->{units} eq '%') {
|
|
$threshold_value = $self->{result_values}->{prct_active};
|
|
}
|
|
my $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_active_output {
|
|
my ($self, %options) = @_;
|
|
|
|
return sprintf(
|
|
"Active users on %s : %d/%d (%.2f%%)",
|
|
$self->{result_values}->{report_date},
|
|
$self->{result_values}->{active},
|
|
$self->{result_values}->{total},
|
|
$self->{result_values}->{prct_active}
|
|
);
|
|
}
|
|
|
|
sub custom_active_calc {
|
|
my ($self, %options) = @_;
|
|
|
|
$self->{result_values}->{active} = $options{new_datas}->{$self->{instance} . '_active'};
|
|
$self->{result_values}->{total} = $options{new_datas}->{$self->{instance} . '_total'};
|
|
$self->{result_values}->{report_date} = $options{new_datas}->{$self->{instance} . '_report_date'};
|
|
$self->{result_values}->{prct_active} = ($self->{result_values}->{total} != 0) ? $self->{result_values}->{active} * 100 / $self->{result_values}->{total} : 0;
|
|
|
|
return 0;
|
|
}
|
|
|
|
sub prefix_global_output {
|
|
my ($self, %options) = @_;
|
|
|
|
return "Total (active sites) ";
|
|
}
|
|
|
|
sub prefix_user_output {
|
|
my ($self, %options) = @_;
|
|
|
|
return "User '" . $options{instance_value}->{name} . "' ";
|
|
}
|
|
|
|
sub set_counters {
|
|
my ($self, %options) = @_;
|
|
|
|
$self->{maps_counters_type} = [
|
|
{ name => 'active', type => 0 },
|
|
{ name => 'global', type => 0, cb_prefix_output => 'prefix_global_output' },
|
|
{ name => 'users', type => 1, cb_prefix_output => 'prefix_user_output', message_multiple => 'All users activity are ok' }
|
|
];
|
|
|
|
$self->{maps_counters}->{active} = [
|
|
{ label => 'active-users', set => {
|
|
key_values => [ { name => 'active' }, { name => 'total' }, { name => 'report_date' } ],
|
|
closure_custom_calc => $self->can('custom_active_calc'),
|
|
closure_custom_output => $self->can('custom_active_output'),
|
|
closure_custom_threshold_check => $self->can('custom_active_threshold'),
|
|
closure_custom_perfdata => $self->can('custom_active_perfdata')
|
|
}
|
|
}
|
|
];
|
|
|
|
$self->{maps_counters}->{global} = [
|
|
{ label => 'total-viewed-edited-file-count', nlabel => 'sharepoint.users.files.viewed.total.count', set => {
|
|
key_values => [ { name => 'viewed_edited_file_count' } ],
|
|
output_template => 'Viewed or Edited File Count: %d',
|
|
perfdatas => [
|
|
{ label => 'total_viewed_edited_file_count', template => '%d',
|
|
min => 0 }
|
|
]
|
|
}
|
|
},
|
|
{ label => 'total-synced-file-count', nlabel => 'sharepoint.users.files.synced.total.count', set => {
|
|
key_values => [ { name => 'synced_file_count' } ],
|
|
output_template => 'Synced File Count: %d',
|
|
perfdatas => [
|
|
{ label => 'total_synced_file_count', template => '%d',
|
|
min => 0 }
|
|
]
|
|
}
|
|
},
|
|
{ label => 'total-shared-int-file-count', nlabel => 'sharepoint.users.files.shared.internally.total.count', set => {
|
|
key_values => [ { name => 'shared_int_file_count' } ],
|
|
output_template => 'Shared Internally File Count: %d',
|
|
perfdatas => [
|
|
{ label => 'total_shared_int_file_count', template => '%d',
|
|
min => 0 }
|
|
]
|
|
}
|
|
},
|
|
{ label => 'total-shared-ext-file-count', nlabel => 'sharepoint.users.files.shared.externally.total.count', set => {
|
|
key_values => [ { name => 'shared_ext_file_count' } ],
|
|
output_template => 'Shared Externally File Count: %d',
|
|
perfdatas => [
|
|
{ label => 'total_shared_ext_file_count', template => '%d',
|
|
min => 0 }
|
|
]
|
|
}
|
|
},
|
|
{ label => 'total-visited-page-count', nlabel => 'sharepoint.users.pages.visited.total.count', set => {
|
|
key_values => [ { name => 'visited_page_count' } ],
|
|
output_template => 'Visited Page Count (active sites): %d',
|
|
perfdatas => [
|
|
{ label => 'total_visited_page_count', template => '%d',
|
|
min => 0 }
|
|
]
|
|
}
|
|
}
|
|
];
|
|
|
|
$self->{maps_counters}->{users} = [
|
|
{ label => 'viewed-edited-file-count', nlabel => 'sharepoint.users.files.viewed.count', set => {
|
|
key_values => [ { name => 'viewed_edited_file_count' }, { name => 'name' } ],
|
|
output_template => 'Viewed or Edited File Count: %d',
|
|
perfdatas => [
|
|
{ label => 'viewed_edited_file_count', template => '%d',
|
|
min => 0, label_extra_instance => 1, instance_use => 'name' }
|
|
]
|
|
}
|
|
},
|
|
{ label => 'synced-file-count', nlabel => 'sharepoint.users.files.synced.count', set => {
|
|
key_values => [ { name => 'synced_file_count' }, { name => 'name' } ],
|
|
output_template => 'Synced File Count: %d',
|
|
perfdatas => [
|
|
{ label => 'synced_file_count', template => '%d',
|
|
min => 0, label_extra_instance => 1, instance_use => 'name' }
|
|
]
|
|
}
|
|
},
|
|
{ label => 'shared-int-file-count', nlabel => 'sharepoint.users.files.shared.internally.count', set => {
|
|
key_values => [ { name => 'shared_int_file_count' }, { name => 'name' } ],
|
|
output_template => 'Shared Internally File Count: %d',
|
|
perfdatas => [
|
|
{ label => 'shared_int_file_count', template => '%d',
|
|
min => 0, label_extra_instance => 1, instance_use => 'name' }
|
|
]
|
|
}
|
|
},
|
|
{ label => 'shared-ext-file-count', nlabel => 'sharepoint.users.files.shared.externally.count', set => {
|
|
key_values => [ { name => 'shared_ext_file_count' }, { name => 'name' } ],
|
|
output_template => 'Shared Externally File Count: %d',
|
|
perfdatas => [
|
|
{ label => 'shared_ext_file_count', template => '%d',
|
|
min => 0, label_extra_instance => 1, instance_use => 'name' }
|
|
]
|
|
}
|
|
},
|
|
{ label => 'visited-page-count', nlabel => 'sharepoint.users.pages.visited.count', set => {
|
|
key_values => [ { name => 'visited_page_count' }, { name => 'name' } ],
|
|
output_template => 'Visited Page Count: %d',
|
|
perfdatas => [
|
|
{ label => 'visited_page_count', template => '%d',
|
|
min => 0, label_extra_instance => 1, instance_use => 'name' }
|
|
]
|
|
}
|
|
}
|
|
];
|
|
}
|
|
|
|
sub new {
|
|
my ($class, %options) = @_;
|
|
my $self = $class->SUPER::new(package => __PACKAGE__, %options);
|
|
bless $self, $class;
|
|
|
|
$options{options}->add_options(arguments => {
|
|
"filter-user:s" => { name => 'filter_user' },
|
|
"units:s" => { name => 'units', default => '%' },
|
|
"filter-counters:s" => { name => 'filter_counters', default => 'active|total' }
|
|
});
|
|
|
|
return $self;
|
|
}
|
|
|
|
sub manage_selection {
|
|
my ($self, %options) = @_;
|
|
|
|
$self->{active} = { active => 0, total => 0, report_date => '' };
|
|
$self->{global} = {
|
|
viewed_edited_file_count => 0, synced_file_count => 0,
|
|
shared_int_file_count => 0, shared_ext_file_count => 0,
|
|
visited_page_count => 0
|
|
};
|
|
$self->{users} = {};
|
|
|
|
my $results = $options{custom}->office_get_sharepoint_activity(param => "period='D7'");
|
|
my $results_daily = [];
|
|
if (scalar(@{$results})) {
|
|
$self->{active}->{report_date} = @{$results}[0]->{'Report Refresh Date'};
|
|
$results_daily = $options{custom}->office_get_sharepoint_activity(param => "date=" . $self->{active}->{report_date});
|
|
}
|
|
|
|
foreach my $user (@{$results}, @{$results_daily}) {
|
|
if (defined($self->{option_results}->{filter_user}) && $self->{option_results}->{filter_user} ne '' &&
|
|
$user->{'User Principal Name'} !~ /$self->{option_results}->{filter_user}/) {
|
|
$self->{output}->output_add(long_msg => "skipping '" . $user->{'User Principal Name'} . "': no matching filter name.", debug => 1);
|
|
next;
|
|
}
|
|
|
|
if ($user->{'Report Period'} != 1) {
|
|
if (!defined($user->{'Last Activity Date'}) || ($user->{'Last Activity Date'} ne $self->{active}->{report_date})) {
|
|
$self->{output}->output_add(long_msg => "skipping '" . $user->{'User Principal Name'} . "': no activity.", debug => 1);
|
|
}
|
|
$self->{active}->{total}++;
|
|
next;
|
|
}
|
|
|
|
$self->{active}->{active}++;
|
|
|
|
$self->{global}->{viewed_edited_file_count} += ($user->{'Viewed Or Edited File Count'} ne '') ? $user->{'Viewed Or Edited File Count'} : 0;
|
|
$self->{global}->{synced_file_count} += ($user->{'Synced File Count'} ne '') ? $user->{'Synced File Count'} : 0;
|
|
$self->{global}->{shared_int_file_count} += ($user->{'Shared Internally File Count'} ne '') ? $user->{'Shared Internally File Count'} : 0;
|
|
$self->{global}->{shared_ext_file_count} += ($user->{'Shared Externally File Count'} ne '') ? $user->{'Shared Externally File Count'} : 0;
|
|
$self->{global}->{visited_page_count} += ($user->{'Visited Page Count'} ne '') ? $user->{'Visited Page Count'} : 0;
|
|
|
|
$self->{users}->{$user->{'User Principal Name'}}->{name} = $user->{'User Principal Name'};
|
|
$self->{users}->{$user->{'User Principal Name'}}->{viewed_edited_file_count} = $user->{'Viewed Or Edited File Count'};
|
|
$self->{users}->{$user->{'User Principal Name'}}->{synced_file_count} = $user->{'Synced File Count'};
|
|
$self->{users}->{$user->{'User Principal Name'}}->{shared_int_file_count} = $user->{'Shared Internally File Count'};
|
|
$self->{users}->{$user->{'User Principal Name'}}->{shared_ext_file_count} = $user->{'Shared Externally File Count'};
|
|
$self->{users}->{$user->{'User Principal Name'}}->{visited_page_count} = $user->{'Visited Page Count'};
|
|
}
|
|
}
|
|
|
|
1;
|
|
|
|
__END__
|
|
|
|
=head1 MODE
|
|
|
|
Check users activity (reporting period over the last refreshed day).
|
|
|
|
(See link for details about metrics :
|
|
https://docs.microsoft.com/en-us/microsoft-365/admin/activity-reports/sharepoint-activity?view=o365-worldwide)
|
|
|
|
=over 8
|
|
|
|
=item B<--filter-user>
|
|
|
|
Filter users.
|
|
|
|
=item B<--warning-*>
|
|
|
|
Threshold warning.
|
|
Can be: 'active-users',
|
|
'total-viewed-edited-file-count' (count), 'total-synced-file-count' (count),
|
|
'total-shared-int-file-count' (count), 'total-shared-ext-file-count' (count),
|
|
'total-visited-page-count' (count),
|
|
'viewed-edited-file-count' (count), 'synced-file-count' (count),
|
|
'shared-int-file-count' (count), 'shared-ext-file-count' (count),
|
|
'visited-page-count' (count).
|
|
|
|
=item B<--critical-*>
|
|
|
|
Threshold critical.
|
|
Can be: 'active-users',
|
|
'total-viewed-edited-file-count' (count), 'total-synced-file-count' (count),
|
|
'total-shared-int-file-count' (count), 'total-shared-ext-file-count' (count),
|
|
'total-visited-page-count' (count),
|
|
'viewed-edited-file-count' (count), 'synced-file-count' (count),
|
|
'shared-int-file-count' (count), 'shared-ext-file-count' (count),
|
|
'visited-page-count' (count).
|
|
|
|
=item B<--filter-counters>
|
|
|
|
Only display some counters (regexp can be used).
|
|
Example to hide per user counters: --filter-counters='active|total'
|
|
(Default: 'active|total')
|
|
|
|
=item B<--units>
|
|
|
|
Unit of thresholds (Default: '%') ('%', 'count').
|
|
|
|
=back
|
|
|
|
=cut
|