Skip to content

anypoint-insights.adoc

Latest commit

 

History

History
620 lines (422 loc) · 25.2 KB

anypoint-insights.adoc

File metadata and controls

620 lines (422 loc) · 25.2 KB

Monitoring Metrics from Anypoint Insights

Monitor performance data and issues across your deployed Mule apps and API implementations (entities) with Anypoint Insights, in Anypoint Monitoring:

  • Check metrics across multiple Mule apps and API implementations.

    Get up to the last 7 days (Advanced package) or 24 hours (Starter package) of high-level metrics on requests, errors, and responses. Use filters to narrow your results. You can download most chart data to CSV or XSL.

  • Check metrics on individual Mule apps and API implementations.

    Get up to the last 30 days of metrics on latency, requests, responses, errors, Mule messages and the JVM for Mule apps, and for API implementations, data on policy violations, performance, and client apps. You can download most chart data to CSV or XSL.

partial$include-entities.adoc

Anypoint Insights UI

  1. Dashboard that provides an overview of metrics across of your deployed Mule apps and APIs

  2. Environment selector for your deployments (such as Sandbox or Production)

  3. Filters to narrow the data in charts

  4. Performance metrics and trends across your deployed Mule apps and APIs

  5. List of each Mule app and API that you can click to display detailed metrics on a specific app or API

  6. Selector for the time range covered by the charts

    This selector is available to all Insights dashboards.

  7. Selector for auto-refresh interval, displayed when auto-refresh is enabled

    This selector is available to all Insights dashboards.

Anypoint Insights uses Anypoint Monitoring Metrics API to query for data that appears in charts. Data aggregation and retention limits in Anypoint Insights are derived from the service that supports the Metrics API. For information about data collection intervals in Anypoint Insights charts, see Data Collection Intervals in Anypoint Monitoring Charts.

For Advanced and Titanium subscription tiers, Integration Intelligence is accessible from Anypoint Insights. See integration-intelligence.adoc to extend your MuleSoft telemetry data analysis beyond real-time monitoring.

Before You Begin

Required prerequisites:

  • An Anypoint Platform account in a control plane that supports Anypoint Insights:

  • A Mule app or API (Mule Gateway or Omni Gateway (formerly Flex Gateway) API) running on a supported version of Mule runtime engine (see release-notes::mule-runtime/mule-esb.adoc) and deployed to a supported target:

    • CloudHub 2.0

    • CloudHub

    • Hybrid

    • Runtime Fabric

  • For Canada Cloud and Japan Cloud:

    • Enable Mule runtime access to Anypoint Platform so that you can display entity metrics in Anypoint Monitoring.

      For guidance, see hyperforce::configure-mule-hyperforce.adoc.

    • For information about Runtime Fabric feature support in these clouds, see Features Supported on Hyperforce.

  • The Monitoring Viewer permission to Anypoint Monitoring and the permissions required for viewing apps and APIs (see monitoring::am-permissions.adoc)

Monitor Your Deployments

Monitor Mule apps and APIs within a selected business group and environment.

  1. Meet the prerequisites in Before You Begin. partial$include-nav-steps-no-permissions.adoc

  2. Open Anypoint Insights, and set your environment, such as Design, Production, or Sandbox.

    For guidance, see Change the Environment.

  3. To capture deployments for another business group you belong to in the Entities List, select the business group.

    For guidance, see Change the Business Group.

  4. Set the time period to capture in your charts.

    For guidance, see Filter Data by Time Period.

  5. Filter the deployment data to display in the charts, as needed, to focus on areas of interest.

    For guidance, see Filter Deployment Data.

  6. To get additional metrics for a specific app or API:

    1. Find and click its name in Entities List.

      Apps in the Started state and APIs in the Active state are listed.

    2. Click View Entity Metrics, for example:

      Overview of deployment metrics

    3. Review metrics in the charts for the entity, for example:

Filter Monitoring Data Across Deployments

You can narrow the data in Anypoint Insights charts by deployment details, such as the deployment type, and by time range.

Filter Deployment Data

Use one or more filters to narrow the data in your charts. The filters support operators = and IN. Multiple filter settings are allowed. For example, this filter returns Mule apps deployed to CloudHub 2.0:

entity_type = 'APP' deployment_type = 'CLOUDHUB2'

This table lists supported filters:

Filter Operators Description

deployment_type

=, IN

Filter by deployment target, such as CloudHub 2.0 (CLOUDHUB2) or Runtime Fabric (RTF), for example:

deployment_type IN ['CLOUDHUB2', 'RTF']

entity_type

=, IN

Filter by deployment type (APP or API), for example:

