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

W-17017575-insights-hyperforce-duke #314

Open
wants to merge 69 commits into
base: latest
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
69 commits
Select commit Hold shift + click to select a range
ce19567
W-17017575-insights-hyperforce-duke
dukesphere Nov 1, 2024
275009f
Update modules/ROOT/pages/anypoint-insights.adoc
dukesphere Nov 2, 2024
bf8be5d
Merge branch 'latest' into W-17017575-insights-hyperforce-duke
dukesphere Nov 2, 2024
d1903f2
W-17017575-insights-hyperforce-duke
dukesphere Nov 2, 2024
9dfea61
W-17017575-insights-hyperforce-duke
dukesphere Nov 3, 2024
8562082
W-17017575-insights-hyperforce-duke
dukesphere Nov 3, 2024
53c9aaa
W-17017575-insights-hyperforce-duke
dukesphere Nov 4, 2024
9ba68dc
W-17017644-hyperforce-prework-duke
dukesphere Nov 4, 2024
56596ae
W-17017575-insights-hyperforce-duke
dukesphere Nov 4, 2024
36802f6
W-17017575-insights-hyperforce-duke
dukesphere Nov 4, 2024
da897c8
W-17017575-insights-hyperforce-duke
dukesphere Nov 4, 2024
0338cb8
W-17017575-insights-hyperforce-duke
dukesphere Nov 5, 2024
e421a20
W-17017575-insights-hyperforce-duke
dukesphere Nov 5, 2024
9eb8a3f
W-17017575-insights-hyperforce-duke
dukesphere Nov 5, 2024
7538512
W-17017575-insights-hyperforce-duke
dukesphere Nov 5, 2024
5554f25
W-17017575-insights-hyperforce-duke
dukesphere Nov 5, 2024
388833b
W-17017575-insights-hyperforce-duke
dukesphere Nov 5, 2024
4d3fd79
W-17017575-insights-hyperforce-duke
dukesphere Nov 7, 2024
55acf1c
W-17017575-insights-hyperforce-duke
dukesphere Nov 7, 2024
4eea90b
W-17017575-insights-hyperforce-duke
dukesphere Nov 7, 2024
c0080cf
W-17017575-insights-hyperforce-duke
dukesphere Nov 7, 2024
bd655c4
W-17017575-insights-hyperforce-duke
dukesphere Nov 7, 2024
68b5772
W-17017575-insights-hyperforce-duke
dukesphere Nov 7, 2024
22a91d6
W-17017575-insights-hyperforce-duke
dukesphere Nov 8, 2024
722e15e
W-17017575-insights-hyperforce-duke
dukesphere Nov 8, 2024
9351c06
W-17017575-insights-hyperforce-duke
dukesphere Nov 8, 2024
3be9124
W-17017575-insights-hyperforce-duke
dukesphere Nov 8, 2024
cb7825d
W-17017575-insights-hyperforce-duke
dukesphere Nov 8, 2024
b6c3f88
W-17017575-insights-hyperforce-duke
dukesphere Nov 8, 2024
e237dd4
W-17017575-insights-hyperforce-duke
dukesphere Nov 9, 2024
cc9452a
W-17017575-insights-hyperforce-duke chart include and related updates
dukesphere Nov 12, 2024
cefd32e
W-17017575-insights-hyperforce-duke
dukesphere Nov 12, 2024
cfbb87d
W-17017575-insights-hyperforce-duke
dukesphere Nov 12, 2024
73d1eeb
W-17017575-insights-hyperforce-duke
dukesphere Nov 12, 2024
cd48f69
W-17017575-insights-hyperforce-duke
dukesphere Nov 12, 2024
2c8412f
W-17017575-insights-hyperforce-duke banner
dukesphere Nov 12, 2024
baefdaf
W-17017575-insights-hyperforce-duke banner
dukesphere Nov 12, 2024
efcaf6c
W-17017575-insights-hyperforce-duke banner
dukesphere Nov 12, 2024
7cdde1a
W-17017575-insights-hyperforce-duke downloads
dukesphere Nov 12, 2024
deb9b2e
W-17017575-insights-hyperforce-duke time selector
dukesphere Nov 12, 2024
7b0888e
W-17017575-insights-hyperforce-duke time selector
dukesphere Nov 12, 2024
56361c6
W-17017575-insights-hyperforce-duke
dukesphere Nov 12, 2024
355e3e3
W-17017575-insights-hyperforce-duke
dukesphere Nov 12, 2024
54d37c7
W-17017575-insights-hyperforce-duke
dukesphere Nov 12, 2024
b11f6f8
W-17017575-insights-hyperforce-duke
dukesphere Nov 12, 2024
732b6bd
W-17017575-insights-hyperforce-duke
dukesphere Nov 12, 2024
6f21233
W-17017575-insights-hyperforce-duke
dukesphere Nov 12, 2024
4a273cf
W-17017575-insights-hyperforce-duke
dukesphere Nov 12, 2024
113b70c
W-17017575-insights-hyperforce-duke
dukesphere Nov 12, 2024
78f6744
Update modules/ROOT/pages/_partials/include-insights-charts.adoc
dukesphere Nov 12, 2024
657cac7
Apply suggestions from code review
dukesphere Nov 12, 2024
a7143cd
W-17017575-insights-hyperforce-duke
dukesphere Nov 12, 2024
b7d6101
W-17017575-insights-hyperforce-duke
dukesphere Nov 13, 2024
e542608
W-17017575-insights-hyperforce-duke
dukesphere Nov 13, 2024
2979d89
Merge branch 'latest' into W-17017575-insights-hyperforce-duke
dukesphere Nov 13, 2024
2a1ddff
W-17017575-insights-hyperforce-duke
dukesphere Nov 13, 2024
261a20c
W-17017575-insights-hyperforce-duke
dukesphere Nov 13, 2024
6629f1b
W-17017575-insights-hyperforce-duke
dukesphere Nov 13, 2024
539cf3a
W-17017575-insights-hyperforce-duke
dukesphere Nov 13, 2024
f3b60be
W-17017575-insights-hyperforce-duke
dukesphere Nov 14, 2024
d3cd1ed
W-17017575-insights-hyperforce-duke
dukesphere Nov 14, 2024
a3d7611
W-17017575-insights-hyperforce-duke
dukesphere Nov 14, 2024
4b5966e
W-17017575-insights-hyperforce-duke
dukesphere Nov 14, 2024
79e04b0
W-17017575-insights-hyperforce-duke
dukesphere Nov 14, 2024
435f008
W-17017575-insights-hyperforce-duke
dukesphere Nov 14, 2024
47a1370
W-17017575-insights-hyperforce-duke
dukesphere Nov 14, 2024
39d4d1b
W-17017575-insights-hyperforce-duke
dukesphere Nov 14, 2024
b302968
W-17017575-insights-hyperforce-duke
dukesphere Nov 14, 2024
d0d8943
W-17017575-insights-hyperforce-duke
dukesphere Nov 14, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified modules/ROOT/assets/image-source-files/insights.graffle
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified modules/ROOT/assets/images/insights.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
452 changes: 452 additions & 0 deletions modules/ROOT/pages/anypoint-insights.adoc

