Debug Rules

We expose IPv6 addresses in our public endpoints (e.g., travel0.us.auth0.com). If a request arrives from a machine that supports IPv6, then the context.request.ip property will contain an IPv6 address. If you perform manual IP address manipulation, we suggest you use the ipaddr.js@1.9.0 library.

To debug any Rule you have created in Auth0, you can use console.log from within your rule code. You can see console.log output by using the Try this Rule feature, viewing the logs available with the Real-time Webtask Logs extension, or for legacy clients, using the Debug Rule CLI.

In the Rules Editor, the TRY THIS RULE button lets you run a Rule in isolation with mock user and context objects. Clicking TRY will run the Rule with those two objects as input and will display any console.log output.

Dashboard - Auth Pipeline - Rules - Edit Rule

The TRY THIS RULE feature functions outside a specific client context. When using this feature, you may run into issues if your Rule depends on data that would be provided when called from an actual application.

The Real-time Webtask Logs extension displays all logs in real-time for all custom code in your account, which includes all console.log output and exceptions.

Only tenants created prior to 17 July 2018 have access to Webtask.io and the Webtask CLI. If you are an enterprise customer with a newer tenant, please contact your account representative to request access. Other requests can be made through the Auth0 Contact Form and will be evaluated on a case-by-case basis.

In the Rules Editor, the DEBUG RULE button displays instructions for installing, configuring, and running the webtask CLI for debugging Rules. Paste these commands into a terminal to see the console.log output and any unhandled exceptions that occur during Rule execution.

For example:

  ~  npm install -g wt-cli
  ~  wt init --container "youraccount" --url "https://sandbox.it.auth0.com" --token "eyJhbGci...WMPGI" -p "youraccount-default-logs"
  ~  wt logs -p "youraccount-default-logs"
  [18:45:38.179Z]  INFO wt: connected to streaming logs (container=youraccount)
  [18:47:37.954Z]  INFO wt: webtask container assigned
  [18:47:38.167Z]  INFO wt: ---- checking email_verified for some-user@mail.com! ----

Was this helpful?/

This debugging method works for Rules tried from the Dashboard and for those actually running during user authentication.

Docs

Debug Rules

Debug Rules

Try this Rule

Real-time logs extension

Debug Rule CLI

Was this article helpful?