Skip to content

Commit 5f0260d

Browse files
authored
docs(performance): clarify that Dart network requests are not collected automatically (#18786)
1 parent 88d7bc6 commit 5f0260d

2 files changed

Lines changed: 18 additions & 3 deletions

File tree

‎docs/perf-mon/_custom-network-traces.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,11 @@ your app.
77

88
The
99
[network request traces automatically collected by Performance Monitoring](/docs/perf-mon/network-traces)
10-
include most network requests for your app. However, some requests might not be
11-
reported or you might use a different library to make network requests. In these
12-
cases, you can use the Performance Monitoring API to manually instrument
10+
on Android and Apple platforms only include requests made by native code, such
11+
as native SDKs that your app depends on. Requests made from Dart, including
12+
requests made with `dart:io` `HttpClient`, `package:http` with its default
13+
client, or `Image.network`, are not collected automatically. To monitor these
14+
requests, use the Performance Monitoring API to manually instrument
1315
**_custom network request traces_**. Custom network request traces are only
1416
supported for Apple and Android apps.
1517

‎docs/perf-mon/get-started.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,13 @@ for individual Flutter screens. A single view controller encapsulates your
5656
entire Flutter application natively so the underlying native Firebase SDK is
5757
not aware of screen transitions.
5858
59+
On Android and Apple platforms, automatic network request monitoring only covers
60+
requests made by native code, such as native SDKs that your app depends on.
61+
Requests made from Dart, including requests made with `dart:io` `HttpClient`,
62+
`package:http` with its default client, or `Image.network`, are not collected
63+
automatically. To monitor these requests, add
64+
[custom network request traces](/docs/perf-mon/custom-network-traces?platform=flutter).
65+
5966
Note: When you add Performance Monitoring to your app, the Remote Config SDK is
6067
included as a dependency. If you already use Remote Config, you won't see
6168
any difference. However, if you're new to Remote Config, explore the
@@ -104,6 +111,9 @@ information from your app.
104111
* <code>Logging trace metric: <var>TRACE_NAME</var>, <var>FIREBASE_PERFORMANCE_CONSOLE_URL</var></code>
105112
* <code>Logging network request trace: <var>URL</var></code>
106113
114+
Network request trace logs appear for requests made from Dart only if you
115+
have added custom network request traces for them.
116+
107117
1. Click on the URL to view your data in the Firebase console. It may take a few
108118
moments for the data to update in the dashboard.
109119
@@ -142,6 +152,9 @@ of the Firebase console.
142152
* Data for [HTTP/S network requests](/docs/perf-mon/network-traces) issued
143153
by your app
144154
155+
* On Android and Apple platforms, monitor network requests made from Dart by
156+
[instrumenting custom network request traces](/docs/perf-mon/custom-network-traces?platform=flutter).
157+
145158
* [View, track, and filter](/docs/perf-mon/console) your
146159
performance data in the Firebase console.
147160

0 commit comments

Comments
 (0)