Large diffs are not rendered by default.

102 changes: 81 additions & 21 deletions modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
ifndef::env-site,env-github[]
include::_attributes.adoc[]
endif::[]
:useu-regions: (US and EU Regions)
:hyperforce-regions: (CA and JP Regions)
:all-regions: (All Regions)

Understanding the state of your infrastructure and systems is important for ensuring the reliability and stability of your services. As part of Anypoint Platform, Anypoint Monitoring provides visibility into integrations across your app network. The monitoring tools provide feedback from Mule flows and components in your app network.

Expand All @@ -12,9 +15,42 @@ Operations and development teams use the monitoring tools to diagnose issues and
of issues (MTTI).
* Store and search log data at scale.

== Dashboards
[[features]]
== Monitoring Features by Anypoint Platform Region

Use built-in dashboards or customize your own to provide instant visibility into your applications' performance and detailed analysis of your network.
Anypoint Monitoring is available multiple Anypoint Platform control plane regions.
include::partial$include-nav-entities.adoc[tags="region-data-not-shared"]

* https://anypoint.mulesoft.com/monitoring[US] and https://eu1.anypoint.mulesoft.com/monitoring[EU] regions:
** <<dashboards>>: Get metrics on individual deployments from charts in built-in and custom dashboards.
** <<alerts>>
** <<logging>>
** <<data-storage-retention>>
** <<functional-monitoring>>
dukesphere marked this conversation as resolved.
Show resolved Hide resolved
** <<insights>>: Built-in dashboards with metrics across and within Mule app and API deployments

* https://ca1.mulesoft.com/monitoring[Canada (CA)] and https://ja1.mulesoft.com/monitoring[Japan (JP)] regions:
** <<insights>>: Get metrics across and within Mule app and API deployments from charts in built-in dashboards.
** <<functional-monitoring>>

//TODO_TODO_TODO: WHAT ABOUT GOV CLOUD AND PCE?

Feature availability also depends on your <<billing, subscription package or plan>>.

//TODO_TODO_TODO: VERIFY LINK
For more information, see xref:hosting-home::index.adoc##control-plane-hosting-options[Control Plane Hosting Options].

