=head1 NAME

ngcp-logs - parses NGCP log files in a simplified and improved way

=head1 SYNOPSIS

B<ngcp-logs> [I<option>...] [I<search-string>]

=head1 DESCRIPTION

B<This program> parses NGCP log files and shows them in a simplified and improved way
Default configurations can be modified editing the dedicated config file.

=head1 OPTIONS

=over 8

=item B<-l>

Define which log files should be parsed. Available are proxy,lb,sems,b2b,pbx,rtp,api,panel.
It is possible to use also a short notation: p,l,s,b,x,r,a,n.
If no log is specified, the script will search in the proxy log only.
For multiple log files use the '+' symbol (i.e. proxy+lb+sems) or repeat this option more
than one time (i.e. -l proxy -l lb -l sems).

=item B<-n>

Nodes that will be used for logs search. Relevant on PRO or CARRIER setups.
By default the current host is used but you can specify an alternative one by using the
node name ('prx01a' or 'lb01a' or 'sp2' ... or use 'all' to search on both peers).
Use 'all' to search the string in all the nodes.
For multiple nodes use the '+' symbol (i.e. prx01a+lb01a+sp2) or repeat this option more
than one time (i.e. -n prx01a -n lb01a -n sp2).

=item B<-i>

By default the script skips the search on inactive nodes, to save time and resources.
With this option you can search the string also on inactive nodes.

=item B<-d>

Search logs only for the provided date. By default today.
Format is:
             20170531 (YYYYMMDD)                 - date

=item B<-f>

Search logs only from the provided date. (not active at the moment)
Format is:
             20170531 (YYYYMMDD)                 - date

=item B<-t>

Search logs only till the provided date. (not active at the moment)
Format is:
             20170531 (YYYYMMDD)                 - date

=item B<-c>

Search the string ignoring case distinctions.
Attention: it could increase the required time and resources.

=item B<-e>

 Extend the search to other files.
 If -d option is not provided extend the search to the log file of the day if present.
 If -d option is provided extend the search to the log file of the following day.

=back

=head1 EXIT STATUS

=over 8

=item B<exit code 0>

Everything is ok

=item B<exit code != 0>

Something is wrong, an error message raises

=back

=head1 INCOMPATIBILITIES

No known at this time.

=head1 BUGS AND LIMITATIONS

Please report problems you notice to the Sipwise Support Team <support@sipwise.com>.

=head1 AUTHOR

Marco Capetta <mcapetta@sipwise.com>,
Kirill Solomko <ksolomko@sipwise.com>,
Alessio Garzi <agarzi@sipwise.com>.

=head1 LICENSE AND COPYRIGHT

GPL-3+, Sipwise GmbH, Austria

=cut
