Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Patch performance and availability monitoring via new relic #2843

Open
wants to merge 9 commits into
base: master
Choose a base branch
from
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: Extend Spryker Cloud Monitoring via Headless APM
description:
template: concept-topic-template
last_updated: Oct 7, 2024
redirect_from:
- /docs/cloud/dev/spryker-cloud-commerce-os/monitoring/performance-and-availability-monitoring-via-new-relic.html
---

The **Spryker Monitoring Integration**, our Headless APM, integrates Spryker’s monitoring data into your existing APM platform based on the Spryker implementation of the **OpenTelemetry framework**.
It allows you to unify Spryker’s insights with your monitoring ecosystem, ensuring full visibility across eCommerce workflows, faster issue detection, and alignment with your monitoring best practices.

The **Headless APM** allows you to:
- **Personalize Application Monitoring**: Seamlessly integrate Spryker into your monitoring platform for a tailored, customized monitoring experience.
- **Gain Comprehensive Tracing and Health Check Metrics**: Forward traces and health check metrics from both your application and Spryker services to enable precise performance analysis and faster anomaly detection, reducing downtime and improving operational efficiency
- **Unify Monitoring**: Consolidate all performance data into your existing monitoring platform, ensuring full visibility across your entire eCommerce workflow for accurate end-to-end tracing and faster issue resolution.

To enable the Spryker Monitoring Integration, please contact [Spryker Support](https://spryker.force.com/support/s/).
3 changes: 2 additions & 1 deletion docs/ca/dev/monitoring/monitoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ redirect_from:
- /docs/cloud/dev/spryker-cloud-commerce-os/monitoring/monitoring.html
---

This section explains monitoring via New Relic and describes how to customize AWS CloudWatch dashboards:
This section explains monitoring via New Relic APM or Headless APM, and describes how to customize AWS CloudWatch dashboards:

* [Performance and availability monitoring via New Relic](/docs/ca/dev/monitoring/performance-and-availability-monitoring-via-new-relic.html)
* [Extend Spryker Cloud monitoring via Headless APM](docs/ca/dev/monitoring/extend-spryker-cloud-monitoring-via-headless-apm.md)
* [Customize AWS CloudWatch dashboards](/docs/ca/dev/monitoring/customize-aws-cloudwatch-dashboards.html)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The process to get a new relic license for a customer is under review. Contact @ThomasLehnerSpryker before publishing this page

Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
title: Performance and availability monitoring via New Relic
title: Performance and availability monitoring via New Relic APM
description:
template: concept-topic-template
last_updated: Oct 6, 2023
redirect_from:
- /docs/cloud/dev/spryker-cloud-commerce-os/monitoring/performance-and-availability-monitoring-via-new-relic.html
---

New Relic delivers the end-to-end observability for all metrics, events, logs, and traces and delivers the ability to visualize, analyze, and troubleshoot your entire environment including network performance. You can easily view and analyze massive amounts of data, and gain actionable insights in real-time.
New Relic APM delivers detailed traces that track the flow of requests through your Spryker application, providing visibility into performance bottlenecks, latency issues, and errors to help optimize and troubleshoot your application in real-time.

For more information about New Relic, see [Get started with infrastructure monitoring](https://docs.newrelic.com/docs/infrastructure/infrastructure-monitoring/get-started/get-started-infrastructure-monitoring).
For more information about New Relic APM, see [Improve your app performance with APM](https://docs.newrelic.com/docs/apm/new-relic-apm/getting-started/introduction-apm/).

To get access to New Relic, provide a non-person email address via [support](https://spryker.force.com/support/s/). We will create a shared account for your team.
To be able to access New Relic APM, you need to get at least one (1) New Relic user license for your organization. Contact [Support](https://spryker.force.com/support/s/) to further explore this option!
6 changes: 4 additions & 2 deletions docs/dg/dev/integrate-and-configure/configure-services.md
Original file line number Diff line number Diff line change
Expand Up @@ -469,13 +469,15 @@ It is not obligatory to pass all the details as environment variables or define

{% endinfo_block %}

## New Relic
## New Relic APM

[New Relic](https://newrelic.com/) is a tool used to track the performance of services and the environment to quickly find and fix issues.
[New Relic APM](https://docs.newrelic.com/docs/apm/new-relic-apm/getting-started/introduction-apm/) is a tool used to track the performance of all your applications and microservices to quickly find and fix issues.

The solution consists of a client and a server. The client is used to collect data about applications in an environment and send it to the server for further analysis and presentation. The server is used to aggregate, analyse, and present the data.

### Prerequisites
> [!NOTE]
> To be able to access New Relic APM, you need to get at least one (1) New Relic user license for your organization. Contact [Support](https://spryker.force.com/support/s/) to further explore this option!

* [New Relic license key](https://docs.newrelic.com/docs/apis/intro-apis/new-relic-api-keys/): `NEWRELIC_LICENSE`
* NewRelic account ID: `NEWRELIC_ACCOUNT_ID`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ If you do not have this information, then request additional data from the perso
You are free to choose any profiling tool you want.
The ones that we prefer are [New Relic](https://docs.newrelic.com/docs/new-relic-solutions/get-started/intro-new-relic/) and [Blackfire](https://blackfire.io/docs/introduction).

### New Relic
### New Relic APM

To profile with New Relic, do the following:

Expand All @@ -42,7 +42,7 @@ To profile with New Relic, do the following:
Note the following:
- It takes [some time for the New Relic to show the profiling](https://docs.newrelic.com/docs/new-relic-solutions/solve-common-issues/troubleshooting/not-seeing-data/#:~:text=Solution,to%20automatically%20identify%20common%20issues.).
- If the request is not meeting the criteria, it will not appear in New Relic.
Read more on the [official New Relic website](https://docs.newrelic.com/docs/apm/transactions/transaction-traces/troubleshooting-not-seeing-transaction-traces/).
Read more on the [official New Relic APM website](https://docs.newrelic.com/docs/apm/transactions/transaction-traces/troubleshooting-not-seeing-transaction-traces/).

3. Review the profiling.
For example, if the problem is with “place-order“ with 25 product items, do the following:
Expand Down