[[insights]]
=== Anypoint Insights Dashboards

Monitor performance data and issues across your CloudHub 2.0 and Runtime Fabric deployments (_entities_), and get more detailed insights on specific deployments with built-in dashboards.

See xref:anypoint-insights.adoc[].

[[dashboards]]
=== Built-in and Custom Dashboards

Use built-in dashboards or customize your own to provide instant visibility into your apps' performance and detailed analysis of your network.

image::intro-dashboard-built-in.png[Built-in Dashboard Example]

Expand All @@ -26,17 +62,30 @@ You can track many data points and metrics from a custom dashboard that looks ac

See xref:dashboards-using.adoc[Dashboards].

== Event-Driven Alerts
[[alerts]]
=== Event-Driven Alerts

Track trends and add your own alerts to identify abnormal behavior and problems in your application network.
Track trends and add your own alerts to identify abnormal behavior and problems in your app network.

image::intro-alerts.png[Alerts]

You can trigger alerts based on rules (or thresholds) and policies for your resources. When these thresholds are crossed for a certain period of time, you can receive notification to take action. The method of notification depends on the severity of the alert that you define.

See xref:alerts.adoc[Alerts].

== Logging System
[[logging]]
=== Log Management

Manage logs and log data for your deployments with these logging features:

* <<log-search>>
* <<data-storage-retention>>
* <<raw-data-downloads>>

include::

[[log-search]]
==== Log Search
Copy link
Contributor Author

Choose a reason for hiding this comment

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

TODO: @dukesphere add note to starter/adv that link to Log Search in RTM only from us/eu

Copy link
Contributor Author

Choose a reason for hiding this comment

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

added to partial in reuse

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done


Search across log files, including archived logs to find information and events based on a specific query.

Expand All @@ -48,34 +97,40 @@ The log aggregator system holds raw operational data and records events that occ

See xref:logs.adoc[Logs].

[data_storage_retention]
== Data Storage and Retention
//TODO_TODO_TODO: IS THIS CORRECT?
[[data-storage-retention]]
==== Data Storage and Retention

Limits on data storage and retention are determined by your pricing plan. All organizations receive Anypoint Monitoring regardless of pricing plan.
Data storage and retention limits are determined by your pricing plan.
include::reuse::partial$billing/pricing.adoc[tag=featureAdvLimits]

include::reuse::partial$billing/pricing.adoc[tag=dataRetentionMonitoring]

For complete details about pricing, contact your customer support representative. See also https://www.mulesoft.com/anypoint-pricing[Anypoint Platform pricing].

== Raw Data Downloads
//TODO_TODO_TODO: IS THIS CORRECT?
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Suggested change
//TODO_TODO_TODO: IS THIS CORRECT?
//TODO_TODO_TODO: IS THIS CORRECT?

ask Rohit

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done, slight tweak

[[raw-data-downloads]]
==== Raw Data Downloads

You can download warehoused log data on a Mule app, for example, to help investigate security, compliance, or other issues that logs can reveal.
Download warehoused log data on a Mule app, for example, to help investigate security, compliance, or other issues that logs can reveal.

See xref:raw-data.adoc[Raw Data].

== Tools for Monitoring Integrations
=== Tools for Monitoring Integrations

You can link to connectors that help deliver Anypoint Monitoring notifications to external systems, including custom metrics connectors.
In https://anypoint.mulesoft.com/monitoring[US] and https://eu1.anypoint.mulesoft.com/monitoring[EU] regions, link to connectors that help deliver Anypoint Monitoring notifications to external systems, including custom metrics connectors.

See xref:tools.adoc[Tools].

== API Functional Monitoring
//TODO_TODO_TODO: VERIFY ALL REGIONS
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Suggested change
//TODO_TODO_TODO: VERIFY ALL REGIONS
//TODO_TODO_TODO: VERIFY ALL REGIONS

not sure if all regions support API Functional Monitoring

Copy link
Contributor Author

Choose a reason for hiding this comment

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

not clear gc and pce: Rohit
TODO

[[functional-monitoring]]
=== API Functional Monitoring

Monitor APIs and endpoints at scheduled intervals. Receive reports about whether tests pass or fail, and view statistics about API and endpoint performance.

See xref:api-functional-monitoring::afm-in-anypoint-platform.adoc[API Functional Monitoring in Anypoint Monitoring].

[[billing]]
== Anypoint Monitoring Packages and Plans

Anypoint Monitoring packages and plans are available:
Expand All @@ -86,7 +141,12 @@ Anypoint Monitoring packages and plans are available:
[[plans-usage-based]]
=== Anypoint Monitoring Features for Usage-Based Packages

