Export Logs to Loggly
The Auth0 Logs to Loggly extension consists of a scheduled job that exports your Auth0 logs to Loggly, a log monitor and analysis service. This document will guide you through the process of setting up this integration.
To learn more, read Loggy Getting Started Guide on SolarWinds.
Retrieve required information from Loggly
First, you must get your subdomain and token from Loggly.
Get your Loggly subdomain
Your Loggly subdomain is the first part of your URL. For example, if your account's URL is https://mylogs.loggly.com
, then your Loggly subdomain is mylogs
.
Get your Loggly token
Log in to your Loggly account.
Using the top menu bar, navigate to Source Setup > Customer Tokens. Copy your Customer Token (or create a new one and copy it); you will need this value in the next section.
Configure the extension
To install and configure this extension:
Navigate to Auth0 Dashboard > Extensions, and select Auth0 Logs to Papertrail. The Install Extension window opens.
Set the following configuration parameters, and select Install:
Schedule: The frequency with which logs should be exported. The schedule can be customized even further after creation.
Auth0_Domain: The domain for your Auth0 application, which you can find in your Auth0 Application Settings.
Auth0_Global_Client_ID: The Global Client ID for your Auth0 application, which you can find in the Global Application Information section of your Tenant Advanced Settings.
Auth0_Global_Client_Secret: The Global Client Secret for your Auth0 application, which you can find in the Global Application Information section of your Tenant Advanced Settings.
Loggly_Customer_Token: Your Loggly token. Enter the token value you retrieved in the previous section.
Loggly_Subdomain: Your Loggly account name. Enter the subdomain value you retrieved in the previous section.
LOG_LEVEL: The minimal log level of events that you would like sent to Papertrail.
LOG_TYPES: The events for which logs should be exported.
The integration between Auth0 and Loggly is now in place!
Batch size
When setting your BATCH_SIZE, please keep the following information in mind.
During each time frame/window (defined by your chosen Schedule), outstanding logs will be batched into groups and sent. The size of each group is determined by the BATCH_SIZE value.
In other words, during each window, NUM_BATCHES
batches of logs will be sent based on the following logic:
IF (NUM_LOGS modulo 100 == 0):
NUM_BATCHES = (NUM_LOGS / BATCH_SIZE)
ELSE:
NUM_BATCHES = (NUM_LOGS / BATCH_SIZE) + 1
In the ELSE
case, the last batch will have < 100 logs.
View results
The integration you just set up created a scheduled job that is responsible for exporting the logs. To view this scheduled job:
Navigate to Auth0 Dashboard > Extensions, and select Installed Extensions.
Select Auth0 Logs to Loggly. The job you just created appears. You can modify its state by toggling the State switch, see when the next run is due, and see the result of the last execution.
You can view more details by clicking on the job you created. On this page, you can view details for each execution, reschedule the job, access realtime logs, and more.
That's it; you are done! You can now navigate to Loggly and view your Auth0 Logs.