Skip to content

Commit

Permalink
feat(synthetics): removed videos, updated verbiage around quickstarts…
Browse files Browse the repository at this point in the history 
…, added style edits, and fixed table that was creating errors
  • Loading branch information
@akristen
akristen committed Apr 9, 2024
1 parent 63e66ed commit 33b214a
Showing 1 changed file with 137 additions and 152 deletions.
289 changes: 137 additions & 152 deletions ...s/synthetics/synthetic-monitoring/using-monitors/intro-synthetic-monitoring.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,7 @@ Setting up synthetic monitors with New Relic lets you:
* Get extended use case coverage with [additional Node modules](/docs/synthetics/synthetic-monitoring/scripting-monitors/import-nodejs-modules) for your scripted API monitors.
* Easily diagnose whether an issue stems from the network or AWS location, a slow third party resource, or the health of your backend services or infrastructure.

For ideas and examples check out our [Synthetics QuickStarts](https://newrelic.github.io/quickstarts-synthetics-library/#/)!

For a short demo of how to create synthetic monitors with New Relic, watch the below video (5:10 minutes).

<Video
id="EN5FkIW8YWk"
type="youtube"
/>
You can view community-sourced examples of some synthetic monitors in our [synthetics quickstarts](https://newrelic.github.io/quickstarts-synthetics-library/#/). These examples are open source and not supported by New Relic, but may provide valuable examples of how to maximize your synthetic monitors view examples of

## Before you create your first synthetic monitor...

Expand Down Expand Up @@ -208,12 +201,7 @@ These are the seven types of synthetic monitors:
</tbody>
</table>

You can [add and edit synthetic monitors](/docs/synthetics/synthetic-monitoring/using-monitors/add-edit-monitors) directly in our UI. You can also create some types of monitors with [Terraform](https://developer.newrelic.com/automate-workflows/get-started-terraform): for more on that, watch this short video (approx. 3:25 minutes).

<Video
id="WIVOgYlID-E"
type="youtube"
/>
You can [add and edit synthetic monitors](/docs/synthetics/synthetic-monitoring/using-monitors/add-edit-monitors) directly in our UI.

## Advanced testing with scripted browsers [#advanced]

Expand All @@ -225,144 +213,141 @@ Scripted browsers expand your testing capabilities, so you can test uncommon use

Synthetic monitoring includes the following features:

<table>
<thead>
<tr>
<th width={200}>
Feature
</th>

<th>
Description
</th>
</tr>
</thead>

<tbody>
<tr>
<td>
Real browsers
</td>

<td>
For simple browser and scripted browser monitors, they don't simply check that your host is up. It loads the actual page content in a real, fully virtualized Google Chrome browser (powered by Selenium) to provide testing that mirrors your users' actions.
</td>
</tr>

<tr>
<td>
Detailed results view
</td>

<td>
Synthetic monitoring stores every single run of your monitor for 13 months, so you can [view a detailed breakdown of each and every check](/docs/synthetics/new-relic-synthetics/using-monitors/viewing-monitor-results#understanding). You can get a snapshot of your website's performance and availability, or hunt down specific problems.
</td>
</tr>

<tr>
<td>
Comparative charts with browser monitoring
</td>

<td>
Use New Relic's [comparative charting feature](/docs/synthetics/new-relic-synthetics/administration/compare-page-load-performance-browser-synthetics) for a direct page load time comparison between real user ([<InlinePopover type="browser" />](/docs/browser/new-relic-browser/getting-started/introduction-new-relic-browser)) interactions and the synthetic monitors. For example, during a page outage, you can compare trends to see if an issue is also visible in synthetic monitoring, or if it is caused by other variables.
</td>
</tr>

<tr>
<td>
Device emulation
</td>

<td>
Use [device emulation](/docs/synthetics/synthetic-monitoring/using-monitors/device-emulation) to simulate mobile or tablet devices in simple and scripted browser monitors.
</td>
</tr>


<tr>
<td>
"Three strikes" before failure
</td>

<td>
Our monitors run three checks before entering a failed state. This multiple strike system helps reduce noise. For more on this, see [this forum post on the three-strike behavior](https://forum.newrelic.com/s/hubtopic/aAX8W0000008b18WAA/relic-solution-understanding-the-three-strikes-behavior-in-synthetics).
</td>
</tr>


<tr>
<td>
Advanced scripted monitoring
</td>

<td>
Use [scripted browsers](/docs/synthetics/new-relic-synthetics/scripting-monitors/writing-synthetic-scripts) to run complex test cases against your website. Ensure critical processes like checkout and login are always running smoothly, and build a baseline to compare against when things go wrong. With a built-in scripting IDE based on Node.js, create scripts quickly without leaving your browser.
</td>
</tr>

<tr>
<td>
Global test coverage
</td>

<td>
Check coverage from locations around the world to ensure your users can access your website from anywhere, anytime. Monitor sites behind your firewall by adding the [synthetic monitoring static IP addresses](/docs/apm/new-relic-apm/getting-started/networks#synthetics-public) to your allow list. Use [private locations](/docs/synthetics/new-relic-synthetics/private-locations/private-locations-overview-monitor-internal-sites-add-new-locations) to monitor internal sites or to expand your coverage to new locations.
</td>
</tr>

<tr>
<td>
Compatibility with popular analytics platforms
</td>

<td>
Synthetic monitoring specifically excludes scripts for [popular analytics services](https://s3.amazonaws.com/nr-synthetics-assets/default-hostnames-blacklist/production/default-hostnames-blacklist.txt), like Google Analytics. This ensures your analytics tools continue to receive the exact same data, even with thousands of monitors checking your website each month.

You can [unblock](/docs/synthetics/new-relic-synthetics/scripting-monitors/write-scripted-browsers#unblock-service) any of the services blocked by default, or [block](/docs/synthetics/new-relic-synthetics/scripting-monitors/synthetics-scripted-browser-reference#browser-addHostnameToBlacklist) additional services.
</td>
</tr>

<tr>
<td>
NerdGraph API functions
</td>

<td>
Synthetic monitoring is included in our GraphQL API, NerdGraph.

NerdGraph contains a number of query functions for Synthetics, which are detailed in our [documentation] (https://docs.newrelic.com/docs/apis/nerdgraph/examples/nerdgraph-synthetics-tutorial/#query).
The NerdGraph mutations for Synthetics allow you to create, update and delete your monitors, as well as manage your secure credentials, private locations and monitor downtimes. These mutations are also detailed in our [documentation] (https://docs.newrelic.com/docs/apis/nerdgraph/examples/nerdgraph-synthetics-tutorial/#create-monitors) with examples.

The NerdGraph Explorer App within the New Relic platform provides a UI for the GraphQL API & is an excellent tool to become familiar with the product, as well as generate queries and mutation for use in your IaC, OaC, CI/CD pipelines and other applications. Tutorial docs for the Explorer are [here] (https://docs.newrelic.com/docs/apis/nerdgraph/get-started/nerdgraph-explorer/).

</td>
</tr><tr>
<td>
REST API functions (Deprecated)
</td>

<td>
**Please Note: The REST API has been deprecated in favour of NerdGraph, and the new runtimes can only be managed by NerdGraph** </br>
Synthetic monitoring includes a REST API, which you can use to manage:

* [Simple monitors](/docs/apis/synthetics-rest-api/monitor-examples/manage-synthetics-monitors-via-rest-api) and [scripted monitors](/docs/apis/synthetics-rest-api/monitor-examples/manage-synthetics-monitor-scripts-rest-api)
* [Categories and labels for monitors](/docs/apis/synthetics-rest-api/monitor-examples/use-synthetics-label-apis)
* [Alert notifications](/docs/apis/synthetics-rest-api/alert-examples/manage-synthetics-alert-notifications-rest-api)
</td>
</tr><tr>
<td>
Terraform
</td>

<td>
New Relic has a Terraform provider for Observability as Code.

This provider has resources for each monitor type, as well as secure credentials and private locations. For more information, please see our [Terraform Intro] (https://docs.newrelic.com/docs/more-integrations/terraform/terraform-intro/) and our [Provider Docs] (registry.terraform.io/providers/newrelic/newrelic/latest/docs) on the Terraform Registry.
</td>
</tr>
</tbody>
</table>
<table>
<thead>
<tr>
<th width={200}>
Feature
</th>

<th>
Description
</th>
</tr>
</thead>

<tbody>
<tr>
<td>
Real browsers
</td>

<td>
For simple browser and scripted browser monitors, they don't simply check that your host is up. It loads the actual page content in a real, fully virtualized Google Chrome browser (powered by Selenium) to provide testing that mirrors your users' actions.
</td>
</tr>

<tr>
<td>
Detailed results view
</td>

<td>
Synthetic monitoring stores every single run of your monitor for 13 months, so you can [view a detailed breakdown of each and every check](/docs/synthetics/new-relic-synthetics/using-monitors/viewing-monitor-results#understanding). You can get a snapshot of your website's performance and availability, or hunt down specific problems.
</td>
</tr>

<tr>
<td>
Comparative charts with browser monitoring
</td>

<td>
Use New Relic's [comparative charting feature](/docs/synthetics/new-relic-synthetics/administration/compare-page-load-performance-browser-synthetics) for a direct page load time comparison between real user ([<InlinePopover type="browser" />](/docs/browser/new-relic-browser/getting-started/introduction-new-relic-browser)) interactions and the synthetic monitors. For example, during a page outage, you can compare trends to see if an issue is also visible in synthetic monitoring, or if it is caused by other variables.
</td>
</tr>

<tr>
<td>
Device emulation
</td>

<td>
Use [device emulation](/docs/synthetics/synthetic-monitoring/using-monitors/device-emulation) to simulate mobile or tablet devices in simple and scripted browser monitors.
</td>
</tr>


<tr>
<td>
"Three strikes" before failure
</td>

<td>
Our monitors run three checks before entering a failed state. This multiple strike system helps reduce noise. For more on this, see [this forum post on the three-strike behavior](https://forum.newrelic.com/s/hubtopic/aAX8W0000008b18WAA/relic-solution-understanding-the-three-strikes-behavior-in-synthetics).
</td>
</tr>


<tr>
<td>
Advanced scripted monitoring
</td>

<td>
Use [scripted browsers](/docs/synthetics/new-relic-synthetics/scripting-monitors/writing-synthetic-scripts) to run complex test cases against your website. Ensure critical processes like checkout and login are always running smoothly, and build a baseline to compare against when things go wrong. With a built-in scripting IDE based on Node.js, create scripts quickly without leaving your browser.
</td>
</tr>

<tr>
<td>
Global test coverage
</td>

<td>
Check coverage from locations around the world to ensure your users can access your website from anywhere, anytime. Monitor sites behind your firewall by adding the [synthetic monitoring static IP addresses](/docs/apm/new-relic-apm/getting-started/networks#synthetics-public) to your allow list. Use [private locations](/docs/synthetics/new-relic-synthetics/private-locations/private-locations-overview-monitor-internal-sites-add-new-locations) to monitor internal sites or to expand your coverage to new locations.
</td>
</tr>

<tr>
<td>
Compatibility with popular analytics platforms
</td>

<td>
Synthetic monitoring specifically excludes scripts for [popular analytics services](https://s3.amazonaws.com/nr-synthetics-assets/default-hostnames-blacklist/production/default-hostnames-blacklist.txt), like Google Analytics. This ensures your analytics tools continue to receive the exact same data, even with thousands of monitors checking your website each month.

You can [unblock](/docs/synthetics/new-relic-synthetics/scripting-monitors/write-scripted-browsers#unblock-service) any of the services blocked by default, or [block](/docs/synthetics/new-relic-synthetics/scripting-monitors/synthetics-scripted-browser-reference#browser-addHostnameToBlacklist) additional services.
</td>
</tr>

<tr>
<td>
NerdGraph API functions
</td>

<td>
We include synthetic monitoring in NerdGraph, our GraphQL API. NerdGraph contains a number of query functions for synthetics, which you can review in our [synthetics Nerdgraph documentation](/docs/apis/nerdgraph/examples/nerdgraph-synthetics-tutorial/#query).

* NerdGraph mutations for synthetics let you create, update and delete your monitors. You can also manage your secure credentials, private locations and monitor downtimes. View examples of [these mutations](/docs/apis/nerdgraph/examples/nerdgraph-synthetics-tutorial/#create-monitors) in our documentation.
* You can create synthetics from [NerdGraph explorer](/docs/apis/nerdgraph/get-started/nerdgraph-explorer/), which lets you generate queries and mutations in your IaC, OaC, CI/CD pipelines and other applications.

</td>
</tr>
<tr>
<td>
REST API functions (Deprecated)
</td>

<td>
REST APIs are deprecated. We recommend that you use NerdGraph instead, as the new runtimes can only be managed by NerdGraph. To use REST API, see our docs:

* [Simple monitors](/docs/apis/synthetics-rest-api/monitor-examples/manage-synthetics-monitors-via-rest-api) and [scripted monitors](/docs/apis/synthetics-rest-api/monitor-examples/manage-synthetics-monitor-scripts-rest-api)
* [Categories and labels for monitors](/docs/apis/synthetics-rest-api/monitor-examples/use-synthetics-label-apis)
* [Alert notifications](/docs/apis/synthetics-rest-api/alert-examples/manage-synthetics-alert-notifications-rest-api)
</td>
</tr>
<tr>
<td>
Terraform
</td>

<td>
Terraform provides resources for each monitor type, and secure credentials and private locations. For more information, see our [Introduction to Terraform](/docs/more-integrations/terraform/terraform-intro/), or review [Terraform's docs on the Terraform registry](registry.terraform.io/providers/newrelic/newrelic/latest/docs) .
</td>
</tr>
</tbody>
</table>

## What's next? [#enhanced-monitoring]

Expand Down

0 comments on commit 33b214a

Please sign in to comment.