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
145
146
|
# --
# Copyright (C) 2001-2021 OTRS AG, https://otrs.com/
# --
# This software comes with ABSOLUTELY NO WARRANTY. For details, see
# the enclosed file COPYING for license information (GPL). If you
# did not receive this file, see https://www.gnu.org/licenses/gpl-3.0.txt.
# --
package Kernel::System::Console::Command::Dev::Tools::GenericInterface::DebugRead;
use strict;
use warnings;
use utf8;
use parent qw(Kernel::System::Console::BaseCommand);
our @ObjectDependencies = (
'Kernel::System::GenericInterface::DebugLog',
);
sub Configure {
my ( $Self, %Param ) = @_;
$Self->Description('Read parts of the generic interface debug log based on your given options.');
$Self->AddOption(
Name => 'communication-id',
Description => "Restriction on the communication id.",
Required => 0,
HasValue => 1,
ValueRegex => qr/.*/smx,
);
$Self->AddOption(
Name => 'communication-type',
Description => "Restriction on the communication type.",
Required => 0,
HasValue => 1,
ValueRegex => qr/^(?:Provider|Requester)$/smx,
);
$Self->AddOption(
Name => 'created-at-or-after',
Description => "Restriction on entries created after given timestamp.",
Required => 0,
HasValue => 1,
ValueRegex => qr/^\d{4}-\d{2}-\d{2}[ ]\d{2}:\d{2}:\d{2}$/smx,
);
$Self->AddOption(
Name => 'created-at-or-before',
Description => "Restriction on entries created before given timestamp.",
Required => 0,
HasValue => 1,
ValueRegex => qr/^\d{4}-\d{2}-\d{2}[ ]\d{2}:\d{2}:\d{2}$/smx,
);
$Self->AddOption(
Name => 'remote-ip',
Description => "Restriction on entries of a given ip address.",
Required => 0,
HasValue => 1,
ValueRegex => qr/.*/smx,
);
$Self->AddOption(
Name => 'webservice-id',
Description => "Restriction on entries of a given web service id.",
Required => 0,
HasValue => 1,
ValueRegex => qr/^\d+$/smx,
);
$Self->AddOption(
Name => 'with-data',
Description => "Restriction on entries of a given web service id.",
Required => 0,
HasValue => 0,
);
$Self->AddOption(
Name => 'limit',
Description => "Specify result entries limit, default is 100.",
Required => 0,
HasValue => 1,
ValueRegex => qr/^\d+$/smx,
);
return;
}
sub Run {
my ( $Self, %Param ) = @_;
# get options
my $CommunicationID = $Self->GetOption('communication-id');
my $CommunicationType = $Self->GetOption('communication-type');
my $CreatedAtOrAfter = $Self->GetOption('created-at-or-after');
my $CreatedAtOrBefore = $Self->GetOption('created-at-or-before');
my $RemoteIP = $Self->GetOption('remote-ip');
my $WebserviceID = $Self->GetOption('webservice-id');
my $WithData = $Self->GetOption('with-data');
my $Limit = $Self->GetOption('limit');
# create needed objects
my $DebugLogObject = $Kernel::OM->Get('Kernel::System::GenericInterface::DebugLog');
# search for log entries
$Self->Print("Searching for DebugLog entries...\n\n");
my $LogData = $DebugLogObject->LogSearch(
CommunicationID => $CommunicationID,
CommunicationType => $CommunicationType,
CreatedAtOrAfter => $CreatedAtOrAfter,
CreatedAtOrBefore => $CreatedAtOrBefore,
RemoteIP => $RemoteIP,
WebserviceID => $WebserviceID,
WithData => $WithData,
Limit => $Limit,
);
if ( ref $LogData eq 'ARRAY' ) {
my $Counter = 0;
for my $Item ( @{$LogData} ) {
for my $Key (qw( LogID CommunicationID CommunicationType WebserviceID RemoteIP Created )) {
$Self->Print("$Key: $Item->{$Key}, ");
}
$Self->Print("\n");
if ($WithData) {
for my $DataItem ( @{ $Item->{Data} } ) {
$Self->Print(" - ");
for my $Key (qw( DebugLevel Summary Data Created)) {
$Self->Print("$Key: $DataItem->{$Key}, ");
}
$Self->Print("\n");
}
}
$Self->Print("\n");
$Counter++;
}
$Self->Print("\n Log entries found: $Counter \n");
}
else {
$Self->Print("No DebugLog entries were found.\n");
}
return $Self->ExitCodeOk();
}
1;
|
