Diagnose

Overview

The ngrok diagnose command runs a series of tests to diagnose potential connectivity issues between the ngrok agent and the remote ngrok service. See available flags here.

Diagnostics

The diagnose command gathers your environment information, including your sanitized configuration file. It then tests:

• proxy connectivity, if proxy_url is configured
• name resolution
• general internet connectivity

By default, ngrok diagnose tests IPv4 connectivity between the ngrok agent and the closest ngrok point of presence. To test IPv6 connectivity, add --ipv6 true to the command. To test connectivity between the ngrok agent and all ngrok points of presence, add --region all.

Basic Output

The diagnose command prints a connectivity summary in your terminal. If you have full connectivity, your report will look like this:

Loading…

If there's a connectivity problem, your report will show warnings and errors that need to resolved before ngrok can work correctly:

Loading…

Verbose Output

For more detailed output, you can use the --write-report/-w flag to generate a verbose report:

Loading…

By default, ngrok diagnose --region all will generate a report. The diagnose output will print the report location:

Loading…

Kubernetes

You can run ngrok diagnose within your Kubernetes cluster to troubleshoot network connectivity issues. See Testing in a Kubernetes Cluster.