Lighthouse Integration

Overview

Get metrics from Google Chrome Lighthouse in real time to:

• Visualize and monitor Lighthouse stats.
• Track and audit scores for your websites accessibility, best practices, performance, PWA, and SEO audit scores.

Setup

The Lighthouse check is not included in the Datadog Agent package, so you need to install it.

Installation

For Agent v7.21+ / v6.21+, follow the instructions below to install the Lighthouse check on your host. See Use Community Integrations to install with the Docker Agent or earlier versions of the Agent.

1. Run the following command to install the Agent integration:

   datadog-agent integration install -t datadog-lighthouse==<INTEGRATION_VERSION>

2. Configure your integration similar to core integrations.

Configuration

1. Edit the lighthouse.d/conf.yaml file in the conf.d/ folder at the root of your Agent's configuration directory to start collecting your Lighthouse metrics. See the sample lighthouse.d/conf.yaml for all available configuration options.

2. Restart the Agent

Requirements

1. Node.js LTS (8.9+).

   • Check if Node.js and npm installed:

   node -v
   npm -v

   • If not, install Node.js and npm.

2. Lighthouse:

   • Check if installed.

   # example
   root@hostname:~# npm list -g --depth=0 | grep 'lighthouse'
   |_ lighthouse@5.6.0

   • Install if not (no output from above command):

   npm install -g lighthouse

3. Either Google Chrome/Chromium or Puppeteer.

   • Chromium

     • Debian/Ubuntu

     sudo apt-get update
     sudo apt-get install -y chromium-browser

     • RHEL/CentOS

     sudo yum install -y epel-release
     sudo yum install -y chromium

     Note: This integration runs Chrome/Chromium in headless mode. Chrome/Chromium may require kernel 4.4+ on RHEL/CentOS for the headless mode to work properly.

   • Puppeteer

     • Check if installed.

     # example
     root@hostname:~# npm list -g --depth=0 | grep 'puppeteer'
     |_ puppeteer@1.12.2

     • Install if not (no output from above command):

     npm install -g puppeteer --unsafe-perm=true

4. Verify if dd-agent user is able to run the lighthouse cli.

   sudo -u dd-agent lighthouse <WEB_URL> --output json --quiet --chrome-flags='--headless'

Validation

Run the Agent's status subcommand and look for lighthouse under the Checks section.

Data Collected

Metrics

See metadata.csv for a list of metrics provided by this check.

Events

The Lighthouse integration does not include any events.

Service Checks

The Lighthouse integration does not include any service checks.

Troubleshooting

Need help? Contact Datadog support.