> ## Documentation Index
> Fetch the complete documentation index at: https://docs.iroh.computer/llms.txt
> Use this file to discover all available pages before exploring further.
# Diagnose a connectivity issue
> Diagnose user connectivity issues with remote diagnostic reporting
Net Diagnostics lets you run network connectivity reports on your endpoints.
Reports cover NAT type, UDP connectivity, relay latency, port
mapping protocol availability, and direct addresses. Everything you need to
debug connection issues.
You can initiate reports from iroh-services, which will reach out to configured
remote nodes that have authorized diagnostics, gather
details about the endpoint's connectivity context, and forward the report to
your project on iroh services to assess how to help your user get the best
connection they can.
### 1. Get your API key
Create one from your project's **Settings → API Keys** tab. See [API Keys](/iroh-services/access) for the full walkthrough. Then export it as an environment variable:
```bash theme={null}
export IROH_SERVICES_API_SECRET=
```
### 2. Run the diagnostics client
Clone the repository and run the `net_diagnostics` example:
```bash theme={null}
git clone https://github.com/n0-computer/iroh-services.git
cd iroh-services
cargo run --example net_diagnostics
```
Leave this terminal open. The example connects to iroh services, grants the diagnostics capability to your project, and waits for incoming diagnostics requests.
### 3. Run a diagnostic from the dashboard
Go to your project's **Endpoints** page. You should see the example client listed as an online endpoint. Click **Run Diagnostics** to generate a report.
The report appears on the **Net Diagnostics** page and includes:
* **NAT Type**: No NAT, Endpoint-Independent, Endpoint-Dependent, or Unknown
* **UDP Connectivity**: IPv4 and IPv6 status with public addresses
* **NAT Mapping**: whether mapping varies by destination (symmetric NAT detection)
* **Direct Addresses**: local addresses the endpoint is listening on
* **Port Mapping**: UPnP, PCP, and NAT-PMP availability
* **Relay Latencies**: per-relay IPv4, IPv6, and HTTPS round-trip times
* **Captive Portal**: detection of captive portal interference
## Integrate Net Diagnostics into your app
The example above uses a ready-made client. To get on-demand reports from your users' endpoints, wire the same integration into your own iroh app:
1. Add `iroh-services` to your `Cargo.toml`
2. Build an `iroh_services::Client` and grant the `NetDiagnosticsCap::GetAny` capability to your project
3. Run a `ClientHost` so the platform can dial back into the endpoint when you click **Run Diagnostics**
Complete walkthrough with Cargo config, a minimal Rust integration, and a reference for reading reports (NAT type, connectivity summary).
## Next steps
Configure dedicated relays for your endpoints and learn why they matter for production.
Watch direct data rate and other connectivity metrics over time so you can see whether your fixes are working.
Broader debug toolkit covering logging and the iroh-doctor CLI for local diagnostics.