Reference12r1:Services/Logging

From innovaphone-wiki

Revision as of 11:07, 3 December 2018 by Vsc (Talk | contribs)
(diff) ←Older revision | Current revision (diff) | Newer revision→ (diff)
Jump to: navigation, search
There are other versions of this article: Reference | Reference7 | Reference9 | Reference10 | Reference12r1 (this version)

Contents

Log Server

External logging is disabled by default (Off). You can still view log messages in real time (see Logging), but messages are not stored or sent to an external destination.

Available Types:

Off: Logging is disabled.
TCP: The device transmits the syslog entries using a TCP connection.
  • In the Address field, the remote IP-address is entered.
  • In the Port field, the remote port is specified.
SYSLOG: The syslog entries are transmitted to a syslog recipient (also referred to as syslogd, syslog server or syslog daemon).
  • In the Address field, the IP-address of the syslogd server is entered.
  • In the Class field, the syslog message class for the syslog entries sent is entered. The class is a numeric value between 0 and 7, it will be used as Facility (0 => local0, ... 7 => local7). The Severity field will always be 6 (informational). See wikipedia.org/wiki/Syslog for details.
HTTP: The syslog entries are transferred to a web server. Each individual syslog entry is transferred to the server as an individual request.
  • In the Address field, the IP-address of remote server is entered.
  • In the Path field, the relative URL to be used in the HTTP request is entered.
  • The Method field selects the method used to send the request. There are 3 formats available:
Format Request Type URI Description
Standard POST hardwired This should be used to forward log messages to another innovaphone device, e.g. to store it on a central CF card
External(POST) POST as defined in the Path field This is identical to the Standard method, except that you may specifiy the URI to be used
External(GET) GET as defined in the Path field The log message will be coded into GET form data (a.k.a. query args). This method is compatible to the method used in firmware versions 5.01 and 6.

For more information on HTTP request formatting, see Reference7:HTTP Request Message Format.

If the addressed Web server requires authentication, an Authenticated URL has to be configured on the HTTP-Client Page. The URL constructed by the logger is shown right next to the Path field. It must be entered in exactly this format on the HTTP-Client Page. The device has to be restarted after the Authenticated URL has been set.

LOCAL: The syslog entries are saved to the local CF card into the /log directory, e.g. \\ipaddr\drive\CF0\log. Log files named LOG0.n are created, where n goes from 0 to 3. The next log file is created when either the Max File Size is reached or the Backup Time has passed. LOG0.0 is the newest log file always.

To concentrate all syslog messages to a single CF card, you would use the HTTP Log Server Type in all but one boxes with Method set to Standard. Address must be set to the IP-address of the single box that has the CF card used for log message storage. Port must be set to the port configured for the HTTP-Server of this box.

LOCAL-AP: The logs are transmitted to the local Linux application platform. Logs are stored under \\AP-IP\webdav\log\ and alarms under \\AP-IP\webdav\alarm\
REMOTE-AP: The logs are transmitted to a remote Linux application platform. Store path is the same as under LOCAL-AP.
  • In the Address field, you enter the IP address of the remote Linux application platform.
  • In the Port field, you specify the port to which the connection is set up.

Remark: Don't forget to enable access to \\AP-IP\ap\log.fcgi as required for use of LinAP as logserver.

REMOTE-AP-S: Same as REMOTE-AP, just a secure transmission is used.

Alarm and Event Handling

Alarm and event forwarding is configured independently from the handling of log messages.

If no Forward Server is configured in the Alarm and Event Forward Server area, alarms and events are stored locally as specified in the Local Alarm and Event Queues area below. Otherwise, alarms and events are additionally forwarded to the external server using HTTP requests. Each individual alarm or event entry is transferred to the server as an individual request.
SYSLOG option is only available on Gateway devices. Phones should use HTTP to forward alarm/events to an innovaphone gateway which may forward the collected events to a syslog server.

  • The Address is used to set the IP-address of an external HTTP server that will receive the forwarded alarms and events.
  • The Port defines the TCP port the HTTP request is sent to.
  • The Method selects the method used to send the the requests. The same methods as for the Log Server are available here. (only on gateways)

To collect all alarms and events in a single device card, you would use the Standard Method in all but one boxes. Address must be set to the IP-address of the central box. Port must be set to the port configured for the HTTP-Server of this box.
The collected alarms and events may further be forwarded to one or two SYSLOG server(s) as XML-encoded records. This is achieved by configuring a Forward Server with Method SYSLOG, the server address under Address and the SYSLOG-Class under Class.

A second server may be configured as Log Server Shadow receiving the same records as the first server.

The Local Alarm and Event Queues area allows you to control the number of events and alarms that are kept in memory and stored in non-volatile memory during restarts.

Alarms and Errors as Email

Definition of email target to send alarms and errors as email to.

  • Sender Address: email adress of sender
  • Senders' Name: alias of sender name
  • Recipient Address: email adress of recipient
  • Recipients' Name: alias of recipient name
  • Email Server Address: ip-adress or DNS name of smtp email server. No SMTP TLS is supported.
  • User: user account at email server
  • Password: user password at email server

Handling of incoming Alarms/Events

Authenticate: When enabled request HTTP Authentication for the incoming HTTP Alarms/Events messages. You must configure in the sender the HTTP credentials to be able to deliver the Alarms/Events.

Local Alarm and Event Queues

Memory Queue Entries: Maximum number of faults and alarms to hold in volatile memory (DRAM)(Default:100).
Persistent Queue Entries: Maximum number of faults and alarms to keep in flash memory (Default:50).
Personal tools