Managing logs in Digital Access

This article describes how to manage logs and logging settings in the Digital Access administration portal.

Before you start, you must sign in to Digital Access Admin with an administrator account.

Log Viewer

Log Viewer is used to filter and display the logging messages. You can filter the log events based on type, services, specific search criteria, and time range.

To access the log function, go to Monitor System > Log Viewer. From this view, you can search for specific logging messages for all services. For more information, see Status and reports in Digital Access.

Log Viewer can only retrieve logs if the connection from the Admin Service is live and is able to collect them.

Log types

The different log types in Digital Access are described below:

Log type	Description
System log	This log type contains general information about the system. The system log in the Log Viewer contains the levels INFO, WARNING, and FATAL.
Audit log	This log type contains log information that contains important timestamp events, for example, user activity in Digital Access. If a user fails to sign in to the system, the information and reason can be found in the audit logs.
RADIUS log	Remote Authentication Dial-In User Service (RADIUS) is a networking protocol that provides centralized authentication, authorization, and accounting management for users who connect and use a network service. For more information, see Set up RADIUS client in Digital Access.
HTTP log	This log type contains log entries for requests, both successful and failed. You can view the log file for a site at any time to see the request method and status.
Billing log	This log type enables Digital Access to collect statistics for charging customers based on ticks in external systems, for example, SMS sent, etc.
Debug	This log type helps developers diagnose application problems and errors. Debug logging specifically focuses on providing information to the Policy Service End-Point Integrity and Protection log, the Access Point raw external log, the raw internal log, the raw proxy interchange log, the hyperlinks log, and the form based log.
Messages	This log type contains Java stack-trace information if such an error has occurred. For some errors, the Debug Logging option must be enabled for this to be logged, to prevent the log from filling up to quickly. These logs cannot be viewed via the Log Viewer, but are included in Diagnostics file.
Hyperlinks	This log type contains entries for any resource that is accessed in an access point.
RawExternal	This log type contains the raw HTTP request and response data between the client, for example, the web browser, as the requester and DA Access Point as the responder. This is useful when reviewing the actual request and response data between these two parties. Debug Logging must be enabled for this logging to be done and this is not recommended in a production environment. The log is cleared on each Publish via the administrator user interface.
RawInternal	This log type is similar to the RawExternal log type, but contains the raw HTTP request and response data between DA Access Point as the requester and a back-end resource as the responder. This may be blank if no requests have been made to a back-end via Digital Access.
RawProxyInterchange	This log type contains the raw data communicated between Access Point nodes. This low level information can be useful when debugging what type of information is shared between Access Points. Debug Logging must be enabled for logging to be performed to this log type.

Download the diagnostics file

To download a diagnostics .zip file containing all logs for the selected servers, do the following:

1. Go to Monitor System > Diagnostics File and set the filter selection.

2. Click Create diagnostics file to download the file. Depending on the file size, it may take some time to download.

The diagnostics file also contains all configuration files and message logs, as well as the debug logs, including the Access Point raw external and internal logs, raw proxy interchange log, form based log, and hyperlinks log.

Manage global logging settings

From the Manage Global Logging Settings view, you can set the directory path to store logs, select time zone to register logging events, enter interval for the collection of network server logs, and manage remote logging, delta logging, and debug logging.

To access the global logging settings, go to Monitor system > Logging and select Manage Global Logging Settings.

Remote logging

The remote log settings defines the location where log entries are stored and credentials to reach that location. You can also test and verify the connection from this view.

To enable remote logging, enter data into the fields and click Save. To test the connection before saving, click Test Connection to Remote Log Location.

Delta logging

You can enable delta logging to view a log of the time spent for specific operations, for example, authentication through XPI, User database operations. This can determine how many milliseconds it takes for the Digital Access services to process a request. The delta logging will print the logs at the INFO level in the System log.

Make sure to disable the option when you are done.

1. Go to Monitor system > Logging and select Manage Global Logging Settings.

2. On the view that appears, select Enable delta logging and click Save.

Enable debug logging

You can enable debug logging. do the following:

1. Go to Monitor system > Logging and select Manage Global Logging Settings.

2. On the view that appears, select Enable debug logging and click Save.

Manage syslog settings

To access the system logging settings, go to Monitor system > Logging and select Manage Global Syslog Settings.

From this view, you can enable logging to the syslog server, specify settings for message transfer and structured data, and add or remove logs to transmit.

Click Save to update the syslog settings.

Available logs for services

You can add or remove logs that will be sent to the syslog server.