Skip to main content

Pantheon Systems Health Check

What does it do?​

The Decoupled Drupal health check will:

  1. Check for a BACKEND_URL and/or PANTHEON_CMS_ENDPOINT environment variable
  2. If both are set, use the BACKEND_URL for checks, otherwise use whatever is set. Throw an error if none are set.
  3. Fetch the language settings to determine subsequent calls.
  4. Fetch the decoupled router on an article based on 3. Throw an error if the decoupled router can not be reached.
  5. Fetch the decoupled footer menu. Throw an error if it can not be fetched.
  6. Use the set CLIENT_ID and CLIENT_SECRET to fetch an oauth token. Warnings are logged if these are not set.
  7. Check that the PREVIEW_SECRET is set
  8. Use the access_token if available to fetch preview content. Logs a warning if preview is not accessible.

The Decoupled WordPress health check will:

  1. check for a WPGRAPHQL_URL and/or PANTHEON_CMS_ENDPOINT environment variable
  2. If both are set, use the WPGRAPHQL_URL for checks, otherwise use whatever is set. Throw an error if none are set.
  3. Try to fetch the Example Menu, throw an error if it can not be reached.
  4. Use the set WP_APPLICATION_USERNAME and WP_APPLICATION_PASSWORD to fetch private posts. Warnings are logged if these are not set or are not valid.
  5. Check that the PREVIEW_SECRET is set.
  6. Use the credentials if available to fetch preview content. Logs a warning if preview is not accessible..

Usage​

Next + Drupal​

In the directory of your next-drupal project:

npx @pantheon-systems/decoupled-kit-health-check drupal

Next or Gatsby + WordPress​

In the directory of your next-wordpress or gatsby-wordpress project:

npx @pantheon-systems/decoupled-kit-health-check wordpress

Opt Out​

To opt out of the health check without changing any configuration in the package.json, set the NO_DKHC environment variable. If this variable is set to anything, the health check will be skipped.