Migrate from Log Extensions
The following Auth0 Log Extensions are now deprecated and will be supported until the end of life (EOL) dates listed below. It is no longer possible to create new extensions from this list of deprecated Log Extensions. You can set up equivalent functionality using log event streams or integrations on the Auth0 Marketplace
The following will reach EOL in Private Cloud on January 6, 2023:
Auth0 Authentication API Webhooks
Auth0 Management API Webhooks
Logs to Cloudwatch
Logs to Logentries
Logs to Loggly
Logs to Logstash
Logs to Papertrail
Logs to Splunk
Logs to Sumo Logic
Reach EOL in Public Cloud on May 2, 2023:
Auth0 Authentication API Webhooks
Auth0 Management API Webhooks
Logs to Cloudwatch
Logs to Logentries
Logs to Loggly
Logs to Logstash
Logs to Papertrail
Logs to Splunk
Logs to Sumo Logic
Logs to Segment
Logs to Mixpanel
Logs to AppInsights
Logs to Azure Blob Storage
As of the EOL dates listed, Auth0 will no longer support the installed log extensions from the list above. On this page, you'll find instructions for migrating from specific log extensions.
Auth0 Authentication API Webhooks
Make sure your destination can handle an array of log objects.
Go to Extensions and select your Auth0 Authentication API webhook in the Installed Extensions tab.
Copy the Webhook URL and Authorization Header (if you have one).
Next, go to Monitoring > Streams > New Event Stream.
Select Custom Webhook, enter a name, and click Create.
Configure your webhook.
For the Payload URL, enter the webhook URL you copied from the extension.
If you have one, set the Authorization Token to the Authorization Header you copied from the extension.
Set Content Format to JSON Array.
Click Save.
Go back to Extensions > Installed Extensions and disable your Auth0 Authentication API webhooks extension.
Auth0 Management API Webhooks
Make sure your destination can handle an array of log objects.
Go to Extensions and select your Auth0 Management API webhook in the Installed Extensions tab.
Copy the Webhook URL and Authorization Header (if you have one).
Go to Monitoring > Streams > New Event Stream.
Select Custom Webhook, enter a name, and click Create.
Configure your webhook.
For the Payload URL, enter the webhook URL you copied from the extension.
If you have one, set the Authorization Token to the Authorization Header you copied from the extension.
Set Content Format to JSON Array.
Click Save.
Go back to Extensions > Installed Extensions and disable your Auth0 Management API webhooks extension.
CloudWatch
Set up the Amazon EventBridge Integration available on the Auth0 Marketplace. Once the events are available on your event bus, create rules to map those events to AWS CloudWatch. Make sure you disable your Auth0 Logs to CloudWatch extension:
Go to Extensions > Installed Extensions.
Disable the Auth0 Logs to CloudWatch extension.
Loggly
Open the Logs menu and select Source Setup.
Go to the Customer Tokens tab.
Copy your token.
Go to Monitoring > Streams > New Event Stream.
Select Custom Webhook, enter a name and click Create.
Configure your webhook.
For the Payload URL, replace
LOGGLY_TOKEN
with the token you copied from your Loggly account:https://logs-01.loggly.com/bulk/{LOGGLY_TOKEN}/tag/auth0-{TENANT_NAME}/
.Leave Authorization Token blank.
Set the Content Type to
application/json
.Set Content Format to JSON Lines.
Click Save.
Go to Extensions > Installed Extensions and disable your Auth0 Logs to Loggly extension.
Logstash
Go to Monitoring > Streams > New Event Stream.
Select Custom Webhook, enter a name, and click Create.
Configure your webhook.
For the Payload URL, enter the URL of your Logstash server.
Set the Authorization Token to
Basic <CREDENTIALS>
, replacingCREDENTIALS
with the Base64 encoding of your Logstash user and password separated by a colon (<USER:PASSWORD>
). You can find your Logstash HTTP credentials in your Logstash configuration file.
Click Save.
Go to Extensions > Installed Extensions and disable your Auth0 Logs to Logstash extension.
Papertrail
Login to Papertrail.
Go to Log Destinations then click Create Log Destination.
Provide a description and configure the destination settings.
In the Accept Connections via ... pane, select Token.
Click Create.
Go to Monitoring > Streams > New Event Stream.
Select Custom Webhook, enter a name, and click Create.
Configure your webhook.
Set the Payload URL to
https://logs.collector.solarwinds.com/v1/logs
.Set the Authorization Token to
Basic <CREDENTIALS>
, replacingCREDENTIALS
with the Base64 encoding of the Papertrail token you got from Papertrail's destination settings.Set Content Format to JSON Lines.
Click Save.
Go to Extensions > Installed Extensions and disable your Auth0 Logs to Papertrail extension.
Splunk
Use the Splunk Integration available on the Auth0 Marketplace. Make sure you disable your Auth0 Logs to Splunk extension:
Go to Extensions > Installed Extensions.
Disable the Auth0 Logs to Splunk extension.
Sumo Logic
Use the Sumo Logic Integration available on the Auth0 Marketplace. Make sure you disable your Auth0 Logs to Sumo Logic extension:
Go to Extensions > Installed Extensions.
Disable the Auth0 Logs to Sumo Logic extension.
Logentries
Currently, there are no instructions for migrating from the Logs to Logentries extension to log streams.
Segment
Login to your Auth0 dashboard
Within Extensions > Installed Extensions, find your Segment extension.
Take note of your Write Key, as you’ll need it for your new log stream to Segment.
Disable your Segment extension.
Take note of the UTC timestamp of the last log you have received in Segment. Knowing that timestamp will allow you to create your new stream while avoiding duplicate logs in Segment.
Go to Monitoring > Log Streams, and create a new Segment log stream. Enter your Write Key in the appropriate field and the timestamp you noted in the Start From section.
Create the stream
Mixpanel
Login to your Mixpanel account, open your Project Settings. Take note of your Project ID and Data Residency (the region).
Mixpanel no longer recommends using your project token for importing events and recommends using the service account mechanism. Within the Project Settings page, select Service Accounts, and create a new service account with admin or owner permissions. Take note of the credentials.
Log in to your Auth0 dashboard.
In Monitoring > Log Streams, create a new Mixpanel stream. Enter the project id, region, service account credentials and create the stream.
Don’t forget to deactivate your old extension. Go to Extensions > Installed Extensions and disable the Auth0 Logs to Mixpanel extension.
AppInsights
Set up an Azure EventGrid Log Stream or leverage your existing EventGrid stream.
Follow the instructions posted by Azure to set a destination for the log events.
Logs may be transformed differently through Log Streaming. Please reference the deprecated Log Extenstion code for further details
Notable transformations done to the logs include:
The appInsight client is overwritten:
Sets a custom time equivalent to the log time
OS and OS version to be equivalent to the log information
Device type tag to hold information on whether the log originated from a mobile source
IP address tag be equivalent to the log information
user id, account id, user agent and auth user id tags to be equivalent to the logs
The record is cleaned up to delete the following properties if empty:
ip
user_id
user_name
connection
client_name
description
The record isMobile property is altered to contain either a yes or no string
The record details property is altered to be a string
The record details property is truncated to 8185 characters
Azure Blob Storage
Set up an Azure EventGrid Log Stream or leverage your existing EventGrid stream.
Follow the instructions posted by Azure to set a destination for the log events.
Logs may be transformed differently through Log Streaming. Please reference the deprecated Log Extenstion code for further details
Notable transformations done to the logs include:
The record
type_code
andtype
is adjusted.Type
is the human-readable description of thetype_code
Record
os
,os_version
,device
anddevice_version
is adjusted if the record containsuser_agent
information