Document toolboxDocument toolbox

Viewing Service Logs

The GENERAL INFORMATION > LOGS page displays the audit logs of events for the chosen service. You can also click the drop-down menu to view service logs.

Logs

The Audit or Service Logs page shows the following information for each event:

  • Timestamp: the UTC timestamp of the task performed by the user

  • User: the name of the user account from which the task was performed

  • Source IP: the IP address of the source that initiated the task

  • Resource Type: the resource with which the performed task was associated
    For example, if a user performed a specific task on a NIOS-X server, this field would display the server’s name.

  • Action: the action performed by a user
    For example, this field would display Update if a user updated the server’s configuration or Delete if a user deleted tags on a server.

  • Event Summary: information about the action taken for the event
    Click View Metadata to view the following additional information for a specific event:

    • Session Type: the type of authentication used for the event’s session
      For example, this can be bearer (which is session-based) or token (which is token-based).

    • Subject Role: the role of the subject who generated this event

    • Session ID: the audit session ID associated with this login session

    • App Identifier: the application source associated with the audit session

    • Full Request URI: the full URI of the API request sent for this event

    • API Request ID: the API request ID of the audit event

    • Resource ID: the ID of the resource type

    • HTTP Verb: the operation performed on the event
      The most commonly used operations are POST, GET, PUT, PATCH, and DELETE.

    • HTTP Response Code: the HTTP status code that indicates whether the HTTP request associated with this event has been completed successfully
      For example, 200 indicates the request completed successfully.

You can also do the following:

  • Click the Sort by menu, choose the column by which you want to sort the events, and then use the up and down arrows to sort the events in ascending or descending order.

  • In the text box Search, enter the value you want to search on.

  • Click Display Recent to see the most recent 100 events.

  • Click

A filter icon

to activate the filtering feature, and then click

to configure your filter.

From the Basic Columns menu, choose a filter you want to add. For example, if you choose Timestamp, then use the calendar feature to select a timeline for which you want to filter the results.

If necessary, perform one or more of the following functions:

To add another filter, click

  • A plus icon

    again. When you are done, click

    A play icon

    .

  • To remove a filter, click

    .

    1. To save a filter for future use, click

      and enter the filter’s name.

    2. To find the saved filter, click

Downloading Logs

To download a CSV audit log or service log, click Download. For audit logs, the downloaded file will be formatted as audit-log-the timestamp in UTC format.csv (example: audit-log-10-10-2022, 10-30-59 PM UTC.csv). For service logs, the downloaded file will be formatted as service-log-the timestamp in UTC format.csv (example: service-log-10-10-2022, 10-30-59 PM UTC.csv).