Configuring Syslog Northbound Parameters

Updated on 2022-08-12 GMT+08:00

View PDF

Scenarios

If users need to view alarms and events of a cluster on the unified alarm reporting platform, you can use the Syslog protocol on FusionInsight Manager to report related data to the alarm platform.

NOTICE:

If the Syslog protocol is not encrypted, data may be stolen.

Procedure

Log in to FusionInsight Manager.
Choose System > Interconnection > Syslog.
Turn on the switch on the right of Syslog Service.

The Syslog service is disabled by default. indicates that the service is enabled.

Set northbound parameters based on information provided in Table 1.

**Table 1** Syslog interconnection parameters
Parameter Area	Parameter	Description
Syslog Protocol	Server IP Address Mode	Set the IP address mode of the interconnected server.The value can be IPv4 or IPv6.
	Server IP Address	Sets the IP address of the interconnection server.
	Server Port	Specifies the port number for interconnection.
	Protocol	Sets the protocol type. The available values are as follows: TCP UDP
	Severity Level	Specifies the severity of the reported message. The options are as follows: Emergency Alert Critical Error Warning Notice Informational (default value) Debug NOTE: Severity and Facility determine the priority of the sent message. Priority = Facility × 8 + Severity For details about the values of Severity and Facility, see Table 2.
	Facility	Sets the module where the log is generated. For details about the available value of this parameter, see Table 2. The default value local use 0 (local0) is recommended.
	Identifier	Sets the product ID. The default value is FusionInsight Manager. The identifier can contain a maximum of 256 characters, including letters, digits, underscores (_), spaces, \|, $, {, }, periods (.), and hyphens (-).
Report Message	Report Format	Sets the message format of the alarm report. For details, see help information on the page. The packet can contain letters, digits, underscores (_), spaces, \|, $, {, }, periods (.), and hyphens (-), and cannot exceed 1024 characters. NOTE: For details about the information field in the packet format, see Table 3.
	Alarm Type	Sets the type of the alarm to be reported.
	Alarm Severities	Sets the level of the alarm to be reported.
Uncleared Alarm Reporting	Periodic Uncleared Alarm Reporting	Sets whether to report uncleared alarms in a specified period. Turn on the switch indicates that the function is enabled, and turn off the switch indicates that the function is disabled. The switch is turned off by default.
Uncleared Alarm Reporting	Report Interval (min)	Sets the interval at which alarms are reported periodically. This parameter is valid only when the switch is turned on on the right of Periodic Uncleared Alarm Reporting. The default value is 15, in minutes. The value ranges from 5 to 1440 (one day).
Heartbeat Settings	Heartbeat Reporting	Sets whether to periodically report Syslog heartbeat messages. Turn on the switch indicates that the function is enabled, and turn off the switch indicates that the function is disabled. The switch is turned off by default.
	Heartbeat Period (min)	Sets the interval at which heartbeat messages are periodically reported. This parameter is valid only when the switch is turned on on the right of Heartbeat Reporting. The default value is 15, in minutes. The value ranges from 1 to 60.
	Heartbeat Packet	Sets the heartbeat message to be reported. This parameter is enabled if the switch is turned on on the right of Heartbeat Reporting, and cannot be left blank. The value can contain a maximum of 256 characters, including digits, letters, underscores (_), vertical bars (\|), colons (:), spaces, commas (,), and periods (.).

NOTE:

After the periodic heartbeat packet function is enabled, packets may be interrupted during automatic recovery of some cluster error tolerance (for example, active/standby OMS switchover). In this case, wait for automatic recovery.

Click OK to complete the settings.

Related Information

**Table 2** Numeric codes of **Severity** and **Facility**
Severity	Facility	Numeric Code
Emergency	kernel messages	0
Alert	user-level messages	1
Critical	mail system	2
Error	system daemons	3
Warning	security/authorization messages (note 1)	4
Notice	messages generated internally by syslogd	5
Informational	line printer subsystem	6
Debug	network news subsystem	7
-	UUCP subsystem	8
-	clock daemon (note 2)	9
-	security/authorization messages	10
-	FTP daemon	11
-	NTP subsystem	12
-	log audit (note 1)	13
-	log alert (note 1)	14
-	clock daemon	15
-	local use 0~7 (local0 ~ local7)	16 to 23

**Table 3** Packet format information field
Information Field	Description
dn	Cluster name
id	Alarm ID
name	Alarm name
serialNo	Alarm serial number NOTE: The sequence numbers of the fault alarms and the corresponding recovery alarms are the same.
category	Alarm type. The options are as follows: 0: fault alarms 1: cleared alarms 2: event
occurTime	Time when the alarm was generated
clearTime	Time when this alarm is cleared
isAutoClear	Whether an alarm is automatically cleared. The options are as follows: 1: yes 0: no
locationInfo	Location where the alarm is generated
clearType	Alarm clearance type. The options are as follows: -1: not cleared 0: automatic cleared 2: manually cleared
level	Severity. The options are as follows: 1: critical alarms 2: major alarms 3: minor alarms 4: warning alarms
cause	Alarm cause
additionalInfo	Additional information
object	Alarm object