Dashboard Configuration Reference

Anypoint Monitoring provides many predefined values and identifiers for your configurations.

Date and Time Field Values

Many fields accept time and date interval values in the following format:

Date and Time Fields

w

Week, for example: 1w

d

Day, for example: 1d

h

Hour, for example: 1h

m

Minute, for example: 1m

s

Second, for example: 1s

ms

Millisecond, for example: 1ms

Metrics Available to Graphs

Many basic and advanced metrics are available when configuring custom dashboard graphs.

Basic Mode Metrics for Applications

Use the following Mule runtime engine versions with Anypoint Monitoring:

  • Mule 3 versions 3.8.7 and later
    Versions 3.8.6 and earlier are not supported. Additionally, all runtime versions that have the -AM suffix are deprecated.

  • Mule 4
    To use enhanced metrics for API Analytics, use Mule runtime engine version 4.1.6 or later.

Basic Metrics Unit

Inbound - Average Request Count by Endpoint

short

Inbound - Average Request Count by Flow

short

Inbound - Average Response Count by Endpoint

short

Inbound - Average Response Count by Flow

short

Inbound - Failure Average Request Count by Endpoint

short

Inbound - Failure Average Request Count by Flow

short

Inbound - Failure Average Response Time by Endpoint

ms

Inbound - Failure Average Response Time by Flow

ms

Inbound - Success Average Request Count by Endpoint

short

Inbound - Success Average Request Count by Flow

short

Inbound - Success Average Response Time by Endpoint

ms

Inbound - Success Average Response Time by Flow

ms

JVM - CPU % Utilization

percent

JVM - CPU Load Average

percent

JVM - Classes Loaded

short

JVM - Classes Loaded Total

short

JVM - Classes Unloaded

short

JVM - Code Cache Committed

bytes

JVM - Code Cache Init

bytes

JVM - Code Cache Max

bytes

JVM - Code Cache Used

bytes

JVM - Compressed Class Space Committed

bytes

JVM - Compressed Class Space Total

bytes

JVM - Compressed Class Space Used

bytes

JVM - Garbage Collection Count

short

JVM - Garbage Collection Time

ms

JVM - Heap Committed

bytes

JVM - Heap Used

bytes

JVM - JVM Uptime

ms

JVM - Memory Utilization

bytes

JVM - Metaspace Committed

bytes

JVM - Metaspace Init

bytes

JVM - Metaspace Max

bytes

JVM - Metaspace Used

bytes

JVM - Par Eden Committed

bytes

JVM - Par Eden Init

bytes

JVM - Par Eden Max

bytes

JVM - Par Eden Used

bytes

JVM - Par New Collection Count

short

JVM - Par New Collection Time

ms

JVM - Par Survivor Committed

bytes

JVM - Par Survivor Init

bytes

JVM - Par Survivor Max

bytes

JVM - Par Survivor Used

bytes

JVM - Tenured Gen Committed

bytes

JVM - Tenured Gen Init

bytes

JVM - Tenured Gen Max

bytes

JVM - Tenured Gen Used

bytes

JVM - Thread count - Server

short

JVM - Total System Memory

bytes

JVM - Total System Processors

short

Outbound - Average Request Count by Endpoint

short

Outbound - Average Request Count by Flow

short

Outbound - Average Response Time by Endpoint

ms

Outbound - Average Response Time by Flow

ms

Outbound - Failure Average Request Count by Endpoint

short

Outbound - Failure Average Request Count by Flow

short

Outbound - Failure Average Response Time by Endpoint

ms

Outbound - Failure Average Response Time by Flow

ms

Outbound - Success Average Request Count by Endpoint

short

Outbound - Success Average Request Count by Flow

short

Outbound - Success Average Response Time by Endpoint

ms

Outbound - Success Average Response Time by Flow

ms

Basic Mode Metrics for APIs

These metrics are available when you use basic mode for APIs using the API Panel setting:

Basic Metrics Unit

Average Response Time by Instance

ms

Failed Requests by Instance

short

Failures by Method

short

Failures by Path

short

Failures by Response Code

short

Policy Violations by Instance

short

Policy Violations by Outcome

short

Policy Violations by Path

short

Policy Violations by Violation ID

short

Requests Volume by Instance

short

Requests by Client ID

short

Requests by Client IP

short

Requests by Method

short

Requests by Path

short

Requests by Performance

ms

Requests by Response Code

short

Slow Requests

ms

These metrics are available if you use basic mode for APIs using the API Analytics Panel setting (deprecated):

Basic Metrics Unit

Requests by HTTP Policy Violation

short

Requests by HTTP Respond Code

short

Requests by Method

short

Requests by Instance

short

Advanced Mode Metrics for Applications

These metrics are available when you use Advanced mode for apps:

Table 1. Advanced Metrics for Apps
Metric Key (From clause) Available Field Values (Select clause)

Application Inbound Metrics

app_inbound_metric

  • avg_request_count

  • avg_response_count

Application Outbound Metrics

app_outbound_metric

  • avg_request_count

  • avg_response_count

Disk Statistics

disk_stats

  • disk_used

  • disk_free

JVM ClassLoader

jvm.classloading

  • classes_loaded

  • classes_loaded_total

  • classes_unloaded

JVM CPU

jvm.cpu.operatingsystem

  • available_processors

  • cpu

  • load_average

  • total_physical_memory_size

JVM Garbage Collection

jvm.garbagecollector.marksweepcompact

  • gc_marksweep_collection_count

  • gc_marksweep_collection_time

JVM Garbage Collection

jvm.garbagecollector.parnew

  • gc_par_new_collection_count

  • gc_par_new_collection_time

  • gc_parnew_collection_count

  • gc_parnew_collection_time

JVM Heap Total Memory

