Skip to content

Commit

Permalink
[LOPS-2404] Update New Relic deployment markers guide to not duplicat…
Browse files Browse the repository at this point in the history 
…e script docs. (pantheon-systems#9050)

* Update 04-new-relic-quicksilver to not duplicate script docs.

* rewriting surrounding sections

* Update source/content/guides/new-relic/04-new-relic-quicksilver.md

Co-authored-by: Steve Persch <[email protected]>

---------

Co-authored-by: Steve Persch <[email protected]>
Co-authored-by: Steve Persch <[email protected]>
  • Loading branch information
@kporras07 @stevector
3 people authored Jun 20, 2024
1 parent cbcbec1 commit 8e88936
Showing 1 changed file with 5 additions and 88 deletions.
93 changes: 5 additions & 88 deletions source/content/guides/new-relic/04-new-relic-quicksilver.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,98 +17,15 @@ permalink: docs/guides/new-relic/new-relic-quicksilver

New Relic&reg; Performance Monitoring is a powerful tool for monitoring the performance of a WordPress or Drupal site. It provides insight into how efficiently a website is using resources, and where improvements can be made in the application. Pantheon offers New Relic&reg; Pro within the Site Dashboard on all sites (excluding Basic) for free.

In this guide, we'll automatically label code changes to your site in New Relic&reg;'s Deployment page using Pantheon's [Quicksilver hooks](/guides/quicksilver/hooks) and [Terminus](/terminus). This creates a traceable connection between performance changes and code deployments, allowing developers to determine whether a code change positively or negatively impacted performance.
This integration becomes more useful when code changes (signified by deployments) are labeled in New Relic&reg; to track performance changes over time.
Such tracking can be done using [Quicksilver hooks](/guides/quicksilver/hooks) and [Terminus](/terminus). This creates a traceable connection between performance changes and code deployments, allowing developers to determine whether a code change positively or negatively impacted performance.

## Configure Quicksilver Hook to Record Deployments

1. Go to [New Relic&reg; Performance Monitoring](/guides/new-relic/activate-new-relic#open-new-relic-performance-monitoring).

1. Use Pantheon's Quicksilver hooks to run our example [New Relic&reg; script](https://github.com/pantheon-systems/quicksilver-examples/blob/master/new_relic_deploy/new_relic_deploy.php) immediately after code is synced on Dev or a Multidev environment and after code is deployed to Test and Live. The script configured in this guide applies a label to the Deployment page in New Relic&reg;.

<Alert title="Variables" type="export">

This process uses [Terminus](/terminus) commands that require your site name. Before you begin, set the variable `$site` in your terminal session to match your site name:

```bash{promptUser: user}
export site=yoursitename
```
</Alert>
1. [Clone your Pantheon site repository](/guides/git/git-config#clone-your-site-codebase) if you haven't done so already.
1. Navigate to the project's root directory. You can use Terminus to provide the clone command:
```bash{outputLines:2-3}
terminus connection:info $site.dev --fields='Git Command' --format=string
git clone ssh://[email protected]:2222/~/repository.git sitename
```

1. Copy and run the output command and then change directory to the site code root:

```bash{promptUser: user}
cd $site
```

1. Set the connection mode to Git:

```bash{promptUser: user}
terminus connection:set $site.dev git
```

1. Create a copy of [Pantheon's `new_relic_deploy.php`](https://github.com/pantheon-systems/quicksilver-examples/blob/master/new_relic_deploy/) script in the project's private path:

``` bash{promptUser: user}
mkdir -p private/scripts
curl https://raw.githubusercontent.com/pantheon-systems/quicksilver-examples/master/new_relic_deploy/new_relic_deploy.php --output ./private/scripts/new_relic_deploy.php
```

1. Create a `pantheon.yml` file if one doesn't already exist in your root directory.

1. Paste the following workflow into your `pantheon.yml` file to hook into the platform after code is synced on Dev/Multidev and deployed to Test/Live to fire off the New Relic&reg; integration script:

```yaml:title=pantheon.yml
api_version: 1
workflows:
# Log to New Relic when deploying to test or live.
deploy:
after:
- type: webphp
description: Log to New Relic
script: private/scripts/new_relic_deploy.php
# Also log sync_code so you can track new code going into dev/multidev.
sync_code:
after:
- type: webphp
description: Log to New Relic
script: private/scripts/new_relic_deploy.php
```

<Alert title="Note" type="info">

`api_version` should be set once in [`pantheon.yml`](/pantheon-yml). If you have an existing `pantheon.yml` with this line, do not add it again.

</Alert>

1. [Add, commit, and push](/guides/git/git-config#push-changes-to-pantheon) changes to the Dev/Multidev environment:

```bash{promptUser: user}
git add private/scripts/new_relic_deploy.php
git commit -am "Adding deployment recording to New Relic"
git push origin master
```

In the terminal, you should see that your `pantheon.yml` file is being applied. Even this initial code push should appear in your Dev environment's New Relic&reg; account, on the **Deployments** tab:

![Deployment tab display](../../../images/integrations/newrelic/deploy_tab.png)

1. Confirm that there are no issues, then deploy your new commit to Test and Live. Your deploys will now be recorded in New Relic&reg; Performance Monitoring.
To add these labels automatically on code pushes or deployments, follow the steps outlined in the [script documentation](https://github.com/pantheon-systems/quicksilver-examples/blob/main/new_relic_deploy).

## More Quicksilver Examples

The steps above provide a fast way to integrate New Relic&reg; Performance Monitoring and Pantheon with Quicksilver. The [Quicksilver Examples](https://github.com/pantheon-systems/quicksilver-examples) repository provides many more ways to automate development, so please take advantage of them and extend them to fit your workflow.
The [Quicksilver Examples](https://github.com/pantheon-systems/quicksilver-examples) repository provides many more ways to automate process.
Take advantage of them and extend them to fit your workflow.

## More Resources

Expand Down

0 comments on commit 8e88936

Please sign in to comment.