change variable name s/url/urlPath, update JSDoc

Author: Lms24

dev-packages/node-integration-tests/suites/tracing/httpIntegration/server-ignoreIncomingRequests.js

@@ -10,6 +10,7 @@ Sentry.init({
   integrations: [
     Sentry.httpIntegration({
       ignoreIncomingRequests: url => {
+        console.log('url', url);
         return url.includes('/liveness');
       },
     }),

packages/node/src/integrations/http.ts

@@ -34,14 +34,20 @@ interface HttpOptions {
   /**
    * Do not capture spans or breadcrumbs for outgoing HTTP requests to URLs where the given callback returns `true`.
    * This controls both span & breadcrumb creation - spans will be non recording if tracing is disabled.
+   *
+   * The `url` param contains the entire URL, including query string (if any), protocol, host, etc. of the outgoing request.
+   * For example: `'https://someService.com/users/details?id=123'`
    */
   ignoreOutgoingRequests?: (url: string) => boolean;
 
   /**
    * Do not capture spans or breadcrumbs for incoming HTTP requests to URLs where the given callback returns `true`.
    * This controls both span & breadcrumb creation - spans will be non recording if tracing is disabled.
+   *
+   * The `url` param consists of the URL path and query string (if any) of the incoming request.
+   * For example: `'/users/details?id=123'`
    */
-  ignoreIncomingRequests?: (url: string) => boolean;
+  ignoreIncomingRequests?: (urlPath: string) => boolean;
 
   /**
    * Additional instrumentation options that are passed to the underlying HttpInstrumentation.
@@ -103,7 +109,9 @@ export const instrumentHttp = Object.assign(
       },
 
       ignoreIncomingRequestHook: request => {
-        const url = request.url;
+        // request.url is the only property that holds any information about the url
+        // it only consists of the URL path and query string (if any)
+        const urlPath = request.url;
 
         const method = request.method?.toUpperCase();
         // We do not capture OPTIONS/HEAD requests as transactions
@@ -112,7 +120,7 @@ export const instrumentHttp = Object.assign(
         }
 
         const _ignoreIncomingRequests = _httpOptions.ignoreIncomingRequests;
-        if (url && _ignoreIncomingRequests && _ignoreIncomingRequests(url)) {
+        if (urlPath && _ignoreIncomingRequests && _ignoreIncomingRequests(urlPath)) {
           return true;
         }