jvm.memory

  • heap_committed

  • heap_total

  • heap_used

JVM Memory “Code Cache”

jvm.memory.code_cache

  • committed_memory

  • init_memory

  • max_memory

  • used_memory

JVM Memory Compressed

jvm.memory.compressed_class_space

  • committed_memory

  • init_memory

  • max_memory

  • used_memory

JVM Memory Pool “Tenured Generation”

jvm.memory.metaspace

  • committed_memory

  • init_memory

  • max_memory

  • used_memory

JVM Memory “Eden Space”

jvm.memory.par_eden_space

  • par_eden_committed

  • par_eden_total

  • par_eden_used

JVM Memory “Survivor Space”

jvm.memory.par_survivor_space

  • par_survivor_committed

  • par_survivor_total

  • par_survivor_used

JVM Memory “Tenured Generation”

jvm.memory.tenured_gen

  • committed_memory

  • init_memory

  • max_memory

  • used_memory

JVM Runtime

jvm.runtime

  • jvm_uptime

JVM Thread Count

jvm.threading

  • thread_count

Operating System

operatingsystem

  • cpu_steal_time

  • cpu_io_wait

HTTP Summary
NOTE: This metric is available for APIs only.

http_summary_metric

  • request_count

  • request_size_average

  • request_size_max

  • request_size_min

  • request_size_sum

  • response_size_average

  • response_size_max

  • response_size_min

  • response_size_sum

  • response_time_average

  • response_time_max

  • response_time_min

  • response_time_sum

Mule Message Count

app_stats

  • messageCount

Advanced Mode Metrics for APIs

These metrics are available if you use advanced mode for APIs using the API Panel setting:

Table 2. Advanced Metrics for APIs
Metric Key (From clause) Available Field Values (Select clause)

API Client IP

api_client_ip_metric

  • request_size.count

API Path

api_path_metric

  • request_size.count

  • response_time.sum

API Summary

api_summary_metric

  • request_size.count

  • response_time.sum

Markdown Syntax Support

Some Anypoint Monitoring fields, such as text graph fields in a custom dashboard, accept Markdown. Markdown is a lightweight syntax for styling all forms of writing. For information about the Markdown syntax, see Markdown.

HTML Support

Some Anypoint Monitoring fields, such as Text graph fields in a custom dashboard, accept HTML elements (or tags).

HTML Titles

Titles
<h1>Title 1</h1>
<h2>Title 2</h2>
<h3>Title 3</h3>

HTML Emphasis

HTML Emphasis Example
<i>This text will be italic</i><br>
<em>This will also be italic</em><br>

<b>This text will be bold</b><br>
<strong>This will also be bold</strong><br>
<br>
<em>You <b>can</b> combine them</em><br>

HTML Lists

Unordered List Example
<ul>
<li>Item 1</li>
<li>Item 2 is <b>bold</b></li>
  <ul>
      <li>Item 2a</li>
      <li>Item 2b</li>
  </ul>
</ul>
Ordered List Example
<ol type="1">
<li>Item 1</li>
<li>Item 2</li>
<li>Item 3</li>
  <ol>
    <li>Item 3a</li>
    <li>Item 3b</li>
   </ol>
</ol>

Images

Image Example
<img src="https://www.mycompany.com/content/dam/usa/logo/m_logo.png" alt="MyCompany's Logo" height="50" width="50">
Link Example
<a href="https://www.mycompany.com/us/en-us.html">Visit mycompany.com!</a>

Blockquotes

Blockquote Example
As John F. Kennedy said:

<blockquote>
  And so, my fellow Americans, ask not what your
  country can do for you -- ask what you can do
  for your country.
</blockquote>

Code and Preformatted Text

  • Code: <code>A piece of computer code</code>

  • Preformatted text:

    Pre Tag Example
    <pre>
    Text in a pre element
    is displayed in a fixed-width
    font, and it preserves
    both      spaces and
    line breaks
    </pre>

Tables

Table Example
<table style="width:100%">
  <tr>
    <th>Firstname</th>
    <th>Lastname</th>
    <th>Age</th>
  </tr>
  <tr>
    <td>Jill</td>
    <td>Smith</td>
    <td>50</td>
  </tr>
  <tr>
    <td>Eve</td>
    <td>Jackson</td>
    <td>94</td>
  </tr>
</table>

Strikethrough

Strike Examples
<p> You can use the <strike>strike tag</strike>.</p>

<p>You can also use <del> (<del>del</del>) and <s> (<s>s</s>).</p>

HTML Style Attribute

Style Attribute Examples
<h1 style="color:blue; text-align:center;">A heading</h1>

<h2 style="font-family:verdana; color:red">A heading</h2>

<p style="font-family:courier; color:green; font-size:300%;">A paragraph.</p>

Embedded Styling

It is possible to render the entire HTML page with embedded styling.

Style Tag Example
<!DOCTYPE html>
<html>
<head>
<style>
ul {
    list-style-type: none;
    margin: 0;
    padding: 0;
    overflow: hidden;
    background-color: #333333;
}

li {
    float: left;
}

li a {
    display: block;
    color: white;
    text-align: center;
    padding: 16px;
    text-decoration: none;
}

li a:hover {
    background-color: #111111;
}
</style>
</head>
<body>

<ul>
  <li><a href="#home">Home</a></li>
  <li><a href="#news">News</a></li>
  <li><a href="#contact">Contact</a></li>
  <li><a href="#about">About</a></li>
</ul>

</body>
</html>
<hr/>
<p>&copy; 2004 Foo Corporation</p>

Note that you can use HTML entities like &copy; for copyright.

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub
Give us your feedback!
We want to build the best documentation experience for you!
Help us improve with your feedback.
Take the survey!