Insights
Insights report
Export Cloak Proxy's traffic analysis as a Markdown report with endpoints, masked secrets, security grades, performance findings and schema changes.
The Insights report is a Markdown summary of everything the analysis found: the busiest endpoints with their latency, possible secrets (masked), each host’s security grade, performance problems and schema changes. Paste it into a pull request, a bug ticket or a CI log so other people can see the results without opening Cloak Proxy.
Export a report from the app
Section titled “Export a report from the app”- Open Insights with ⌥ ⌘ I.
- Pick the scope at the top right: All traffic, or Current filter for only what the main window shows.
- Wait for the analysis to finish. Export Report stays disabled until the first analysis is ready.
- Click Export Report.
- Choose where to save it. The suggested name is
Cloak Proxy Report.md. - Click Save.
The report covers the same requests as the window: all traffic or the current filter.
- Scope of the report
- Export Report
If the file can’t be written, Cloak Proxy shows Couldn’t save the report: followed by the reason.
What’s in the report
Section titled “What’s in the report”The report starts with a title and a one-line summary, then has a section for each kind of finding. Sections with nothing to report are left out.
| Section | Contents | Limit |
|---|---|---|
| Title | # Cloak Proxy report |
|
| Summary | Requests, endpoints, errors, possible secrets and schema changes, on one line. | |
| Endpoints | A table of endpoints with Calls, Errors, p50 and p95, busiest first. | 50 endpoints |
| Possible secrets | One line per finding: severity, kind, location, header or parameter name, host, request number and masked value. | 100 findings |
| Security headers | A table of every host with its Grade and its Issues, worst grade first. A host with no issues shows None. |
All hosts |
| Performance | One line per finding: kind, endpoint or host, and detail. | 50 findings |
| Schema changes | One line per change: endpoint, request number, kind, field and detail. | 100 changes |
The timeline and alert history aren’t included.
Example
Section titled “Example”# Cloak Proxy report
38 requests · 16 endpoints · 2 errors · 2 possible secrets · 3 schema changes
## Endpoints
| Endpoint | Calls | Errors | p50 | p95 ||---|---:|---:|---:|---:|| `GET api.example.com/v1/reviews/{id}` | 14 | 0 | 90 ms | 90 ms || `GET api.example.com/v1/me` | 4 | 0 | 120 ms | 120 ms || `POST api.example.com/v1/pay` | 1 | 1 | 810 ms | 810 ms |
## Possible secrets
- **High** Stripe secret key in url on api.example.com (#16): `sk_l…Pq (25 chars)`- **High** AWS access key in response body on api.example.com (#16): `AKIA…LE (20 chars)`
## Security headers
| Host | Grade | Issues ||---|:---:|---|| shop.example.com | F | Cookie without Secure (PHPSESSID); Missing Content-Security-Policy; Missing Strict-Transport-Security || realtime.example.com | A | Missing X-Content-Type-Options |
## Performance
- **Slow** GET api.example.com/v1/search: 1× over 1.0 s, average 3.4 s, worst 3.4 s- **Burst** GET api.example.com/v1/reviews/{id}: 14 calls within 2.0 s, one per item. A batch endpoint would need one.
## Schema changes
- `GET api.example.com/v1/products/{id}` #19: Removed `price` (was Number)- `GET api.example.com/v1/products/{id}` #19: Type changed `id` (Number → String)Times are in milliseconds. A – in a latency column means none of the endpoint’s requests got a response.
Write a report from the command line
Section titled “Write a report from the command line”cloakctl run wraps a command (usually your test suite) with the proxy, records its traffic, and writes the same report when it finishes:
cloakctl run --ssl '*' --record run.har --redact --report report.md -- npm test| Flag | What it does |
|---|---|
--report FILE |
Write the Markdown report to FILE. |
--record FILE |
Save the traffic as HAR (.har) or a Cloak Proxy session (.cloaksession). |
--redact |
Redact the recording. The report always shows secrets masked. |
--fail-on-5xx |
Exit 1 if any response was a server error. |
--fail-on-error |
Exit 1 on any 4xx, 5xx or failed request. |
--fail-on-secrets |
Exit 1 if any High-severity secret was found. |
--fail-on-schema-change |
Exit 1 if an endpoint’s JSON shape changed during the run. |
When the run ends, cloakctl prints Report written to report.md and a summary line with the same counts as the report. See Headless and CI and cloakctl for every flag.
Get the report over MCP
Section titled “Get the report over MCP”The MCP server’s insights tool returns the same Markdown when you set section to markdown, so an AI assistant connected to Cloak Proxy can read or summarize it. See MCP server.