Configure log forwarders
Access Gateway supports log forwarders such as Graylog.
Available since Access Gateway version 2020.04.4
During this task you will:
You must configure a Syslog server recipient to receive log events, including:
- A Syslog server, which can receive Syslog events is configured and available.
- Connection information for the remote logging consumer. For example:
Parameter Example Fully qualified IP Address or DNS resolvable name of logger 192.168.1.1
TCP or UDP
Logger listen port
Appropriate port such as 5514.
Note that the port being used to communicate between Access Gateway and the logging server must be open.
Access Gateway validates the logging server connection.
This example uses Graylog. It is purely instructional. For configuration of systems designed to receive the logging input, see their appropriate documentation.
To create a log forwarder in Graylog:
- Sign in to the Graylog console as admin.
- Select System > Inputs.
- In the Select Input drop down search for Syslog UDP.
- Click Launch new input.
- In the Launch New Syslog UDP Input dialog enter the following:
Leave all other fields unchanged.
An appropriate title.
Enter an appropriate port.
Reminder: This port must be accessible from the Access Gateway admin instance.
When configuring Syslog input receivers to avoid operating system restrictions, Okta recommends using port numbers of 2048 or higher.
- Click Save.
- Return to the Access Gateway Admin UI console
To add a remote logger:
- Navigate to your Access Gateway instance.
- Select the Logs and Backups tab.
- Select the Log Forwarder pane .
- Select (+) > Syslog remote.
- In the Add Forwarder: Syslog pane enter the following.
The name of the forwarder.
See Feed examples for details of each feed.
Select either UDP or TCP. Ensure this protocol matches the log listener.
Enter the DNS resolvable or IP address of the remote Syslog listener.
Enter the port of the remote Syslog listener.
- Click Validate Forwarder.
Access Gateway then attempts to validate the remote logger connection information.
If required, correct any input errors. On successful validation, the Validate Forwarder button changes to Forwarder Validated.
- Click Okay.
- The log forwarder definition appears in the list of log forwarders.
The Syslog definition is briefly be shown as testing and then changes to valid on success.
To test log forwarding you must have:
- A configured log receiver. Follow the steps outlined in the Define a log forwarder receiver section
- A log forwarder defined in your Access Gateway node. Access loggers are the simplest to test, as they generate events based on sign in to the Access Gateway Admin UI console
- Be able to generate one or more events.
To test log forwarders:
- Configure a system logger in your log server.
- Configure a log forwarder in Access Gateway, preferably an access logger.
- Ensure your system logger is started and ready to receive events
- Sign out and then back into the Access Gateway Admin Console.
- Examine the log server. Multiple events should be generated resembling:
See: About Access Gateway logsfor examples of log file formats.
|AUDIT||Audit log events include log entries representing user authentication.
See Access Gateway audit log for details and examples of audit events.
2020-06-24T10:05:56.000-05:00 example.myaccessgateway.com ACCESS_GATEWAY WEB_CONSOLE - - INFO SYSTEM_STARTUP  Startup complete, system ready.
2020-06-24T04:00:01.000-05:00 example.myaccessgateway.com ACCESS_GATEWAY WEB_CONSOLE IDP LOCAL INFO SYSTEM_IDP_STATUS [NAME="MyIDP" DOMAIN="someorg.oktapreview.com" TYPE="IDP_OKTA" RESULT="PASS" REASON="VALID"] Success confirming IDP status with: someorg.oktapreview.com.
|ACCESS||Access log events includes log entries representing user authorization and application accesses. For example, a particular user accessed a particular application from a given IP address. See Access Gateway Access log for details and examples of access events.
2020-06-24T09:41:08.000-05:00 example.myaccessgateway.com auth header.myexample.com 10.0.0.110 - - "GET /assets/images/image.png HTTP/2.0" 200 1229 "https://gw-admin.example.com/" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/80.0.3987.149 Safari/537.36" "-" 0.029 0.028 .
|MONITOR||Monitor log events include log entries representing application configuration (add, delete, modify), Certificate configuration and Auth Module Configuration.
For details and examples of audit events see Access Gateway monitor log
2020-06-25T07:00:02.119-05:00 example.myaccessgateway.com OAG_MONITOR MONITOR DISK_USAGE INFO DISK_USAGE [FILESYSTEM="/dev/mapper/centos-root" MOUNT="/" USAGE="12%"] Mount / is 12% full