SyslogPlatformService (platform-PlatformServiceProperties)
As of Niagara 4.13 Syslog Configuration is available in PlatformServices. Syslog is a standard protocol for message logging, which allows messages generated by Niagara to be stored and analyzed on a remote server.
To access this view, expand and double-click SyslogPlatformService.
| Property | Value | Description |
|---|---|---|
| Platform Service Description | read-only | Displays the name of the service. |
| Syslog Settings | additional properties | Configures additional parameters. Refer to Syslog Settings section below. |
| Station Server Status | read-only (disabled) | Displays the status of last station log message sent to the syslog server. |
| Queue Full Percent Station | read-only (defaults to 0%) | If connection is down, percentage of queue of station message used. |
| Platform Server Status | read-only (disabled) | Displays the status of last platform log message sent to the syslog server. |
| Queue Full Percent Platform | read-only to 0%) | If connection is down, percentage of queue of platform message used. |
| Syslog Server Connection Alarm Enabled | true (default) or false | If set to true, it generates alarms on connection failure (only for TCP and TLS). |
| Syslog Server Connection Alarm Support | additional properties | Configures additional parameters to generate alarms. |
| Syslog Message Queue Alarm Enabled | true (default) or false | If set to true, it generates alarms on queue full. |
| Syslog Message Queue Alarm Support | additional properties | Configures additional parameters to generate alarms. |
Syslog Settings
| Type | Value | Description |
|---|---|---|
| Enabled | false (default) or true | Disables (false) or enables (true) the system log service. |
| Server Host | IP address | Specifies the IP address or hostname of the Syslog Server. |
| Server Port | number (defaults to 1514) | Specifies the port for communication. |
| Message Type | read-only | Specifies the type of message supported. Currently only the BSD type is supported. |
| Transport Protocol | drop-down list | Specifies the transport protocol used for communicating messages to the server. |
| Client Alias And Password | text | This is only required if the syslog server requires mutual TLS (mTLS) protocol. This property defines the client certificate in the User Key Store to use. Refer in Niagara Station Security Guide to “Creating a Client Certificate for Syslog configuration” for more information on generating Client Certificates. |
| Platform Log Enabled | true (default) or false | Enables (true) or disables (false) the platform logs sent to the server. |
| Station Log Enabled | true (default) or false | Enables (true) or disables (false) the station logs sent to the server. |
| Log Level Filter | Off, Severe, Warning, Info, Config, Fine, Finer, Finest, All (defaults to Info) | Sets the minimum level of platform and station logs that will be sent to the syslog server. |
| Station Audit Enabled | true (default) or false | Enables (true) or disables (false) the station audit records sent to the server. |
| Security Audit Enabled | true (default) or false | Enables (true) or disables (false) the security audit records sent to the server. |
| Facility | drop-down list (defaults to local0) | Specifies the facility (or process) which generated the syslog messages. |
| Queue Size | number (defaults to 1000) | Specifies the queue size to hold the messages until they are sent. |