To allow our SDK to monitor your network requests, you'll need to follow these steps.
By default, Instabug captures the payload size of the request and response; this should help with determining if the payload size could be causing any issues with network delays. The payload size is the size of the payload itself, so it does not include the header's size.
Instabug automatically buckets payload sizes into different buckets based on the distribution of the data per network group, with a minimum sensitivity of 10 bytes per bucket.
URL patterns are used to group the relevant network call occurrences and aggregate their numbers. Let's take the following examples:
It looks like 1 and 2 are the same request, but asking for different resources. While 3 is an entirely different one. Those three examples result in the following 2 URL patterns:
- Plain text: works with exact string matching
*: matches with any URL part.
*matches with only one part at a time. For example if you are mapping
sample.com/part/variable1/variable2, your pattern should be
Instabug automatically detects numbers and hexadecimal tokens in your URLs and replaces them with
If you are using more complex URLs where variable parts may contain plain text and not only numbers and hexadecimal, we recommend defining your custom patterns. Just click on the "Create URL pattern" button in your network list.
Here are a few examples:
|URL pattern example||Matches with||Doesn't match with|
Some notes to consider while creating your URL patterns:
- Custom URL patterns that you define have higher precedence than the auto-generated ones. If the same call matches with a custom and an auto pattern, it gets grouped with the custom.
- At any point, you can delete a pattern to prevent grouping new calls with it.
- URL patterns shouldn't overlap. Each incoming network call gets grouped with only one pattern. In case of conflict, it gets merged with the newest pattern.
Creating or deleting patterns doesn’t affect your old data that has already been grouped. It only affects the upcoming network requests.
Instabug calculates an Apdex score for every network request (URL pattern) in your app. Apdex score ranges between 0 and 1. The higher the value, the closer you are to satisfying user experience:
- Apdex score ≥ 0.94 equates to Excellent performance.
- Apdex score ≥ 0.85 and < 0.94 equates to Good performance.
- Apdex score ≥ 0.7 and < 0.85 equates to Fair performance.
- Apdex score ≥ 0.5 and < 0.7 equates to Poor performance.
- Apdex score < 0.5 is considered Unacceptable.
When a network call occurrence is collected, it is flagged based on a pre-defined target (T). A network call occurrence is considered:
- Satisfying: if its duration ≤ T
- Tolerable: if its duration < T and ≤ 4T
- Frustrating: if its duration > 4T or if it fails due to a server-side or client-side error.
Then based on the bucketing explained above, the Apdex is calculated:
Total occurrences = Satisfying occurrences + Tolerable occurrences + Frustrating occurrences
Apdex score = (Satisfying occurrences + 0.5 * Tolerable occurrences) / Total occurrences
By default, it is set to 2 seconds. However, you can easily change this number from your dashboard by clicking on the action highlighted in the screenshots below.
Please note that updating your response time target does not affect the already stored occurrences, only future occurrences will be flagged using the new target.
Updated over 1 year ago