Skip to content

Emergency Runbook

nr-opensource-bot edited this page Feb 21, 2023 · 18 revisions

Emergency Runbook -- opensource.newrelic.com

This site is hosted on Gatsby Cloud. It is maintained and supported by New Relic's Docs Engineering team. If you have any questions or comments, please reach out to docs-engineering@newrelic.com.

Alerts

Alerts

To diagnose a particular alert, we've started a Common Issues

Rollback a release

Use the Gatsby Cloud UI to select a previous build and redeploy that build.

First, determine the desired previous build:

  1. Navigate to the Releases tab in the opensource-website repo.
  2. Determine which release to rollback to. Typically, this should be latest_release - 1. However, you might need to go back further. Click the commit hash (in this case, 12f5187). Releases
  3. Use this commit message/hash value to locate the corresponding build in the Gatsby Cloud UI. Commits

Steps to redeploy in Gatsby Cloud:

  1. Log into Gatsby Cloud using your GitHub login.
  2. Select the opensource-website site, main branch. Opensource Sites
  3. Click the View production history button to see all the previous builds that have run.
  4. Find the appropriate build corresponding to the release you located from the repo releases. This is the build to roll back to. Click Publish to select that build for deployment. Builds
  5. That should produce a pop up. Uncheck Disable automatic deploys and click Publish. Publish Pop Up
  6. Notify the hero in #help-deven-websites of the rollback so we can address the underlying issue.

Environments

This project supports three environments, local development, staging (a.ka. development), and production.

Note: When building the site, Gatsby coerces anything you've set in NODE_ENV to production

Production

Corresponds to the main branch

New Relic Domains: https://opensource.newrelic.com

New Relic Browser monitoring

Staging (Development)

Corresponds to the develop branch

Gatsby Cloud Domain: https://opensourcewebsitedevelop.gatsbyjs.io/ New Relic Domains:

New Relic Browser monitoring

Local Development

To run, execute yarn start from the root of this repository.

Should you want Tessen instrumentation while developing locally, you will need to add an additional configuration option to gatsby-config.js for the gatsby-plugin-newrelic plugin.

Architecture

The site is a combination of template-generated pages and single pages built using React, markup, and MDX.

Beyond the CI/CD automation, GitHub Actions are used to keep the stats data related to each project updated on a scheduled basis. Some of the architecture consequences of that change are described here.

Common Issues

No issues yet!

Help/Support Channels