Perl Agent for Aino.io

Perl implementation of Aino.io logging agent

What is Aino.io and what does this Agent have to do with it?

Aino.io is an analytics and monitoring tool for integrated enterprise applications and digital business processes. Aino.io can help organizations manage, develop, and run the digital parts of their day-to-day business. Read more from our web pages.

Aino.io works by analyzing transactions between enterprise applications and other pieces of software. This Agent helps to store data about the transactions to Aino.io platform using Aino.io Data API (version 2.0). See API documentation for detailed information about the API.

Technical requirements

• Perl 5

Agent requires some external libraries:

• LWP::Protocol::https
• Proc::Daemon

Example usage

Minimal example (only required fields)

require "path/to/aino/AinoLib.pm";

Aino::Lib->set_api_key('YOUR API KEY HERE');

my $message = Aino::Lib->new_aino_transaction();

$message->set_to('To application')
        ->set_from('From application')
        ->set_status('success');

Aino::Lib->send_transaction($message);

Full example

require "path/to/aino/AinoLib.pm";

Aino::Lib->set_api_key('YOUR API KEY HERE');
Aino::Lib->set_gzip_enabled(1);
Aino::Lib->set_proxy_addr('http://internal.proxy.address:port');

my $message = Aino::Lib->new_aino_transaction();

$message->set_message('message')
        ->set_to('To application')
        ->set_from('From application')
        ->set_status('success')
        ->set_flowId('aka.correlationId')
        ->set_operation('Business operation 1')
        ->set_payloadType('Invoices');

$message->add_ids('Invoice number', (55123, 88634, 55111));
$message->add_metadata('key', 'value');

my $fork = 1;   # Fork the sending to background process with 1.
                # When set to 0, does not fork and returns when the HTTP request is done

Aino::Lib->send_transaction($message, $fork);

This agent can also be used from command line.

Logging from command line

perl aino-agent.pl
    --from "From application" \
    --to "To application" \
    --status "failure" \
    --apikey "YOU API KEY HERE" \

What to use as flow ID

The flow ID, also known as correlation ID or correlation key is an identifier that allows aino to group several aino transaction invocations into a single transaction.

If user does not set flow Id, it will be automatically generated. By calling Aino::Lib->init_flow_id, all subsequent messages will have the same flow id. This can be overridden by setting the messages flow id manually:

$msg->set_flowId('desired flow id');

Calling Aino::Lib->clear_flow_id will clear the flow id set in Aino::Lib->init_flow_id.

Contributing

Technical Requirements

Same as above, but also this for running tests:

• Test::Deep::NoTest

Contributors

• Jussi Mikkonen
• Ville Harvala

License

Copyright © 2016 Aino.io. Licensed under the Apache 2.0 License.