diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index 2b9287f3..72cc74a0 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -8,7 +8,7 @@ ** xref:monitor-applications-on-rtf.adoc[Monitor Applications on Runtime Fabric] ** xref:am-installing.adoc[Monitor Hybrid Runtimes] ** xref:performance-and-impact.adoc[Anypoint Monitoring Performance, Impact, and Limits] -* xref:anypoint-insights.adoc[Anypoint Insights] +* xref:anypoint-insights.adoc[Monitor Apps and APIs Across Deployments] * xref:dashboards.adoc[About Dashboards] * xref:dashboards-using.adoc[Use Dashboards] ** xref:app-dashboards.adoc[Built-in Application Dashboards] diff --git a/modules/ROOT/pages/_partials/include-nav-entities.adoc b/modules/ROOT/pages/_partials/include-nav-entities.adoc index ea609ad3..d2a773f2 100644 --- a/modules/ROOT/pages/_partials/include-nav-entities.adoc +++ b/modules/ROOT/pages/_partials/include-nav-entities.adoc @@ -20,4 +20,4 @@ https://anypoint.mulesoft.com/monitoring[US] and https://eu1.anypoint.mulesoft.c // tag::region-data-not-shared[] Data is not shared across the separate regional instances of Anypoint Platform. // end::region-data-not-shared[] -// +// \ No newline at end of file diff --git a/modules/ROOT/pages/anypoint-insights.adoc b/modules/ROOT/pages/anypoint-insights.adoc index ceecdec6..d61d727e 100644 --- a/modules/ROOT/pages/anypoint-insights.adoc +++ b/modules/ROOT/pages/anypoint-insights.adoc @@ -1,45 +1,76 @@ -= Explore Entities with Anypoint Insights +//= Explore Entities with Anypoint Insights += Monitor Apps and APIs Across Deployments with Anypoint Insights +:page-notice-banner-message: Only Japan (JA) and Canada (CA) regions provide Anypoint Insights. No other Anypoint Monitoring features are offered in these regions at this time. -Anypoint Monitoring collects metrics on each _entity_ in Anypoint Platform, such as an app or API instance. The *Anypoint Insights* page enables you to: +Monitor performance data and issues across your CloudHub 2.0 and Runtime Fabric deployments (_entities_) with Anypoint Insights, in Anypoint Monitoring. - * View data for your apps and APIs at a glance. - * Review key metrics about the health of your entities. - * Identify and troubleshoot issues. - - You can filter the entities that appear on the *Anypoint Insights* page by using attributes and elements. While in Beta, you can view up to seven days of worth of data. To view less than seven days of data, specify a date and time range. +image::insights.png["Anypoint Insights UI"] -//REMOVED THIS: You can view up to 30 days of data at once, or you can specify dates and times to see only data from a shorter time period. +//TODO_TODO_TODO: 24 hours for now +Identify and troubleshoot up to 24 hours of data on your deployments with: -//Changed Entities Overview to Anypoint Insights (directed by Prakash) +* Aggregated metrics across your deployments. ++ +Monitor response times, error volume, and request volume. Use filters to narrow your results. +* Metrics on individual apps and APIs. ++ +Review requests, latency, errors, and JVM data. -include::partial$include-monitoring-metrics-collection.adoc[leveloffset=+1] +For data collection details, see <>. +[[prereqs]] == Before You Begin -Before getting started, ensure that you have: +Required prerequisites: -* An Anypoint Platform account that has the Monitoring Viewer permission and the permissions required for viewing apps and APIs. -* A supported version of Mule Runtime engine. +* An Anypoint Platform account in a region that supports Anypoint Insights -== Supported Versions of Mule Runtime Engine +** {empty} +include::partial$include-nav-entities.adoc[tags="anypoint-regions-hyperforce"] -include::partial$include-supported-mule-runtime-version.adoc[] +** {empty} +include::partial$include-nav-entities.adoc[tags="anypoint-regions-useu"] +(Beta release for Advanced and Titanium tier plans only at this time) -== Access the Anypoint Insights Page +* The *Monitoring Viewer* permission to Anypoint Monitoring and the permissions required for viewing apps and APIs. ++ +See xref:monitoring::am-permissions.adoc[] and xref:access-management::permissions-by-product.adoc[]. +* A supported version of Mule Runtime engine. ++ +See xref:release-notes::mule-runtime/mule-esb.adoc[]. -include::partial$include-nav-steps-no-permissions.adoc[] -include::partial$include-nav-entities.adoc[] +== Open Anypoint Insights -The *Anypoint Insights* page appears, showing a summary of data for entities in the active business group and in the selected environment configured in your profile. +//include::partial$include-nav-steps-no-permissions.adoc[] -== Search for Entities +. Meet the prerequisites in <>. +. Log in to your Anypoint Platform region that supports Anypoint Insights: ++ +include::partial$include-nav-entities.adoc[tags="supported-regions"] +//Nav step +include::partial$include-nav-entities.adoc[tags="open-insights"] ++ +*Anypoint Insights* provides separate sets of charts for your deployment environments, such as Design, Production, and Sandbox. You can view and filter chart data across your deployments within the selected environment, and you can open more detailed data on any deployment listed in the *Entities List*. -The search bar on the *Anypoint Insights* page enables you to create search parameters to curate different assortments of entity data on the page and to visualize and monitor the health status of multiple entities in their business groups and environments. You can add and remove attributes such as status, errors, and environments to further refine your results. Adding different search parameters changes data in the summary, metric cards, and charts, which is refreshed each time you conduct a new search. +== Filter Data in Aggregated Charts -//Each search filter requires three pieces of information: an attribute name (for example, `entity_type`), an operator (for example, `=` or `IN`) and a value. The auto-suggest feature is triggered by clicking inside the search box or by entering a space. When the attribute name, an operator, and a value are provided, the search component creates a filter that is visually represented as a data pill. You can edit a search filter by double-clicking on the appropriate data pill. After all modifications are completed, you can use the enter key to convert the text to a search pill again. You can click on the *X* icon on the pill to remove it. +Use one or more filters to narrow the parameters of aggregated charts by any of these criteria. The filters support operators such as `>` and `<=` for comparisons and `IN` for any matches to a list of items. -//this is from tech review but I really don't think it is needed. +Example for Mule applications deployed to CloudHub 2.0: `entity_type = 'APP' deployment_type = 'CLOUDHUB2'` + +* Deployment Type (`deployment_type`): For data on deployments to one or more hosts. Examples: `deployment_type IN ['CLOUDHUB2', 'RTF']`, `deployment_type = 'CLOUDHUB2'` +* Entity Type (`entity_type`): For data on one or more deployment types (such as, APP). Example: `entity_type = 'APP' ` +* Entity (`entity`): Identifies one or more Mule apps or APIs by their IDs. Example: `entity IN ['99aea888-77de-6e06-5c55-d1234de56789', '09f99999-888d-7b77-6da5-bebd43210fc1']` +* Entity Response Status (*entity_response_status*): ++ +Example: `entity_response_status = 'OK'` +* Request Counts (`request_counts`): Number of requests. ++ +Example: `COUNT(request_counts) < '40'` +* Response Time (`response_time`): Percentage of requests relative to a given response time. ++ +Example: `PERCENTILE(response_time, '0.95') < '2.00ms'` By default, the *Anypoint Insights* page shows data for entities from the default environment configured in your user profile. You can adjust your profile to see data for entities in one or more of your environments for the active business group to which you are logged in. @@ -47,16 +78,9 @@ By default, the *Anypoint Insights* page shows data for entities from the defaul //The search bar also offers quick filters, such as `Top 10 entities with highest error volume`, to show you common scenarios at a glance. You can also combine these with attributes and metrics to further specify the content that appears. -Curate your search results for entity data by using the following attributes: +: + -* Environment -* Entity Name -* Entity Type -* Entity ID -* Deployment Type -* Entity Response Status -* Request Counts -* Response Time When you provide multiple filters, the resulting data matches all of them. For example, the query to fetch the entities data would include an `AND` operator to combine all of the search filters. @@ -137,51 +161,30 @@ The list of entities that match your current search conditions in the selected d The following columns appear in the table: * *Entity Name*: Name of the entity. +//TODO_TODO_TODO: Mule Gateway APIs only or other API instance? * *Entity Type*: Type of the entity. The value in this column is either `API` or `Application`. * *Request Volume*: Total number of requests to the entity. * *P95 Latency*: P95 response time latency, calculated in milliseconds. * *Error Rate*: Percentage of requests to the entity that result in errors. * *Deployment Type*: Runtime environment in which the entity is deployed. -[[automatic-interval]] -== How Data is Aggregated in Intervals - -Anypoint Monitoring aggregates data in charts based on the selected time interval. The number of data points shown in a chart varies based on your selected time interval. - -//Em told by Sathish to remove the following stuff -//[[average-response-times-app]] -//== Charting Inactivity for Average Response Time - -//include::partial$average-response-time.adoc[] -//[[endpoint-operation-metrics]] -//== How Endpoint and Operation Use Metrics Are Gathered +[[data-collection]] +== Data Collection Intervals in Anypoint Monitoring Charts -//Anypoint Monitoring collects top occurring endpoints or operations for each data collection interval. Endpoints or operations that are not top occurring are sorted into a group called *Other*. +Anypoint Monitoring charts display data in configurable date-time ranges, which include the last 15 minutes, hour, week, a custom date-time range, and other periods. -//In each data collection interval, top occurring endpoints or operations vary. An endpoint or operation that is top occurring in one interval may not be top occurring in the next. - -//In Anypoint Monitoring charts and tables, the data comes from multiple data collection intervals. As a result, aggregated data shown in the dashboard is an estimation since the intervals may not have the same top occurring endpoints or operations. The tables show approximate counts for the most commonly occurring endpoints or operations when the *Other* grouping appears. - -//For example, when an endpoint occurs more often than other endpoints in one interval but occurs less often in another interval (thus sorting it into the *Other* group for that interval), the resulting table displays lower than actual values for that endpoint, since the metrics that do not appear are grouped into the *Other* group. - - -//// -== Collecting Metrics for Entities +* <> +* <> [[automatic-interval]] -=== How Data is Aggregated in Intervals - -include::partial$data-aggregation.adoc[] - -[[average-response-times-app]] -=== Charting Inactivity for Average Response Time +=== Data Points in Anypoint Monitoring Charts -include::partial$average-response-time.adoc[] +Anypoint Monitoring charts aggregate data into data points along a horizontal *Time* axis. Depending on the date-time range you select for a chart, each data point represents a minimum period of one minute to a maximum period of four hours. -[[endpoint-operation-metrics]] -=== Gathering Endpoint and Operation Use Metrics +For example, if a chart displays data collected in the last 15 minutes, the chart contains 15 data points, one for each minute of data collection. Each data point aggregates data collected during that minute. If a chart displays the past seven days of data, each data point aggregates data collected within each four-hour period of the last seven days. -include::partial$endpoint-operation-metrics.adoc[] +//include for How Anypoint Monitoring Collects Metrics +[[data-collection-intervals]] +include::partial$include-monitoring-metrics-collection.adoc[leveloffset=+2] -//// diff --git a/modules/ROOT/pages/index.adoc b/modules/ROOT/pages/index.adoc index 5c6fd18b..0a08dad7 100644 --- a/modules/ROOT/pages/index.adoc +++ b/modules/ROOT/pages/index.adoc @@ -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. @@ -12,9 +15,38 @@ 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 all Anypoint Platform 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: +** <>: Built-in and custom dashboards with metrics on individual deployments +** <> +** <> +** <> +** <> +** <>: 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: +** <>: Built-in dashboards with metrics across and within Mule app and API deployments +** <> + +//TODO_TODO_TODO: VERIFY LINK +For more information, see xref:hosting-home::index.adoc[]. + +[[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] @@ -26,9 +58,10 @@ 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] @@ -36,7 +69,19 @@ You can trigger alerts based on rules (or thresholds) and policies for your reso See xref:alerts.adoc[Alerts]. -== Logging System +[[logging]] +=== Log Management + +Manage logs and log data for your deployments with these logging features: + +* <> +* <> +* <> + +include:: + +[[log-search]] +==== Log Search Search across log files, including archived logs to find information and events based on a specific query. @@ -48,34 +93,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? +[[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 +[[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: @@ -86,7 +137,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. @@ -95,7 +151,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. @@ -117,7 +173,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 @@ -139,7 +195,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 @@ -231,7 +287,7 @@ 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 @@ -239,10 +295,10 @@ NOTE: Anypoint Visualizer application network integration refers to an Anypoint 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.