JAMES-1868 Add documentation for the metric feature
Project: http://git-wip-us.apache.org/repos/asf/james-project/repo Commit: http://git-wip-us.apache.org/repos/asf/james-project/commit/994c8d32 Tree: http://git-wip-us.apache.org/repos/asf/james-project/tree/994c8d32 Diff: http://git-wip-us.apache.org/repos/asf/james-project/diff/994c8d32 Branch: refs/heads/master Commit: 994c8d32b248e2d8d1dd4f6bbf8035bd4f62f8be Parents: 78f7dbb Author: Benoit Tellier <btell...@linagora.com> Authored: Mon Nov 28 09:48:28 2016 +0700 Committer: Benoit Tellier <btell...@linagora.com> Committed: Wed Nov 30 16:32:21 2016 +0700 ---------------------------------------------------------------------- server/src/site/site.xml | 1 + server/src/site/xdoc/metrics.xml | 70 +++++++++++++++++++++++++++++++++++ 2 files changed, 71 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/james-project/blob/994c8d32/server/src/site/site.xml ---------------------------------------------------------------------- diff --git a/server/src/site/site.xml b/server/src/site/site.xml index a328ad4..3d136f8 100644 --- a/server/src/site/site.xml +++ b/server/src/site/site.xml @@ -79,6 +79,7 @@ Removed from trunk for now. <item name="Domains" href="/manage-domains.html" /> <item name="Users" href="/manage-users.html" /> <item name="Recipient Rewrite" href="/manage-recipientrewrite.html" /> + <item name="Metrics" href="/metrics.html" /> </item> <item name="5. Monitor" href="/monitor.html" collapse="true" > <item name="Logging" href="/monitor-logging.html" /> http://git-wip-us.apache.org/repos/asf/james-project/blob/994c8d32/server/src/site/xdoc/metrics.xml ---------------------------------------------------------------------- diff --git a/server/src/site/xdoc/metrics.xml b/server/src/site/xdoc/metrics.xml new file mode 100644 index 0000000..c0a32ab --- /dev/null +++ b/server/src/site/xdoc/metrics.xml @@ -0,0 +1,70 @@ +<?xml version="1.0"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> +<document> + + <properties> + <title>Apache James Server 3 - Metrics</title> + </properties> + + <body> + + <section name="Presentation"> + + <p>James relies on the <a href="http://metrics.dropwizard.io/3.1.0/manual/core/";>Dropwizard metric library</a> + for keeping track of some core metrics of James.</p> + + <p>Such metrics are made available via JMX. You can connect for instance using VisualVM and the associated + mbean plugins.</p> + + </section> + + <section name="Available metrics"> + + <p> + Here are the available metrics : + <ul> + <li>Number of active SMTP connections</li> + <li>Number of SMTP commands received</li> + <li>Number of active IMAP connections</li> + <li>Number of IMAP commands received</li> + <li>Number of active LMTP connections</li> + <li>Number of LMTP commands received</li> + <li>Number of per queue number of enqueued mails</li> + <li>Number of sent emails</li> + <li>Number of delivered emails</li> + </ul> + </p> + + <p> + In addition to these metrics, you can define your own metrics using the <b>Metrics</b> mailet. By adding + it in your mailet container, you can count emails that pass via any points. You can also, using matchers, + count emails that matches the conditions you defined. + </p> + </section> + + <section name="Limitations"> + + <p>Those metrics are only available with Guice.</p> + + </section> + + </body> + +</document> --------------------------------------------------------------------- To unsubscribe, e-mail: server-dev-unsubscr...@james.apache.org For additional commands, e-mail: server-dev-h...@james.apache.org