Anypoint Monitoring is the standard method of monitoring Mule application and API performance so that you can more quickly identify and resolve issues. All organizations receive fundamental monitoring regardless of pricing model. However, organizations that have the Anypoint Integration Advanced package receive greater storage, guaranteed resources, and advanced capabilities that allow for greater control and flexibility.
Anypoint Monitoring is the standard method of monitoring Mule app and API performance so that you can more quickly identify and resolve issues.

* *Anypoint Integration Starter* package is available to all Anypoint Platform regions.
* *Anypoint Integration Advanced* package is available in the https://anypoint.mulesoft.com/monitoring[US] and https://eu1.anypoint.mulesoft.com/monitoring[EU] regions only at this time.

All organizations receive fundamental monitoring regardless of pricing model. However, organizations that have the Anypoint Integration Advanced package receive greater storage, guaranteed resources, and advanced capabilities that allow for greater control and flexibility.

If your organization changes its subscription model from the Anypoint Advanced Integration package to the Anypoint Integration Starter package, ensure you have preserved your logs outside of Anypoint Platform. Within an hour of changing pricing models, MuleSoft clears the storage that formerly kept log data.

Expand All @@ -95,7 +155,7 @@ include::reuse::partial$billing/pricing.adoc[tag=monitoringTable]
[[plans-legacy]]
=== Anypoint Monitoring Features for Legacy Subscription-Based Plans

Anypoint Monitoring is the standard method of monitoring Mule application and API performance so that you can more quickly identify and resolve issues. All organizations receive fundamental monitoring capabilities with their subscriptions. However, customers subscribing at the Titanium tier receive greater storage, guaranteed resources, and advanced capabilities that allow for greater control and flexibility.
Anypoint Monitoring is the standard method of monitoring Mule app and API performance so that you can more quickly identify and resolve issues. All organizations receive fundamental monitoring capabilities with their subscriptions. However, customers subscribing at the Titanium tier receive greater storage, guaranteed resources, and advanced capabilities that allow for greater control and flexibility.

If your organization changes its subscription model from a Titanium to a Gold or Platinum subscription, ensure you have preserved your logs outside of Anypoint Platform. Within an hour of changing subscription models, MuleSoft clears the storage that formerly kept log data.

Expand All @@ -117,7 +177,7 @@ If your organization changes its subscription model from a Titanium to a Gold or
|No
|Yes

4+| *Built-in Application Dashboards*
4+| *Built-in App Dashboards*
|More than 80 out-of-the-box charts covering metrics in the following categories: Overview, Inbound, Outbound, Performance, Failures, JVM, and Infrastructure

|Yes
Expand All @@ -139,7 +199,7 @@ If your organization changes its subscription model from a Titanium to a Gold or
|No
|Yes

|Anypoint Visualizer application network integration
|Anypoint Visualizer app network integration
|No
|No
|Yes
Expand Down Expand Up @@ -231,18 +291,18 @@ If your organization changes its subscription model from a Titanium to a Gold or

|===

NOTE: Anypoint Visualizer application network integration refers to an Anypoint Visualizer widget within Anypoint Monitoring. Anypoint Visualizer as a product outside of Anypoint Monitoring is available to organizations regardless of pricing plan.
NOTE: Anypoint Visualizer app network integration refers to an Anypoint Visualizer widget within Anypoint Monitoring. Anypoint Visualizer as a product outside of Anypoint Monitoring is available to organizations regardless of pricing plan.


== Use Cases

The following use cases provide examples of how you can use Anypoint Monitoring.

* Understand performance-related KPIs +
DevOps engineer Gary maintains a series of APIs related to a transaction processing system. Because the TPS requires swift response time, Gary uses API response time dashboards and alerts to send an email when there is a bottleneck. After gathering some data, Gary can then size his applications.
DevOps engineer Gary maintains a series of APIs related to a transaction processing system. Because the TPS requires swift response time, Gary uses API response time dashboards and alerts to send an email when there is a bottleneck. After gathering some data, Gary can then size his apps.

* Plan resource allocation across the application network +
IT specialist Peyton uses Anypoint Visualizer to view their application network. For CloudHub and Anypoint Runtime Fabric applications, Peyton sees CPU and memory utilization and idle capacity using integrated Anypoint Monitoring.
* Plan resource allocation across the app network +
IT specialist Peyton uses Anypoint Visualizer to view their app network. For CloudHub and Anypoint Runtime Fabric apps, Peyton sees CPU and memory utilization and idle capacity using integrated Anypoint Monitoring.

* Pinpoint root causes of issues +
Support team member Darius receives a call that the system is running slowly. He examines dashboards and checks response times, failed requests, and so on. He identifies that the backend is not scaling for the number of requests; he can add capacity for Mule apps, or he can throttle requests for other backend issues.
Expand Down