To help you get started, we've collected the most common ways that chrome-har is being used within popular public projects.

oxygenhq / oxygen / ox_modules / module-web.js View on Github

var logs = _this.driver.getLogs('performance');

        // in one instance, logs was not iterable for some reason - hence the following check:
        if (!logs || typeof logs[Symbol.iterator] !== 'function') {
            console.error('harGet: logs not iterable: ' + JSON.stringify(logs));
            return null;
        }

        var events = [];
        for (var log of logs) {
            var msgObj = JSON.parse(log.message);   // returned as string
            events.push(msgObj.message);
        }

        try {
            const har = harFromMessages(events);
            return JSON.stringify(har);
        } catch (e) {
            console.error('Unable to fetch HAR: ' + e.toString());
            return null;
        }
    }

View more ways to use chrome-har

Chrome-har

Create HAR files based on Chrome DevTools Protocol data.

We got tired of waiting for the +30K engineers at Google implementing a way to automate to get a HAR file https://issues.chromium.org/issues/40809195 so we implemented our own solution in the mean time.

Code originally extracted from Browsertime, initial implementation inspired by Chromedriver_har.

Create a new bug report

Make sure to generate a event trace log file that we can use to recreate your issue. If you use Browsertime you can enable the trace with --chrome.collectPerfLog:

$ browsertime --chrome.collectPerfLog -n 1 https://www.sitespeed.io

Then take the file named chromePerflog-1.json.gz and put it in a gist or make it availible to us in any way you want.

If you use sitespeed.io:

$ sitespeed.io --browsertime.chrome.collectPerfLog -n 1 https://www.sitespeed.io

Support for Response Bodies

If you use Chrome-har standalone (without Browsertime/sitespeed.io) you can use get the response bodies in HARs if they are set on the response object by the caller and if the includeTextFromResponseBody option is set to true.

For example:

const harEvents: Array = [];

client.on('Network.requestIntercepted', async (params: any) => {
  // Get the response body
  const response = await client.send(
    'Network.getResponseBodyForInterception',
    { interceptionId: params.interceptionId },
  );

  // Set the body on the response object
  if (params.response != null) {
    params.response.body = response.body;
  } else {
    params.response = response;
  }

  // Continue the request
  await client.send(
    'Network.continueInterceptedRequest',
    { interceptionId: params.interceptionId },
  );

  harEvents.push({ method, params });
});

const har = harFromMessages(harEvents, {includeTextFromResponseBody: true});