Gleap logs your app's network requests and attaches the most recent ones to every ticket, so you can see what went wrong.
Setting up network logs
Network logs start automatically when you enable Network logs in the Developer options of your project in the Gleap dashboard. You can also start them from code:
Gleap.startNetworkRecording()[Gleap startNetworkRecording];Every request made with URLSession is logged, no matter which API or library sends it:
completion handler APIs (
dataTask(with:completionHandler:),uploadTask(with:from:completionHandler:), ...),Swift concurrency (
data(for:),upload(for:from:),bytes(for:)),delegate-based clients such as Alamofire, Moya, Apollo and AFNetworking.
No session configuration or plugin is needed.
Stop network logs
To stop network logs from code, call stopNetworkRecording(). It overrides the dashboard setting (also when the configuration is loaded again) until you call startNetworkRecording().
Gleap.stopNetworkRecording()[Gleap stopNetworkRecording];What is logged
For each request Gleap logs the method, URL, request headers and body, response status, headers and body, the duration and, for failed or cancelled requests, the error. The last 30 requests are attached to a ticket; requests that are still running show up as pending.
Text bodies (JSON, XML, text, form data, GraphQL) are kept up to 150 KB, longer ones are truncated.
Binary bodies (images, files) and streaming responses (
text/event-stream) are replaced by a marker, they are never buffered by the SDK.Swift concurrency hands the response data to your code directly, so requests sent with
data(for:)and similar are logged without the response body.
Gleap.startNetworkRecording(for: configuration) for Alamofire or AFNetworking; that method still works but is no longer needed. If you use the Gleap Moya plugin, you can remove it: requests are logged without it.Filtering network logs
Gleap allows you to strip off specific key/value pairs from network logs. This empowers you to easily remove sensitive data like tokens, passwords or usernames.
How does it work?
Open Settings → Developer → Developer options → Network logs and add keys under Ignored keys. Use Excluded domains for hosts whose requests should not be recorded. These settings load with the widget configuration and are applied on the device before a report is sent.
Headers: request and response headers with a matching name are removed (the name is matched case-insensitively).
JSON bodies: matching keys are removed from request and response bodies at any depth, including objects inside arrays. A key with dots, like
user.password, also removes exactly that path.Form bodies and URL parameters: matching
application/x-www-form-urlencodedfields and query parameters are removed.
Independent of this list, the values of the Authorization, Proxy-Authorization, Cookie and Set-Cookie headers are always replaced by [REDACTED].
Example
To remove an API key header and every password field, add x-api-key and password to the list.
Set filter with code
It's also possible to set the network log filters by code. Each call replaces the previous list. The keys set in the dashboard apply in addition.
Gleap.setNetworkLogPropsToIgnore(["x-api-key", "password", "user.email"])[Gleap setNetworkLogPropsToIgnore: @[@"x-api-key", @"password", @"user.email"]];Blacklisting URLs
It is possible to blacklist URLs or parts of URLs. If a network request matches one of the entries in the blacklist, the network request won't be included in the network logs.
gleap.io and gleap.ai, the domain of the US data region) are always excluded from the network logs, so you don't need to blacklist them yourself. The JavaScript SDK does this since v18.0.0, the iOS, Android, React Native, Flutter and Ionic Capacitor SDKs since v19.0.0.To add a new entry to the blacklist, open your project in the Gleap dashboard, go to Developer options and add the URLs under Network logs → Excluded domains.
Set blacklist with code
It's also possible to set the network log blacklist by code. Each call replaces the previous list. The domains set in the dashboard apply in addition.
Gleap.setNetworkLogsBlacklist(["analytics.example.com", "..."])[Gleap setNetworkLogsBlacklist: @[@"analytics.example.com", @"..."]];