feat(js): Add reportPageLoaded() documentation (#15006)

Author: Lms24

docs/platforms/javascript/common/apis.mdx

@@ -712,6 +712,39 @@ See <PlatformLink to="/tracing/instrumentation/">Tracing Instrumentation</Platfo
   `browserTracingIntegration` has not been enabled.
 </SdkApi>
 
+<SdkApi
+  name="reportPageLoaded"
+  signature="function reportPageLoaded(): void"
+  categorySupported={["browser"]}
+  availableSince="10.13.0"
+>
+
+  Signals to the Sentry SDK that the initial page was fully loaded.
+  Requires the <PlatformLink to="/tracing/instrumentation/automatic-instrumentation/#enableReportPageLoaded">`enableReportPageLoaded` option</PlatformLink> in `browserTracingIntegration` to
+  be set to `true`. Once called, the SDK ends the pageload span automatically,
+
+  By default, the SDK takes care of ending the pageload span automatically, based on
+  a period of inactivity where no new child spans are added to the pageload trace.
+  You can alternatively use explicit pageload reporting if the inactivity heuristics of
+  `browserTracingIntegration` don't work well for your use case.
+  However, you must ensure that you call `reportPageLoaded` in every situation.
+  If `reportPageLoaded` is not called, the pageload span will be ended after 30 seconds
+  or whatever custom value is set on the <PlatformLink to="/tracing/instrumentation/automatic-instrumentation/#enableReportPageLoaded">`finalTimeout` option</PlatformLink>.
+
+
+  <Expandable title="Examples">
+  ```javascript
+  Sentry.init({
+    // 1. Enable manual page load reporting:
+    integrations: [browserTracingIntegration({ enableReportPageLoaded: true })]
+  })
+
+  // 2. Whenever you consider the page loaded:
+  Sentry.reportPageLoaded();
+  ```
+  </Expandable>
+</SdkApi>
+
 ## Tracing Utilities
 
 These utilities can be used for more advanced tracing use cases.

docs/platforms/javascript/common/tracing/instrumentation/automatic-instrumentation.mdx

@@ -131,6 +131,13 @@ This flag enables or disables creation of `pageload` span on first pageload.
 
 </SdkOption>
 
+
+<SdkOption name="enableReportPageLoaded" type='boolean' defaultValue='false' availableSince='10.13.0'>
+
+This option determines whether the <PlatformLink to="/apis/#reportPageLoaded">`Sentry.reportPageLoaded()` function</PlatformLink> is enabled.
+
+</SdkOption>
+
 <SdkOption name="markBackgroundSpans" type='boolean' defaultValue='true'>
 
 This option flags pageload/navigation spans when tabs are moved to the background with "cancelled". Because browser background tab timing is not suited for precise measurements of operations and can affect your statistics in nondeterministic ways, we recommend that this option be enabled.

src/components/sdkApi.tsx

@@ -26,6 +26,7 @@ type Props = {
   name: string;
   parameters: ParameterDef[];
   signature: string;
+  availableSince?: string;
   categorySupported?: PlatformCategory[];
   children?: React.ReactNode;
   language?: string;
@@ -35,6 +36,7 @@ export function SdkApi({
   name,
   children,
   signature,
+  availableSince,
   parameters = [],
   language,
   categorySupported = [],
@@ -51,9 +53,12 @@ export function SdkApi({
       {showServerLikeOnly && (
         <div className="italic text-sm">Only available on Server</div>
       )}
-
       <pre className="mt-2 mb-2 text-sm">{codeToJsx(signature, lang)}</pre>
-
+      {availableSince && (
+        <p className="italic">
+          Available Since: <code>{availableSince}</code>
+        </p>
+      )}
       {parameters.length ? (
         <Expandable title="Parameters">
           <div className="space-y-3">
@@ -63,7 +68,6 @@ export function SdkApi({
           </div>
         </Expandable>
       ) : null}
-
       {children}
     </SdkDefinition>
   );