Reference7:Configuration/General/Logging: Difference between revisions

From innovaphone wiki
Jump to navigation Jump to search
m (New page: == Logging == External '''logging''' is disabled by default (Off). You can still view log messages in real time (see Reference7:Administration/Diagnostics/Logging), but messages are no...)
 
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== Logging ==
== Logging ==
External '''logging''' is disabled by default (Off). You can still view log messages in real time (see [[Reference7:Administration/Diagnostics/Logging]]), but messages are not stored or sent to an external destination.
External '''logging''' is disabled by default (Off). You can still view log messages in real time (see [[Reference7:Administration/Diagnostics/Logging|Logging]]), but messages are not stored or sent to an external destination.


Available ''Type''s:
Available ''Type''s:
Line 10: Line 10:
|valign=top nowrap=true|'''TCP:'''
|valign=top nowrap=true|'''TCP:'''
| The device transmits the syslog entries using a TCP connection.
| The device transmits the syslog entries using a TCP connection.
* In the Address field, the destination IP-address is entered.
* In the '''Address''' field, the remote IP-address is entered.
* In the Port field, the port to which the connection is set up is specified.
* In the '''Port''' field, the remote port is specified.
|-
|-
|valign=top nowrap=true|'''SYSLOG:'''
|valign=top nowrap=true|'''SYSLOG:'''
| The syslog entries are transmitted to a syslog recipient (also referred to as syslogd, syslog server or syslog daemon ), which is then responsible for their further evaluation or storage.
| 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 '''Address''' field, the IP-address of the syslogd server is entered.
* In the Class field, the desired message class that will be responsible for further processing of the syslog entries is entered. The syslog class is a numeric value between 0 and 7.
* 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.
|-
|-
|valign=top nowrap=true|'''HTTP:'''
|valign=top nowrap=true|'''HTTP:'''
| The syslog entries are transferred to a Web server, where they can be further processed. Each individual syslog entry is transferred as form data to the Web server in HTTP GET format (a.k.a ''query args'').
| 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-Adresse of the Web server that carries out further processing of the transmitted data is entered.
* In the '''Address''' field, the IP-address of remote server is entered.
* In the Path field, the relative URL of the form program on the Web server is entered.
* In the '''Path''' field, the relative URL to be used in the HTTP request is entered.
The device will make a HTTP GET request to the Web server on the entered URL, followed by the URL-encoded syslog entry. If, for example, a page named /cdr/cdrwrite.asp with a form that expects the log message in parameter msg exists on a Web server, then the value /cdr/cdrwrite.asp is entered. The device will then make a GET /cdr/cdrwrite.asp?event=syslog&msg=logmsg request to the Web server.
* 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 ''Autenticated URL'' has to be configured on the [[Reference:Configuration/General/HTTP-Client|HTTP-Client]] Page. The ''URL'' constructed by the logger has no leading protocol part but starts directly with the IP address. It must be entered in exactly this format on the [[Reference:Configuration/General/HTTP-Client|HTTP-Client]] Page. HTTP logging hat to be restarted after the ''Autenticated URL'' has been set. The constructed ''URL'' is displayed right of the Path input field after pressing OK.
If the addressed Web server requires authentication, an ''Authenticated URL'' has to be configured on the [[Reference:Configuration/General/HTTP-Client|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 [[Reference:Configuration/General/HTTP-Client|HTTP-Client]] Page. The device has to be restarted after the ''Authenticated URL'' has been set.  
|-   
|-   
|valign=top nowrap=true|'''LOCAL:'''
|valign=top nowrap=true|'''LOCAL:'''
| The syslog entries are saved to [[Reference:Administration/Diagnostics/CF|the local CF card]] into the '''/log''' directory, e.g. '''\\''172.16.0.10''\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.
| The syslog entries are saved to [[Reference:Administration/Diagnostics/CF|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.  The '''Path''' must be set to '''LOG0/post-msg''' (attention: no leading slash), the '''Address''' must be set to the IP address of the single box that has the CF card used for log message storage, the '''Port''' must be set to  the port configured for the [[Reference:Configuration/General/HTTP-Server|HTTP-Server]] of this box.   
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 [[Reference:Configuration/General/HTTP-Server|HTTP-Server]] of this box.   
|}
|}
== Alarm and Event Handling ==
== Alarm and Event Handling ==
Alarm and Event Forwarding is configured independantly from the handling of log messages.
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.
 
* 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.
 
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 [[Reference7:Configuration/General/HTTP-Server|HTTP-Server]] of this box. 
 
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.

Latest revision as of 09:32, 24 September 2008

Logging

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.
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.

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.

  • 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.

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 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.

Retrieved from "https://wiki.innovaphone.com/index.php?title=Reference7:Configuration/General/Logging&oldid=11920"