Local Mode

Running the tool locally (mode: local)


Use mode: local when you have kubectl access to production yourself. Collection runs on your own machine, using your own credentials.

Step 1: Download the router-diagnostics collect script

Download the script onto the machine you collect from.

macOS / Linux

Bash
1curl -sSLo collect.sh https://router.apollo.dev/router-diagnostics-collect/latest
2chmod +x collect.sh

Windows

Run the following in PowerShell:

powershell
1Invoke-WebRequest -Uri https://router.apollo.dev/router-diagnostics-collect-ps1/latest -OutFile collect.ps1

This gives you a single collect.sh / collect.ps1 command, which caches a pinned version of the troubleshoot support-bundle binary locally, keyed by version, before running collection. For more information, see support-bundle documentation.

Step 2: Install the Helm chart

If you deployed your router with the official Apollo Helm chart:

Bash
1helm install router-diagnostics oci://registry-1.docker.io/apollograph/router-diagnostics-chart \
2  --namespace production \
3  --set namespace=production \
4  --set mode=local

namespace is the only value you need to supply, the chart's collectors target your router by its standard app.kubernetes.io/name=router label.

If you're on a raw-manifest or custom deployment:

Bash
1helm install router-diagnostics oci://registry-1.docker.io/apollograph/router-diagnostics-chart \
2  --namespace production \
3  --set namespace=production \
4  --set selector="app=my-router" \
5  --set configMapName=my-config \
6  --set mode=local

Because none of the official chart's conventions apply to your deployment, supply your pod selector and ConfigMap name in addition to the namespace so the chart's collectors know where to find your router and its configuration. Optionally, supply metricsPort if your metrics aren't exposed via the default 9090.

Step 3: Collect a support bundle

macOS / Linux

Bash
1./collect.sh --namespace production

Windows

powershell
1.\collect.ps1 -Namespace production

This is the same command regardless of your deployment tier. collect.sh / collect.ps1 accepts only --namespace / -Namespace.

--namespace (Unix) / -Namespace (Windows) here must match the value you gave both helm install --namespace and --set namespace= in Step 2. The script uses that value to find the spec ConfigMap that the chart rendered there. For an explanation, go to local-mode-details.

Run it again any time you want another bundle.

Terminal output during collect.sh

Note: collect.sh prints a JSON summary like {"analyzerResults": [], "archivePath": "support-bundle-<timestamp>.tar.gz"} when it finishes. An empty analyzerResults array is expected be because this tool ships no analyzers.

The bundle lands in your current directory as support-bundle-<timestamp>.tar.gz. Inspect it, keep it, or attach it to a support ticket.

Cleaning up

Installing the chart leaves the spec ConfigMap plus Helm release metadata. If you'd rather leave nothing behind:

Bash
1helm uninstall router-diagnostics --namespace production

To collect more than once, leave the chart installed so subsequent runs use only the script. Run ./collect.sh --namespace production (macOS/Linux) or .\collect.ps1 -Namespace production (Windows).