Google Git
Sign in
apache / james-site / a15da97d6f43d2450183d8ff4b8722aa4ad8b24d / . / james-distributed-app / 3.8.1 / operate / metrics.html
blob: c61736327c5c889d46a6c0ce3cf3415fc35a1b92 [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>Distributed James Server &mdash; Metrics :: Apache James</title>
<meta name="generator" content="Antora 3.1.2">
<link rel="stylesheet" href="../../../_/css/site.css">
</head>
<body class="article">
<header class="header">
<nav class="navbar">
<div class="navbar-brand">
<a class="navbar-item" href="https://james.apache.org"><img src="/_/img/james.svg" alt="james logo"> Apache James</a>
<button class="navbar-burger" data-target="topbar-nav">
<span></span>
<span></span>
<span></span>
</button>
</div>
<div id="topbar-nav" class="navbar-menu">
<div class="navbar-end">
<a class="navbar-item" href="#">Home</a>
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link" href="#">Products</a>
<div class="navbar-dropdown">
<div class="navbar-item"><strong>James server</strong></div>
<a class="navbar-item" href="https://github.com/apache/james-project">Repository</a>
<a class="navbar-item" href="https://issues.apache.org/jira/projects/JAMES/issues">Issue Tracker</a>
<hr class="navbar-divider">
<a class="navbar-item" href="https://james.apache.org/mime4j/index.html">Mime4J</a>
<a class="navbar-item" href="https://james.apache.org/jsieve/index.html">jSieve</a>
<a class="navbar-item" href="https://james.apache.org/jspf/index.html">jSPF</a>
<a class="navbar-item" href="https://james.apache.org/jdkim/index.html">jDKIM</a>
<a class="navbar-item" href="https://james.apache.org/hupa/index.html">HUPA</a>
</div>
</div>
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link" href="#">Community</a>
<div class="navbar-dropdown">
<!-- Not ideal but dropping the version in the href requires tweaking james-projet docs module first -->
<a class="navbar-item" href="/james-project/3.6.0/community/mailing-lists.html">Mailing lists</a>
<a class="navbar-item" href="https://gitter.im/apache/james-project"><svg version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 32 32" class="logo-gitter-sign" data-v-44ebcb1a=""><rect x="15" y="5" width="2" height="10"></rect> <rect x="10" y="5" width="2" height="20"></rect> <rect x="5" y="5" width="2" height="20"></rect> <rect width="2" height="15"></rect></svg> Gitter</a>
<a class="navbar-item" href="https://twitter.com/ApacheJames">
<span class="icon">
<svg aria-hidden="true" data-icon="twitter" role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512">
<path fill="#57aaee" d="M459.37 151.716c.325 4.548.325 9.097.325 13.645 0 138.72-105.583 298.558-298.558 298.558-59.452 0-114.68-17.219-161.137-47.106 8.447.974 16.568 1.299 25.34 1.299 49.055 0 94.213-16.568 130.274-44.832-46.132-.975-84.792-31.188-98.112-72.772 6.498.974 12.995 1.624 19.818 1.624 9.421 0 18.843-1.3 27.614-3.573-48.081-9.747-84.143-51.98-84.143-102.985v-1.299c13.969 7.797 30.214 12.67 47.431 13.319-28.264-18.843-46.781-51.005-46.781-87.391 0-19.492 5.197-37.36 14.294-52.954 51.655 63.675 129.3 105.258 216.365 109.807-1.624-7.797-2.599-15.918-2.599-24.04 0-57.828 46.782-104.934 104.934-104.934 30.213 0 57.502 12.67 76.67 33.137 23.715-4.548 46.456-13.32 66.599-25.34-7.798 24.366-24.366 44.833-46.132 57.827 21.117-2.273 41.584-8.122 60.426-16.243-14.292 20.791-32.161 39.308-52.628 54.253z"></path>
</svg>
</span> Twitter
</a>
<a class="navbar-item" href="#"> <svg class="octicon octicon-mark-github v-align-middle" viewBox="0 0 16 16" version="1.1" aria-hidden="true"><path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0016 8c0-4.42-3.58-8-8-8z"></path></svg> Github</a>
</div>
</div>
<!-- <div class="navbar-item">
<span class="control">
<a class="button is-primary" href="#">Download</a>
</span>
</div> -->
</div>
</div>
</nav>
</header>
<div class="body">
<div class="nav-container" data-component="james-distributed-app" data-version="3.8.1">
<aside class="nav">
<div class="panels">
<div class="nav-panel-menu is-active" data-panel="menu">
<nav class="nav-menu">
<button class="nav-menu-toggle" aria-label="Toggle expand/collapse all" style="display: none"></button>
<h3 class="title"><a href="../index.html">Apache James Distributed Server</a></h3>
<ul class="nav-list">
<li class="nav-item" data-depth="0">
<ul class="nav-list">
<li class="nav-item" data-depth="1">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../index.html">Distributed James Application</a>
<ul class="nav-list">
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../objectives.html">Objectives and motivation</a>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../architecture/index.html">Architecture</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../architecture/implemented-standards.html">Implemented standards</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../architecture/consistency-model.html">Consistency Model</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../architecture/specialized-instances.html">Specialized instances</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../run/index.html">Run</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../run/run-java.html">Run with Java</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../run/run-docker.html">Run with Docker</a>
</li>
<li class="nav-item" data-depth="3">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../run/run-kubernetes.html">Run with Kubernetes</a>
<ul class="nav-list">
<li class="nav-item" data-depth="4">
<a class="nav-link" href="../run/k8s-checklist.html">Deployment Checklist</a>
</li>
<li class="nav-item" data-depth="4">
<a class="nav-link" href="../run/k8s-logsMetrics.html">Logs &amp; Metrics</a>
</li>
<li class="nav-item" data-depth="4">
<a class="nav-link" href="../run/k8s-values.html">values.yaml</a>
</li>
<li class="nav-item" data-depth="4">
<a class="nav-link" href="../run/k8s-secrets.html">secrets.yaml</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../configure/index.html">Configuration</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<button class="nav-item-toggle"></button>
<span class="nav-text">Protocols</span>
<ul class="nav-list">
<li class="nav-item" data-depth="4">
<a class="nav-link" href="../configure/imap.html">imapserver.xml</a>
</li>
<li class="nav-item" data-depth="4">
<a class="nav-link" href="../configure/jmap.html">jmap.properties</a>
</li>
<li class="nav-item" data-depth="4">
<a class="nav-link" href="../configure/jmx.html">jmx.properties</a>
</li>
<li class="nav-item" data-depth="4">
<a class="nav-link" href="../configure/smtp.html">smtpserver.xml &amp; lmtpserver.xml</a>
</li>
<li class="nav-item" data-depth="4">
<a class="nav-link" href="../configure/smtp-hooks.html">Packaged SMTP hooks</a>
</li>
<li class="nav-item" data-depth="4">
<a class="nav-link" href="../configure/pop3.html">pop3server.xml</a>
</li>
<li class="nav-item" data-depth="4">
<a class="nav-link" href="../configure/webadmin.html">webadmin.properties</a>
</li>
<li class="nav-item" data-depth="4">
<a class="nav-link" href="../configure/ssl.html">SSL &amp; TLS</a>
</li>
<li class="nav-item" data-depth="4">
<a class="nav-link" href="../configure/sieve.html">Sieve &amp; ManageSieve</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="3">
<button class="nav-item-toggle"></button>
<span class="nav-text">Storage dependencies</span>
<ul class="nav-list">
<li class="nav-item" data-depth="4">
<a class="nav-link" href="../configure/blobstore.html">blobstore.properties</a>
</li>
<li class="nav-item" data-depth="4">
<a class="nav-link" href="../configure/cassandra.html">cassandra.properties</a>
</li>
<li class="nav-item" data-depth="4">
<a class="nav-link" href="../configure/opensearch.html">opensearch.properties</a>
</li>
<li class="nav-item" data-depth="4">
<a class="nav-link" href="../configure/rabbitmq.html">rabbitmq.properties</a>
</li>
<li class="nav-item" data-depth="4">
<a class="nav-link" href="../configure/redis.html">redis.properties</a>
</li>
<li class="nav-item" data-depth="4">
<a class="nav-link" href="../configure/tika.html">tika.properties</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="3">
<button class="nav-item-toggle"></button>
<span class="nav-text">Core components</span>
<ul class="nav-list">
<li class="nav-item" data-depth="4">
<a class="nav-link" href="../configure/batchsizes.html">batchsizes.properties</a>
</li>
<li class="nav-item" data-depth="4">
<a class="nav-link" href="../configure/dns.html">dnsservice.xml</a>
</li>
<li class="nav-item" data-depth="4">
<a class="nav-link" href="../configure/domainlist.html">domainlist.xml</a>
</li>
<li class="nav-item" data-depth="4">
<a class="nav-link" href="../configure/healthcheck.html">healthcheck.properties</a>
</li>
<li class="nav-item" data-depth="4">
<a class="nav-link" href="../configure/mailetcontainer.html">mailetcontainer.xml</a>
</li>
<li class="nav-item" data-depth="4">
<a class="nav-link" href="../configure/mailets.html">Packaged Mailets</a>
</li>
<li class="nav-item" data-depth="4">
<a class="nav-link" href="../configure/matchers.html">Packaged Matchers</a>
</li>
<li class="nav-item" data-depth="4">
<a class="nav-link" href="../configure/mailrepositorystore.html">mailrepositorystore.xml</a>
</li>
<li class="nav-item" data-depth="4">
<a class="nav-link" href="../configure/recipientrewritetable.html">recipientrewritetable.xml</a>
</li>
<li class="nav-item" data-depth="4">
<a class="nav-link" href="../configure/search.html">search.properties</a>
</li>
<li class="nav-item" data-depth="4">
<a class="nav-link" href="../configure/usersrepository.html">usersrepository.xml</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="3">
<button class="nav-item-toggle"></button>
<span class="nav-text">Extensions</span>
<ul class="nav-list">
<li class="nav-item" data-depth="4">
<a class="nav-link" href="../configure/vault.html">deletedMessageVault.properties</a>
</li>
<li class="nav-item" data-depth="4">
<a class="nav-link" href="../configure/extensions.html">extensions.properties</a>
</li>
<li class="nav-item" data-depth="4">
<a class="nav-link" href="../configure/listeners.html">listeners.xml</a>
</li>
<li class="nav-item" data-depth="4">
<a class="nav-link" href="../configure/spam.html">Anti-Spam setup</a>
</li>
<li class="nav-item" data-depth="4">
<a class="nav-link" href="../configure/remote-delivery-error-handling.html">About RemoteDelivery error handling</a>
</li>
<li class="nav-item" data-depth="4">
<a class="nav-link" href="../configure/collecting-contacts.html">Contact collection</a>
</li>
<li class="nav-item" data-depth="4">
<a class="nav-link" href="../configure/collecting-events.html">Event collection</a>
</li>
<li class="nav-item" data-depth="4">
<a class="nav-link" href="../configure/dsn.html">ESMTP DSN support</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="index.html">Operate</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="guide.html">Operator guide</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="performanceChecklist.html">Performance checklist</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="logging.html">Logging</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="webadmin.html">WebAdmin REST administration API</a>
</li>
<li class="nav-item is-current-page" data-depth="3">
<a class="nav-link" href="metrics.html">Metrics</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="migrating.html">Migrating existing data</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="cli.html">Command Line Interface</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="cassandra-migration.html">Cassandra migration</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="security.html">Security checklist</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../extending/index.html">Extending server behavior</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../extending/mail-processing.html">Custom mail processing components</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../extending/mailbox-listeners.html">Custom Mailbox Listeners</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../extending/smtp-hooks.html">Custom SMTP hooks</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../extending/webadmin-routes.html">Custom WebAdmin routes</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../extending/imap.html">Custom IMAP processing</a>
</li>
</ul>
</li>
<li class="nav-item" data-depth="2">
<button class="nav-item-toggle"></button>
<a class="nav-link" href="../benchmark/index.html">Performance benchmark</a>
<ul class="nav-list">
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../benchmark/db-benchmark.html">Database benchmarks</a>
</li>
<li class="nav-item" data-depth="3">
<a class="nav-link" href="../benchmark/james-benchmark.html">James benchmarks</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</nav>
</div>
<div class="nav-panel-explore" data-panel="explore">
<div class="context">
<span class="title">Apache James Distributed Server</span>
<span class="version">3.8.1 SNAPSHOT</span>
</div>
<ul class="components">
<li class="component is-current">
<div class="title"><a href="../index.html">Apache James Distributed Server</a></div>
<ul class="versions">
<li class="version is-current is-latest">
<a href="../index.html">3.8.1 SNAPSHOT</a>
</li>
</ul>
</li>
<li class="component">
<div class="title"><a href="../../../james-project/3.8.1/index.html">Apache James Server</a></div>
<ul class="versions">
<li class="version is-latest">
<a href="../../../james-project/3.8.1/index.html">3.8.1 SNAPSHOT</a>
</li>
<li class="version">
<a href="../../../james-project/3.6.0/index.html">3.6.0 Snapshot</a>
</li>
</ul>
</li>
<li class="component">
<div class="title"><a href="../../../james-site/latest/index.html">Apache James Site</a></div>
<ul class="versions">
<li class="version is-latest">
<a href="../../../james-site/latest/index.html">latest</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
</aside>
</div>
<main class="article">
<div class="toolbar" role="navigation">
<button class="nav-toggle"></button>
<a href="../../../james-site/latest/homepage.html" class="home-link"></a>
<nav class="breadcrumbs" aria-label="breadcrumbs">
<ul>
<li><a href="../index.html">Apache James Distributed Server</a></li>
<li><a href="../index.html">Distributed James Application</a></li>
<li><a href="index.html">Operate</a></li>
<li><a href="metrics.html">Metrics</a></li>
</ul>
</nav>
<div class="edit-this-page"><a href="https://github.com/apache/james-project/blob/master/server/apps/distributed-app/docs/modules/ROOT/pages/operate/metrics.adoc">Edit this Page</a></div>
</div>
<div class="content">
<aside class="toc sidebar" data-title="Contents" data-levels="2">
<div class="toc-menu"></div>
</aside>
<article class="doc">
<h1 class="page">Distributed James Server &mdash; Metrics</h1>
<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p>James relies on the <a href="https://metrics.dropwizard.io/4.1.2/manual/core.html">Dropwizard metric library</a>
for keeping track of some core metrics of James.</p>
</div>
<div class="paragraph">
<p>Such metrics are made available via JMX. You can connect for instance using VisualVM and the associated
mbean plugins.</p>
</div>
<div class="paragraph">
<p>We also support displaying them via <a href="https://grafana.com/">Grafana</a>. Two methods can be used to back grafana display:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>Prometheus metric collection - Data are exposed on a HTTP endpoint for Prometheus scrape.</p>
</li>
<li>
<p>ElasticSearch metric collection - This method is depreciated and will be removed in next version.</p>
</li>
</ul>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_expose_metrics_for_prometheus_collection"><a class="anchor" href="#_expose_metrics_for_prometheus_collection"></a>Expose metrics for Prometheus collection</h2>
<div class="sectionbody">
<div class="paragraph">
<p>To enable James metrics, add <code>extensions.routes</code> to <a href="https://github.com/apache/james-project/blob/master/server/apps/distributed-app/docs/modules/ROOT/pages/configure/webadmin.adoc">webadmin.properties</a> file:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-none hljs">extensions.routes=org.apache.james.webadmin.dropwizard.MetricsRoutes</code></pre>
</div>
</div>
<div class="paragraph">
<p>Connect to james-admin url to test the result:</p>
</div>
<div class="literalblock">
<div class="content">
<pre>http://james-admin-url/metrics</pre>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_configure_prometheus_data_source"><a class="anchor" href="#_configure_prometheus_data_source"></a>Configure Prometheus Data source</h2>
<div class="sectionbody">
<div class="paragraph">
<p>You need to set up <a href="https://prometheus.io/docs/prometheus/latest/getting_started/">Prometheus</a> first to scrape James metrics.<br>
Add Apache James WebAdmin Url or IP address to <code>prometheus.yaml</code> configuration file:</p>
</div>
<div class="literalblock">
<div class="content">
<pre>scrape_configs:
# The job name is added as a label `job=&lt;job_name&gt;` to any timeseries scraped from this config.
- job_name: 'WebAdmin url Example'
scrape_interval: 5s
metrics_path: /metrics
static_configs:
- targets: ['james-webamin-url']
- job_name: 'WebAdmin IP Example'
scrape_interval: 5s
metrics_path: /metrics
static_configs:
- targets: ['192.168.100.10:8000']</pre>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_connect_prometheus_to_grafana"><a class="anchor" href="#_connect_prometheus_to_grafana"></a>Connect Prometheus to Grafana</h2>
<div class="sectionbody">
<div class="paragraph">
<p>You can do this either from <a href="https://prometheus.io/docs/visualization/grafana/">Grafana UI</a> or from a <a href="https://grafana.com/docs/grafana/latest/datasources/prometheus/">configuration file</a>.<br>
The following <code>docker-compose.yaml</code> will help you install a simple Prometheus/ Grafana stack :</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-none hljs">version: '3'
#Metric monitoring
grafana:
image: grafana/grafana:latest
container_name: grafana
ports:
- "3000:3000"
prometheus:
image: prom/prometheus:latest
restart: unless-stopped
ports:
- "9090:9090"
volumes:
- ./conf/prometheus.yml:/etc/prometheus/prometheus.yml</code></pre>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_getting_dashboards"><a class="anchor" href="#_getting_dashboards"></a>Getting dashboards</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Now that the Promtheus/Grafana servers are up, go to this <a href="https://github.com/apache/james-project/tree/master/server/grafana-reporting/prometheus-datasource/">link</a> to get all dashboards JSON file. Import the different JSON files in this directory to Grafana via UI.</p>
</div>
<div class="imageblock">
<div class="content">
<img src="../_images/preload-dashboards.png" alt="Pre-loaded dashboards">
</div>
</div>
<div class="paragraph">
<p>*Note: For communication between multiple docker-compose projects, see <a href="https://stackoverflow.com/questions/38088279/communication-between-multiple-docker-compose-projects">here</a> for example. An easier approach is to merge James and Metric docker-compose files together.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_available_metrics"><a class="anchor" href="#_available_metrics"></a>Available metrics</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Here are the available metrics :</p>
</div>
<div class="ulist">
<ul>
<li>
<p>James JVM metrics</p>
</li>
<li>
<p>Number of active SMTP connections</p>
</li>
<li>
<p>Number of SMTP commands received</p>
</li>
<li>
<p>Number of active IMAP connections</p>
</li>
<li>
<p>Number of IMAP commands received</p>
</li>
<li>
<p>Number of active LMTP connections</p>
</li>
<li>
<p>Number of LMTP commands received</p>
</li>
<li>
<p>Number of per queue number of enqueued mails</p>
</li>
<li>
<p>Number of sent emails</p>
</li>
<li>
<p>Number of delivered emails</p>
</li>
<li>
<p>Diverse Response time percentiles, counts and rates for JMAP</p>
</li>
<li>
<p>Diverse Response time percentiles, counts and rates for IMAP</p>
</li>
<li>
<p>Diverse Response time percentiles, counts and rates for SMTP</p>
</li>
<li>
<p>Diverse Response time percentiles, counts and rates for WebAdmin</p>
</li>
<li>
<p>Diverse Response time percentiles, counts and rates for each Mail Queue</p>
</li>
<li>
<p>Per mailet and per matcher Response time percentiles</p>
</li>
<li>
<p>Diverse Response time percentiles, counts and rates for DNS</p>
</li>
<li>
<p>Cassandra Java driver metrics</p>
</li>
<li>
<p>Tika HTTP client statistics</p>
</li>
<li>
<p>SpamAssassin TCP client statistics</p>
</li>
<li>
<p>Mailbox listeners statistics time percentiles</p>
</li>
<li>
<p>Mailbox listeners statistics requests rate</p>
</li>
<li>
<p>Pre-deletion hooks execution statistics time percentiles</p>
</li>
</ul>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_available_grafana_boards"><a class="anchor" href="#_available_grafana_boards"></a>Available Grafana boards</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Here are the various relevant Grafana boards for the Distributed Server:</p>
</div>
<div class="ulist">
<ul>
<li>
<p><a href="https://github.com/apache/james-project/tree/master/server/grafana-reporting/prometheus-datasource/James_BlobStore.json">BlobStore</a> :
Rates and percentiles for the BlobStore component</p>
</li>
<li>
<p><a href="https://github.com/apache/james-project/tree/master/server/grafana-reporting/prometheus-datasource/James_DNS_Dashboard.json">DNS</a> :
Latencies and query counts for DNS resolution.</p>
</li>
<li>
<p><a href="https://github.com/apache/james-project/tree/master/server/grafana-reporting/prometheus-datasource/James_IMAP_Board.json">IMAP</a> :
Latencies for the IMAP protocol</p>
</li>
<li>
<p><a href="https://github.com/apache/james-project/tree/master/server/grafana-reporting/prometheus-datasource/James_IMAP_CountBoard.json">IMAP counts</a> :
Request counts for the IMAP protocol</p>
</li>
<li>
<p><a href="https://github.com/apache/james-project/tree/master/server/grafana-reporting/prometheus-datasource/James_JMAP_Board.json">JMAP</a> :
Latencies for the JMAP protocol</p>
</li>
<li>
<p><a href="https://github.com/apache/james-project/tree/master/server/grafana-reporting/prometheus-datasource/James_JMAP_CountBoard.json">JMAP counts</a> :
Request counts for the JMAP protocol</p>
</li>
<li>
<p><a href="https://github.com/apache/james-project/tree/master/server/grafana-reporting/prometheus-datasource/James_JVM.json">JVM</a> :
JVM statistics (heap, gcs, etc&#8230;&#8203;)</p>
</li>
<li>
<p><a href="https://github.com/apache/james-project/tree/master/server/grafana-reporting/prometheus-datasource/James_MAILET.json">Mailets</a> :
Per-mailet execution timings.</p>
</li>
<li>
<p><a href="https://github.com/apache/james-project/tree/master/server/grafana-reporting/prometheus-datasource/James_MATCHER.json">Matchers</a> :
Per-matcher execution timings</p>
</li>
<li>
<p><a href="https://github.com/apache/james-project/tree/master/server/grafana-reporting/prometheus-datasource/James_MailQueue.json">MailQueue</a> :
MailQueue statistics</p>
</li>
<li>
<p><a href="https://github.com/apache/james-project/tree/master/server/grafana-reporting/prometheus-datasource/James_SMTP_Board.json">SMTP</a> :
SMTP latencies reports</p>
</li>
<li>
<p><a href="https://github.com/apache/james-project/tree/master/server/grafana-reporting/prometheus-datasource/James_SMTP_CountBoard.json">SMTP count</a> :
Request count for the SMTP protocol</p>
</li>
</ul>
</div>
<div class="sect2">
<h3 id="_dashboard_samples"><a class="anchor" href="#_dashboard_samples"></a>Dashboard samples</h3>
<div class="paragraph">
<p>Latencies for the JMAP protocol<br></p>
</div>
<div class="imageblock">
<div class="content">
<img src="../_images/JMAP_board.png" alt="JMAP">
</div>
</div>
<div class="paragraph">
<p>Latencies for the IMAP protocol<br></p>
</div>
<div class="imageblock">
<div class="content">
<img src="../_images/IMAP_board.png" alt="IMAP">
</div>
</div>
<div class="paragraph">
<p>JVM Statistics<br></p>
</div>
<div class="imageblock">
<div class="content">
<img src="../_images/JVM_board.png" alt="JVM">
</div>
</div>
<div class="paragraph">
<p>BlobStore Statistics<br></p>
</div>
<div class="imageblock">
<div class="content">
<img src="../_images/BlobStore.png" alt="BlobStore">
</div>
</div>
<div class="paragraph">
<p>webAdmin Statistics<br></p>
</div>
<div class="imageblock">
<div class="content">
<img src="../_images/webAdmin.png" alt="webAdmin">
</div>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_expose_metrics_for_elasticsearch_collection"><a class="anchor" href="#_expose_metrics_for_elasticsearch_collection"></a>Expose metrics for Elasticsearch collection</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The following command allow you to run a fresh grafana server :</p>
</div>
<div class="literalblock">
<div class="content">
<pre>docker run -i -p 3000:3000 grafana/grafana</pre>
</div>
</div>
<div class="paragraph">
<p>Once running, you need to set up an ElasticSearch data-source : - select
proxy mode - Select version 2.x of ElasticSearch - make the URL point
your ES node - Specify the index name. By default, it should be :</p>
</div>
<div class="literalblock">
<div class="content">
<pre>[james-metrics-]YYYY-MM</pre>
</div>
</div>
<div class="paragraph">
<p>Import the different dashboards you want.</p>
</div>
<div class="paragraph">
<p>You then need to enable reporting through ElasticSearch. Modify your
James ElasticSearch configuration file accordingly. To help you doing
this, you can take a look to
<a href="https://github.com/apache/james-project/blob/3.7.x/server/apps/distributed-app/sample-configuration/elasticsearch.properties">elasticsearch.properties</a>.</p>
</div>
<div class="paragraph">
<p>If some metrics seem abnormally slow despite in depth database
performance tuning, feedback is appreciated as well on the bug tracker,
the user mailing list or our Gitter channel (see our
<a href="http://james.apache.org/#second">community page</a>) . Any additional
details categorizing the slowness are appreciated as well (details of
the slow requests for instance).</p>
</div>
</div>
</div>
</article>
</div>
</main>
</div>
<footer class="footer">
<p>This page was built using the Antora default UI.</p>
<p>The source code for this UI is licensed under the terms of the MPL-2.0 license.</p>
</footer>
<script id="site-script" src="../../../_/js/site.js" data-ui-root-path="../../../_"></script>
<script async src="../../../_/js/vendor/highlight.js"></script>
</body>
</html>