Tech Support

Tech Support and System Logs

Multi-Site Orchestrator system logging is automatically enabled when you first deploy the Orchestrator cluster and captures the events and faults that occur in the environment.

You can choose to download the logs at any time or stream them to an external log analyzer, such as Splunk, if you want to use additional tools to quickly parse, view, and respond to important events without a delay.

Downloading System Logs

This section describes how to generate a troubleshooting report and infrastructure logs file for all the schemas, sites, tenants, and users that are managed by Multi-Site Orchestrator.

Procedure

Step 1

Log in to your Multi-Site Orchestrator GUI.

Step 2

Open the System Logs screen.

  1. In the main menu, select Operations > Tech Support.

  2. In the top right corner of the System Logs frame, click the edit button.

Step 3

Download the logs.

  1. Select which logs you want to download.

  2. Click the Download button.

    An archive of the selected items will be downloaded to your system. The report contains the following information:

    • All schemas in JSON format

    • All sites definitions in JSON format

    • All tenants definitions in JSON format

    • All users definitions in JSON format

    • All logs of the containers in the infra_logs.txt file

Streaming System Logs to External Analyzer

Multi-Site Orchestrator allows you to send the Orchestrator logs to an external log analyzer tool in real time. By streaming any events as they are generated, you can use the additional tools to quickly parse, view, and respond to important events without a delay.

This section describes how to enable Multi-Site Orchestrator to stream its logs to an external analyzer tool, such as Splunk or syslog.

Before you begin

  • This release supports only Splunk and syslog as external log analyzer.

  • This release supports syslog only for Multi-Site Orchestrator in Application Services Engine deployments.

  • This release supports up to 5 external servers.

  • If using Splunk, set up and configure the log analyzer service provider.

    For detailed instructions on how to configure an external log analyzer, consult its documentation.

  • If using Splunk, obtain an authentication token for the service provider.

    Obtaining an authentication token for Splunk service is detailed in the Splunk documentation, but in short, you can get the authentication token by logging into the Splunk server, selecting Settings > Data Inputs > HTTP Event Collector, and clicking New Token.

Procedure

Step 1

Log in to your Multi-Site Orchestrator GUI.

Step 2

Open the System Logs screen.

  1. In the main menu, select Operations > Tech Support.

  2. In the top right corner of the System Logs frame, click the edit button.

Step 3

In the System Logs window, enable external streaming and add a server.

  1. Enable the External Streaming knob.

  2. Choose whether you want to stream All Logs or just the Audit Logs.

  3. Click Add Server to add an external log analyzer server.

Step 4

Add a Splunk server.

If you do not plan to use Splunk service, skip this step.

  1. Choose Splunk for the server type.

  2. Choose the protocol.

  3. Provide the server name or IP address, port, and the authentication token you obtained from the Splunk service.

    Obtaining an authentication token for Splunk service is detailed in the Splunk documentation, but in short, you can get the authentication token by logging into the Splunk server, selecting Settings > Data Inputs > HTTP Event Collector, and clicking New Token.

  4. Click the checkmark icon to finish adding the server.

Step 5

Add a syslog server.

If you do not plan to use syslog, skip this step.

  1. Choose syslog for the server type.

  2. Choose the protocol.

  3. Provide the server name or IP address, port number, and the severity level of the log messages to stream.

  4. Click the checkmark icon to finish adding the server.

Step 6

Repeat the steps if you want to add multiple servers.

This release supports up to 5 external servers.

Step 7

Click Save to save the changes.