Log Server Management

Log server management sends management node logs or platform operation logs to external logging systems for centralized retention, search, and analysis.

Select an output based on the type of logs that you want to send:

Log Type	Purpose	Supported Outputs
Management Node Log	Centrally retains management node logs for troubleshooting.	Syslog.
Platform Operation Log	Sends platform operation logs to an external logging system for centralized search and analysis.	Syslog, Elasticsearch, Forward, Kafka, and Loki.

Add a Log Server

Add a log server to send management node logs or platform operation logs to an external logging system.

Before you begin

The current user must have admin privileges.
An external logging system has been deployed to receive logs.
The management node can communicate with the external logging system over the network.

Procedure

In the navigation pane, choose System Management > Log Server.
On the Log Server page, click Add Log Server.

Configure the log server.

Option	Description
Name	Set the log server name.
Description	Enter a brief description for the log server.
Log Type	Select the type of logs to send: Management Node Log: Sends management node logs. Platform Operation Log: Sends platform operation logs.
Output	Select a log output: Management node logs can be sent to Syslog. Platform operation logs can be sent to Syslog, Elasticsearch, Forward, Kafka, or Loki.

Configure the output.

For details about the options for each output, see Log Server Configuration Options.
Optional: Click Test Connection to test the network connection between the platform and the log server.
Review the configuration and click OK.

Results

The log server is added and displayed in the log server list.

Log Server Configuration Options

The available log server options depend on the log type and output.

Syslog

Option	Description
Address	Enter the IP address, domain name, or URL of the Syslog server.
Port	Enter the Syslog service port. The default port is 514.
Protocol	Select UDP or TCP.
Log Facility	This option is available for management node logs. Select a log facility from LOCAL0 through LOCAL7. The value must match the configuration on the Syslog server.
Log Severity Level	This option is available for management node logs. Select ALL, TRACE, DEBUG, INFO, WARN, ERROR, or FATAL.

Elasticsearch

Option	Description
Address	Enter the IP address, domain name, or URL of the Elasticsearch service.
Port	Enter the Elasticsearch service port. The default port is 9200.
Index	Enter the index used to store platform operation logs.
TLS	Specify whether to encrypt the connection with TLS.
Username	Enter the username for the Elasticsearch service.
Password	Enter the password for the Elasticsearch service.

Forward

Option	Description
Address	Enter the IP address, domain name, or URL of the Forward service.
Port	Enter the Forward service port. The default port is 24224.

Kafka

Option	Description
Address	Enter the IP address, domain name, or URL of the Kafka service.
Port	Enter the Kafka service port. The default port is 9092.
Topics	Enter the Kafka topic used to receive platform operation logs.

Loki

Option	Description
Address	Enter the IP address, domain name, or URL of the Loki service.
Port	Enter the Loki service port. The default port is 3100.
Labels Job	Set the log label written to Loki. The default value is `job=operator`.
TLS	Specify whether to encrypt the connection with TLS.
Username	Enter the username for the Loki service.
Password	Enter the password for the Loki service.

Edit, Test, and Delete Log Servers

From the log server list, you can edit log server information, test network connections, and delete log servers that are no longer needed.

In the navigation pane, choose System Management > Log Server. Use the action menu in a resource row to manage an individual log server. To perform a batch operation, select one or more log servers and click Actions.

Operation	Description
Edit	Change the name and description of a log server.
Test Connection	Test the network connection between the platform and one or more log servers.
Delete	Delete one or more log servers that are no longer needed.

PreviousTime Management NextEmail Server Management