Instrument HTTP Requests

Learn how to manually instrument your code to use Sentry's Requests module.

As a prerequisite to setting up Requests, you'll need to first set up performance monitoring. Once this is done, the JavaScript SDK will automatically instrument outgoing HTTP requests. If that doesn't fit your use case, follow this guide to manually instrument your requests.

For detailed information about which data can be set, see the Requests Module developer specifications.

Refer to HTTP Span Data Conventions for a full list of the span data attributes.

Here is an example of an instrumented function that makes HTTP requests:

my-request.js
Copied
async function makeRequest(method, url) {
  return await Sentry.startSpan(
    {op: 'http.client', name: `${method} ${url}`},
    async span => {
      const parsedURL = new URL(url, location.origin);

      span.setAttribute('http.request.method', method);

      span.setAttribute('server.address', parsedURL.hostname);
      span.setAttribute('server.port', parsedURL.port || undefined);

      const response = await fetch(url, {
        method,
      });

      span.setAttribute('http.response.status_code', response.status);
      span.setAttribute(
        'http.response_content_length',
        Number(response.headers.get('content-length'))
      );

      // A good place to set other span attributes

      return response;
    }
  );
}
Help improve this content
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").