entity_type = 'APP'`

entity

=, IN

Filter by specific app or API deployments, for example:

entity IN ['99aea888-77de-6e06-5c55-d1234de56789', '09f99999-888d-7b77-6da5-bebd43210fc1']

IN captures exact matches to any comma-separated element in the array.

Filter Data by Time Period

Use the time-period selector (item 6 in the example) to show data points collected for a given time period (such as the last 15 minutes or the last 24 hours). Your setting applies across all data in Anypoint Insights overview, including items in the Entities List.

If you don’t see data on the page, check that the selected time range is correct.

Change the Environment

Charts in Anypoint Insights provide metrics on a specific environment (such as Production or Sandbox).

To change current or default environment:

  1. Open Anypoint Insights from Anypoint Monitoring.

  2. Set a new environment:

    • To select an environment without changing the default, use the environment selector in Anypoint Monitoring, for example:

      Environment selector in Anypoint Monitoring

    • To select a default environment:

      1. Click your profile icon (see item 2 in the example).

      2. Select the name of your profile to open Access Management Settings.

      3. In Settings, select an environment as the default environment to view for the selected business group in Anypoint Monitoring, for example:

        Default selector in Access Management

      4. Return to Anypoint Monitoring to check for the new business group setting.

Change the Business Group

Charts in Anypoint Insights display metrics for deployments in a specific business group. If you belong to more than one business group, you can change the selected group and the business group that Anypoint Monitoring selects by default.

Business group selection options

  1. Business-group selector

  2. User profile, for selecting defaults

To change the business-group setting:

  1. Open Anypoint Insights from Anypoint Monitoring.

  2. Set a new business group:

    • To select a business group without changing the default, use the business-group selector in Anypoint Insights.

    • To select a default business group:

      1. Click your profile icon (see item 2 in the example).

      2. Select the name of your profile to open Access Management Settings.

      3. In Access Management Settings, select a business group to use as the default, for example:

        Default selector in Access Management

      4. Return to Anypoint Monitoring to check for the new default setting.

Download Chart Data

After opening a set of charts in Anypoint Insights, you can download metrics from charts that provide a download menu in the chart.

  1. Click the (More menu) on a chart to open the download menu.

  2. Select the file format for your metrics:

    • Download as CSV

    • Download as XLS

Insights Chart Reference

Understand the monitoring data in Anypoint Insights charts:

Performance Metrics and Trends

Performance Metrics and Performance Trends provide insights across your entities:

Performance Metrics

Monitor high-level performance metrics across your entities. partial$include-entities.adoc

Total Entities

Total number of entities

Entities with Errors

Total number of entities that have received errors

  • For API implementations, this metric counts HTTP status codes that identify errors (for example, 404 or 502).

  • For Mule apps, this metric counts response codes that indicate an error (for example, FAILED).

Total Requests

Total number of requests to the listed entities

Error Rate

For entities with request errors, the percentage equal to the total number of request errors divided by the total number of requests

For example, assume that 1 out of 5 total requests to API A produces an error and that 2 requests out of 5 to App B produces an error. The error rate is 3/10, or 30%.

Performance Trends

Monitor high-level performance over time across your entities. partial$include-entities.adoc

Entities with Slow Response Times

Response times, in milliseconds, of the entities with the slowest response times

The metric uses percentile values for response times (calculated from highest to lowest times) to identify entities with the slowest responses. You can select p99 (default), p95, p90, or p75.

Error Volume

Number of errors received by the entities over time

  • For API implementations, this metric counts HTTP error codes (for example, 404 or 502).

  • For Mule apps, this metric counts error response codes (for example, FAILED).

Request Volume

Number requests over time for the entities

Entities List

Check key metrics on individual Mule apps and APIs (entity), and click an entity’s name to get detailed charts for the entity. partial$include-entities.adoc

partial$include-insights-charts.adoc Only entities with traffic in the selected period and business group appear in Entities List.

The list provides these metrics on entities:

Entity Name

Name of the entity

Entity Type

Type of entity, such as API or Application (Mule app)

Request Volume

Total number of requests to this entity

Response Time (p99)

Response time, in milliseconds, for the 99th percentile of requests to this entity

This response time is greater than 99% of all response times for this entity.

Error Rate

Percentage of requests to this entity that resulted in errors

Deployment Type

Deployment target of this entity, such as CloudHub 2.0 or Runtime Fabric

Application Details

Anypoint Monitoring provides details on individual Mule apps deployed to a supported target.

Anypoint Insights App Details UI

  1. Application Details page for an app in Anypoint Insights

  2. App associated with this details page and a dropdown for opening the detail page for another app or API in one of your environments

  3. Tabs containing charts and visualizations for different types of metrics on the app

  4. Navigation for switching to the traditional built-in dashboard for this app, and for managing the app in Runtime Manager

Get information on the charts and visualizations available for the app:

By default, the date period in dashboards with detailed metrics on specific entities matches the time period selected for cross-entity charts in the Anypoint Insights overview.

By default, the auto-refresh interval in dashboards with detailed metrics on specific entities matches the time period interval for cross-entity charts in the Anypoint Insights overview.

To compare Application Details charts and visualizations with those in the traditional built-in dashboards for the same app, see App Chart Mapping.

Mule Application Metrics

High-level metrics are available in Application Details dashboards for individual Mule apps.

Overview Metrics for a Mule Application

Charts with overview metrics are available in the Overview tab for a Mule app in Anypoint Insights.

Request Metrics for a Mule Application

Charts with request metrics are available in the Requests tab for a Mule app in Anypoint Insights.

Error Metrics for a Mule Application

Charts with error metrics are available in the Errors tab for a Mule app in Anypoint Insights.

Flow Metrics for a Mule Flow

Charts with error metrics are available in the Flows tab for a Mule app in Anypoint Insights.

Connector Metrics for a MuleSoft Connector

Charts with error metrics are available in the Connectors tab for a Mule app in Anypoint Insights.

JVM Metrics for a Mule Application

Charts with JVM metrics are available in the JVM tab for a Mule app in Anypoint Insights.

Custom Metrics for a Mule Application

Monitor apps that use your organization’s custom metrics for a Mule app. Adjust settings of the charts that use your custom metrics.

Custom dashboards in Anypoint Insights aren’t available at this time.

Before You Begin

Meet subscription tier and Mule runtime version requirements:

The Custom Metrics tab for an app appears in Anypoint Insights only if your organization has the Anypoint Integration Advanced package or a Titanium subscription to Anypoint Platform and the app you selected is running on a supported version of Mule.

Create Custom Metrics

To create custom metrics, use the Anypoint Custom Metrics Connector in your app flow to collect metrics for your business and operational needs. After you deploy your app, your defined custom metrics charts appear in this tab. For guidance using the Anypoint Custom Metrics Connector, see monitoring::anypoint-custom-metrics-connector.adoc.

Configure Custom Metrics Charts

To adjust the custom metrics settings of a Mule app chart in Anypoint Insights:

  1. From a Mule app listed in Anypoint Insights, click the Custom Metrics tab.

  2. Select a value these fields, and then click Apply to update the chart:

    • Aggregations values include:

      • None (Default) - Performs no data aggregation.

      • count - Displays the total number of items collected for the measurement.

      • distinct - Returns the unique values for the given measurement.

      • integral - Returns the area under the curve for subsequent values.

      • mean - Returns the arithmetic average of the specified measurement over a given interval of time.

      • median - Displays the middle value for the collected metrics.

      • mode - Displays the most frequent value in the metrics collected for the defined measurement.

      • sum - Displays the sum of all the values for the defined measurement.

    • Measurement: These options are determined by the measurement values you define in the Custom Metrics connector.

    • Dimensions: The choices in this list are determined by the values you define in the Custom Metrics connector.

Chart settings correspond to and reflect values available to Mule apps from built-in dashboards (in Built-in Dashboards) that have custom metrics. The Dimensions setting is named Group By in built-in dashboards. See Configure Charts with Custom Metrics in a Built-In Dashboard).

API Details

Anypoint Monitoring provides details on individual API implementations deployed to a supported target.

Anypoint Insights API Details UI

  1. API Details page for an API in Anypoint Insights

  2. API associated with this details page and a dropdown for opening the detail page for another API or app in one of your environments

  3. Tabs containing charts and visualizations for different types of metrics on the API

  4. Navigation for switching to the traditional built-in dashboard for this API from Anypoint Insights, and for managing the API in API Manager

Get information on the charts and visualizations available for the API:

By default, the date period in dashboards with detailed metrics on specific entities matches the time period selected for cross-entity charts in the Anypoint Insights overview.

By default, the auto-refresh interval in dashboards with detailed metrics on specific entities matches the time period interval for cross-entity charts in the Anypoint Insights overview.

To compare API Details charts and visualizations with those in the traditional built-in dashboards for the same API, see API Details in Anypoint Insights.

API Implementation Metrics

High-level metrics are available in API Details dashboards for individual API implementations.

Overview Metrics for an API Implementation

Charts with overview metrics are available in the Overview tab for each API implementation that you can monitor in Anypoint Insights.

Request Metrics for an API Implementation

Charts with request metrics are available in the Requests tab for each API implementation that you can monitor in Anypoint Insights.

Error Metrics for an API Implementation

Charts with error metrics are available in the Errors tab for each API implementation that you can monitor in Anypoint Insights.

Policy Metrics for an API Implementation

Charts with policy metrics are available in the Policies tab for each API implementation that you can monitor in Anypoint Insights.

Performance Metrics for an API Implementation

Charts with performance metrics are available in the Performance tab for each API implementation that you can monitor in Anypoint Insights.

Client Application Metrics for an API Implementation

Charts with client app metrics are available in the Client Applications tab for each API implementation that you can monitor in Anypoint Insights.

Data Collection Intervals in Anypoint Monitoring Charts

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.

Data Points in Anypoint Monitoring Charts

Anypoint Monitoring charts aggregate data into data points along a horizontal Time axis. If the time units for data in your charts are larger or smaller than you require, try narrowing or expanding the time range that your charts capture. Alternatively, you can use the Metrics API to aggregate data within the API’s limits.

partial$include-monitoring-metrics-collection.adoc

Metrics API

Anypoint Insights uses Anypoint Monitoring Metrics API to submit queries for data used in charts. You can use this API to query data for your needs.

Age-based data aggregation limits determine the minimum intervals available for retrieving metrics data:

  • Data less than or equal to 7 days old is available at a minimum of 1-minute intervals.

  • Data over 7 days old is available at a minimum of 5-minute intervals.

To use the API and get information about data retention, see the API documentation on Anypoint Exchange: Anypoint Monitoring Metrics API
⚡