Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Commit 1ac4468

Browse files
meker12maeker12hguthrie
authored
Added information about using Managed Alerts on Starter projects (#8115)
* Added information about using Managed Alerts on Starter projects * Update src/cloud/project/new-relic.md * Update src/cloud/project/new-relic.md * Update src/cloud/project/new-relic.md * Update src/cloud/project/new-relic.md Co-authored-by: hguthrie <[email protected]> * Update src/cloud/project/new-relic.md Co-authored-by: hguthrie <[email protected]> * Remove extra bracket (#8118) Co-authored-by: maeker12 <{ID}+{username}@users.noreply.github.com> Co-authored-by: hguthrie <[email protected]>
1 parent a2de6c1 commit 1ac4468

File tree

2 files changed

+32
-34
lines changed

2 files changed

+32
-34
lines changed

src/cloud/docker/docker-development.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ You can use the Docker environment to emulate the {{site.data.var.ece}} Integrat
4848

4949
- **[{{site.data.var.mcd-package}} GitHub repository]**–Visit the GitHub repository to read discussions about current issues, check current development, and submit issues or pull requests to improve the project.
5050

51-
- **Magento Cloud Community Engineering demos**–Magento hosts Cloud demo session where you can learn about developing Magento on the Cloud platform, including information about local development with {{site.data.var.mcd-prod}}}. For a schedule and recordings of previous demos, see the [Magento Cloud Community Engineering Demo Schedule].
51+
- **Magento Cloud Community Engineering demos**–Magento hosts Cloud demo session where you can learn about developing Magento on the Cloud platform, including information about local development with {{site.data.var.mcd-prod}}. For a schedule and recordings of previous demos, see the [Magento Cloud Community Engineering Demo Schedule].
5252

5353
<!--Link definitions-->
5454

src/cloud/project/new-relic.md

Lines changed: 31 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ functional_areas:
88
- Services
99
---
1010

11-
{{ site.data.var.ece }} projects include access to New Relic services to help manage, monitor, and troubleshoot your applications and infrastructure by collecting, viewing, and analyzing data from your {{ site.data.var.ece }} project.
11+
{{ site.data.var.ece }} projects include access to the following New Relic services to help manage, monitor, and troubleshoot your applications and infrastructure by collecting, viewing, and analyzing data from your {{ site.data.var.ece }} project.
1212

1313
- [New Relic APM](#new-relic-apm) (Pro and Starter)
1414
- [New Relic Infrastructure](#new-relic-infrastructure) (Pro, Production environment only)
@@ -22,7 +22,7 @@ functional_areas:
2222
- **Database query monitoring**—Locate and monitor database queries affecting performance.
2323
- **App Map**—View all application dependencies within your Magento site, extensions, and external services.
2424
- **Apdex scores**—Evaluate performance and create alerts that identify issues and notify you when they occur, such as site performance affected by a flash sale or web event. See [Apdex score].
25-
- **Managed Alerts for Magento Commerce**–Use this New Relic alert policy to monitor application and infrastructure performance based on industry best practices. See [Monitor performance with the Magento alert policy](#monitor-performance-with-managed-alerts).
25+
- **Managed Alerts for Magento Commerce**–Use this New Relic alert policy to monitor application and infrastructure performance based on industry best practices. See [Monitor performance with the Managed Alerts for {{ site.data.var.ee }} alert policy](#monitor-performance-with-managed-alerts).
2626

2727
Your {{site.data.var.ece}} project includes the software for the New Relic APM service along with a license key. You do not need to purchase or install any additional software.
2828

@@ -31,7 +31,7 @@ Your {{site.data.var.ece}} project includes the software for the New Relic APM s
3131
{{site.data.var.ece}} Pro projects include the [New Relic Infrastructure (NRI)][New Relic infrastructure] service, which automatically connects with the application data and performance analytics to provide dynamic server monitoring. This service is available on Production and Staging environments.
3232

3333
{:.bs-callout-info}
34-
For Pro accounts, if New Relic APM is not installed on the Staging and Production environments or New Relic Infrastructure is not available in the Production environment, submit a [support ticket]({{ site.baseurl }}/cloud/trouble/trouble.html) to request installation.
34+
For Pro accounts, if New Relic APM is not installed on the Staging and Production environments or New Relic Infrastructure is not available in the Production environment, [submit a Magento Support ticket] to request installation.
3535

3636
## New Relic Logs
3737

@@ -52,7 +52,7 @@ As soon as your project is connected to New Relic, you can use the New Relic Log
5252

5353
See [View and analyze logs](#view-and-analyze-log-data).
5454

55-
## Manage your New Relic account
55+
## Manage New Relic account
5656

5757
When Magento provisions your {{site.data.var.ece}} project, the License Owner receives an email from New Relic with credentials and instructions for accessing the New Relic account. If you did not receive the email, use the License Owner email address to [reset the New Relic password].
5858

@@ -80,13 +80,13 @@ To add a user:
8080

8181
1. Ask the new user to check their email for a New Relic notification with account information.
8282

83-
## Set up the New Relic service
83+
## Set up New Relic
8484

8585
Pro environments are preconfigured to use New Relic services.
8686

8787
For Starter environments, you must check the `.magento.app.yaml` file to verify that the `runtime` section includes the New Relic extension. If the extension has not been configured, add the following:
8888

89-
> .magento.app.yaml
89+
> `.magento.app.yaml`
9090
9191
```yaml
9292
runtime:
@@ -95,31 +95,30 @@ runtime:
9595
```
9696
9797
{:.bs-callout-warning}
98-
If you upgrade the PHP version on your {{site.data.var.ece}} project, you must submit a Magento Support ticket to update the New Relic service.
98+
If you upgrade the PHP version on your {{site.data.var.ece}} project, you must [submit a Magento Support ticket] to update the New Relic service.
9999
100100
## Connect to New Relic
101101
102-
To connect a Cloud environment to New Relic, you must add the New Relic license key to the environment.
102+
To connect a Cloud environment to New Relic, add the New Relic license key to the environment.
103103
104104
- For Pro accounts, Magento adds the license key to your Cloud environments during the provisioning process. You can log in to your New Relic account to verify connectivity between your Magento Commerce site and New Relic.
105105
106106
- For Starter accounts, you have a New Relic license key that supports up to three environments. You must add the key to your environment configurations manually. The license key is not pre-provisioned on Starter environments.
107107
108108
### Configure New Relic for Starter environments
109109
110-
For Starter environments, you must add the New Relic license key to the environment configuration to enable the New Relic integration. We recommend adding the key to the Staging and Production (master) environments and one other environment of your choice. Only the New Relic license key is required for configuration. You can find information about additional configuration options in the [New Relic reporting] topic in the _Magento User Guide_.
110+
For Starter environments, enable the New Relic integration by adding the New Relic license key to the environment configuration. We recommend adding the key to the Staging and Production (master) environments and one other environment of your choice. Only the New Relic license key is required for configuration. You can find information about additional configuration options in the [New Relic reporting] topic in the _Magento Commerce User Guide_.
111111
112112
{:.bs-callout-warning}
113113
Updating the environment configuration triggers a redeployment, which takes your site offline until deployment completes. For Production environments, we recommend completing this work during off-peak hours to avoid service disruptions. See [Working with variables].
114114
115-
{:.procedure}
116-
Prerequisites
115+
**Prerequisites:**
117116
118117
- Log in credentials for the Magento account page, or for the New Relic account associated with your project
119118
- [Admin level access]({{site.baseurl}}/cloud/project/user-admin.html) to the Starter environments to configure, or credentials to access the [Magento Admin](https://docs.magento.com/m2/ce/user_guide/system/permissions.html) for the environment.
120119
121120
{:.procedure}
122-
To configure New Relic on a Starter environment:
121+
To configure New Relic for Starter environments:
123122
124123
1. Find your New Relic license key from your Magento Cloud account page, or [from your New Relic account page]:
125124
@@ -133,7 +132,7 @@ To configure New Relic on a Starter environment:
133132
134133
- Copy the license key.
135134
136-
1. Add the New Relic license key to an environment using the Magento Cloud CLI, or [add it from the Magento Admin]:
135+
1. Add the New Relic license key to an environment using the Magento Cloud CLI, or [add it from the Magento Admin].
137136
138137
- Change to the environment that needs the license key.
139138
@@ -145,7 +144,7 @@ To configure New Relic on a Starter environment:
145144

146145
1. [Log in to New Relic][New Relic login] to verify that you can view data from the Magento Cloud environment. (See [Investigate performance](#investigate-performance).)
147146

148-
### Remove New Relic license key from a Starter environment
147+
### Remove license key from a Starter environment
149148

150149
If three active Starter environments already use the same New Relic license key, and you want to configure New Relic reporting on a different environment, you must remove the key from one of the configured environments before you can reuse it.
151150

@@ -250,29 +249,27 @@ For further information and examples, see [Introduction to New Relic Logs][New R
250249

251250
### Monitor performance with Managed Alerts
252251

253-
Adobe provides the Managed Alerts for {{ site.data.var.ee }} alert policy on Cloud Pro Production environments to track the following metrics:
254-
255-
- [Apdex score]
256-
- error rate
257-
- disk space (available on Pro Production environments only)
258-
- CPU usage
259-
- memory usage
252+
Adobe provides the Managed Alerts for {{ site.data.var.ee }} alert policy to track performance metrics.
253+
Based on industry best practices, the policy includes a collection of alerts that set thresholds to trigger warning and critical notifications when site infrastructure or application issues affect performance. The Managed Alerts policy tracks the following metrics on Production environments only:
260254

261-
Based on industry best practices, this policy is a collection of alerts that set thresholds for warning and critical conditions that affect performance.
255+
| Metric | Data collection | Availability
256+
|:--------|:------------------------|:-------------
257+
| [Apdex score] | APM | Pro and Starter
258+
| error rate | APM | Pro and Starter
259+
| disk space | NRI | Pro
260+
| CPU usage | NRI | Pro
261+
| memory usage | NRI | Pro
262262

263-
When your site experiences an infrastructure or application issue that triggers an alert threshold, New Relic sends alert notifications so that you can proactively address the issue. See [Managed Alerts for Magento Commerce][] in the _Magento Help Center_ for details about each alert type and troubleshooting steps to resolve the issues that triggered the alert.
264-
265-
{:.bs-callout-warning}
266-
To use this policy and get notified when an issue on your site triggers an alert condition, you must configure at least one notification channel to receive the alert notifications.
263+
When site infrastructure or application conditions trigger an alert threshold, New Relic sends alert notifications so that you can proactively address the issue. See [Managed Alerts for Magento Commerce] in the _Magento Help Center_ for details about alert thresholds and troubleshooting steps to resolve the issues that triggered the alert.
267264

268265
{:.bs-callout-info}
269266
For Pro Staging and Integration environments and Starter environments, use [Health notifications] to monitor disk space.
270267

271-
{:.procedure}
272-
Prerequisites
268+
**Prerequisites:**
273269

274270
- Credentials to log in to the [New Relic account] for your Cloud project
275271
- Verify that your Cloud environment is [connected to New Relic](#connect-to-new-relic)
272+
- Configure at least one [notification channel](#configure-notification-channels) to receive the alert notifications
276273

277274
{:.procedure}
278275
To review the Managed Alerts for {{ site.data.var.ee }} policy:
@@ -294,15 +291,15 @@ To review the Managed Alerts for {{ site.data.var.ee }} policy:
294291
![Generated alert policies]({{ site.baseurl }}/common/images/cloud/cloud-newrelic-managed-alerts-for-magento.png){:width="650px"}
295292

296293
{:.bs-callout-info}
297-
If the policy is missing, submit a Magento support ticket. Include your project ID in the ticket. The policy is available on Pro and Starter Production environments only.
294+
If the Managed Alerts for {{ site.data.var.ee }} alert policy is not available, see [Managed Alerts for Magento Commerce][] in the _Magento Help Center_.
298295

299296
1. Click **Managed Alerts for Magento Commerce** to review the alert conditions defined in the policy.
300297

301298
![Managed alerts list]({{ site.baseurl }}/common/images/cloud/cloud-newrelic-magento-alert-conditions.png){:width="650px"}
302299

303300
### Configure notification channels
304301

305-
To use the Managed Alerts for Magento Commerce policy to monitor your Production sites, you must configure at least one notification channel and map it to the alert policy.
302+
To use Managed Alerts for {{ site.data.var.ee }} to monitor your Production sites, you must configure at least one notification channel and map it to the alert policy.
306303

307304
Notifications about performance issues go to all channels associated with an alert policy when conditions on the application or infrastructure trigger an alert. You also receive notifications when an issue is acknowledged and closed.
308305

@@ -350,7 +347,7 @@ See the following New Relic documentation topics for additional information:
350347
{:.bs-callout-warning}
351348
The alerts in the Managed Alerts for Magento Commerce policy have default notification channels configured to notify Magento teams that support {{ site.data.var.ece }} customers. Do not modify the configuration for these default channels, and do not remove any alert policies assigned to them.
352349

353-
### Create Alert Policies
350+
### Create alert policies
354351

355352
Do not modify any alerts included in the Managed Alerts for Magento Commerce policy. We update and improve the alert conditions in this policy over time, which overwrites any customizations you add to the policy.
356353

@@ -377,7 +374,7 @@ See [Alerts concepts and workflow] in the New Relic documentation for more detai
377374
[Magento Admin credentials]: https://docs.magento.com/m2/ce/user_guide/system/permissions.html
378375
[Magento Partnership Owner Account]: https://account.newrelic.com/accounts/1311131/users
379376
[Managed Alerts for Magento Commerce]: https://support.magento.com/hc/en-us/articles/360045806832
380-
[New Relic account]: #manage-your-new-relic-account
377+
[New Relic account]: #manage-new-relic-account
381378
[New Relic APM]: https://docs.newrelic.com/docs/apm/new-relic-apm/getting-started/introduction-new-relic-apm
382379
[New Relic APM Overview]: https://docs.newrelic.com/docs/apm/applications-menu/monitoring/apm-overview-page-view-transaction-apdex-usage-data
383380
[New Relic ONE UI]: https://docs.newrelic.com/docs/new-relic-one/use-new-relic-one/get-started/new-relic-one-core-ui-components
@@ -390,8 +387,9 @@ See [Alerts concepts and workflow] in the New Relic documentation for more detai
390387
[New Relic query syntax for logs]: https://docs.newrelic.com/docs/logs/new-relic-logs/ui-data/query-syntax-logs
391388
[New Relic reporting]: https://docs.magento.com/m2/ce/user_guide/configuration/general/new-relic-reporting.html
392389
[prerequisite steps]: https://docs.newrelic.com/docs/alerts/new-relic-alerts/managing-notification-channels/notification-channels-control-where-send-alerts#channel-types
393-
[Troubleshoot performance using New Relic]: https://support.magento.com/hc/en-us/articles/360042149832#low_user_satisfaction
394390
[reset the New Relic password]: https://rpm.newrelic.com/forgot_password
391+
[submit a Magento Support ticket]: {{ site.baseurl }}/cloud/trouble/trouble.html
392+
[Troubleshoot performance using New Relic]: https://support.magento.com/hc/en-us/articles/360042149832#low_user_satisfaction
395393
[Update the account owner]: https://docs.newrelic.com/docs/accounts/accounts/roles-permissions/change-account-owner
396394
[Update policies or conditions]: https://docs.newrelic.com/docs/alerts/new-relic-alerts/configuring-alert-policies/update-or-disable-policies-conditions
397395
[View your license key]: https://docs.newrelic.com/docs/accounts/install-new-relic/account-setup/license-key#finding

0 commit comments

Comments
 (0)