otrs -> rel-6_0 API documentation

NAME

Kernel::GenericInterface::Debugger

DESCRIPTION

GenericInterface data debugger interface.

For every communication process, one Kernel::GenericInterface::Debugger object should be constructed and fed with data at the various stages of the process. It will collect the data and write it into the database, based on the configured debug level.

PUBLIC INTERFACE

new()

create an object.

use Kernel::GenericInterface::Debugger;

my $DebuggerObject = Kernel::GenericInterface::Debugger->new(
    DebuggerConfig   => {
        DebugThreshold  => 'debug',
        TestMode        => 0,           # optional, in testing mode the data will not be written to the DB
        # ...
    },

    WebserviceID        => 12,
    CommunicationType   => Requester, # Requester or Provider

    RemoteIP        => 192.168.1.1, # optional
    CommunicationID => '02a381c622d5f93df868a42151db1983', # optional
);

DebugLog()

add one piece of data to the logging of this communication process.

$DebuggerObject->DebugLog(
    DebugLevel => 'debug',
    Summary    => 'Short summary, one line',
    Data       => $Data, # optional, $Data can be a string or a scalar reference
);

Available debug levels are: 'debug', 'info', 'notice' and 'error'. Any messages with 'error' priority will also be written to Kernel::System::Log.

Debug()

passes data to DebugLog with debug level 'debug'

$DebuggerObject->Debug(
    Summary => 'Short summary, one line',
    Data    => $Data, # optional, $Data can be a string or a scalar reference
);

Info()

passes data to DebugLog with debug level 'info'

$DebuggerObject->Info(
    Summary => 'Short summary, one line',
    Data    => $Data, # optional, $Data can be a string or a scalar reference
);

Notice()

passes data to DebugLog with debug level 'notice'

$DebuggerObject->Notice(
    Summary => 'Short summary, one line',
    Data    => $Data, # optional, $Data can be a string or a scalar reference
);

Error()

passes data to DebugLog with debug level 'error' then returns data structure to be used as return value in calling function

$DebuggerObject->Error(
    Summary => 'Short summary, one line',
    Data    => $Data, # optional, $Data can be a string or a scalar reference
);

TERMS AND CONDITIONS

This software is part of the OTRS project (https://otrs.org/).

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.