JAMES-1955 Add a README for grafana
Project: http://git-wip-us.apache.org/repos/asf/james-project/repo Commit: http://git-wip-us.apache.org/repos/asf/james-project/commit/6b149048 Tree: http://git-wip-us.apache.org/repos/asf/james-project/tree/6b149048 Diff: http://git-wip-us.apache.org/repos/asf/james-project/diff/6b149048 Branch: refs/heads/master Commit: 6b14904813673e6653aa44b2f7273b8131283598 Parents: 9eae265 Author: benwa <[email protected]> Authored: Mon Mar 6 11:43:14 2017 +0700 Committer: benwa <[email protected]> Committed: Mon Mar 6 11:46:23 2017 +0700 ---------------------------------------------------------------------- grafana-reporting/README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/james-project/blob/6b149048/grafana-reporting/README.md ---------------------------------------------------------------------- diff --git a/grafana-reporting/README.md b/grafana-reporting/README.md new file mode 100644 index 0000000..944d324 --- /dev/null +++ b/grafana-reporting/README.md @@ -0,0 +1,29 @@ +# Grafana reporting + +The following command allow you to run a fresh grafana server : + +``` +docker run -i -p 3000:3000 grafana/grafana +``` + +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 : + +``` +[james-metrics-]YYYY-MM +``` + +Import the different dashboards in this directory. + +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 [GitHub](https://github.com/apache/james-project/blob/master/dockerfiles/run/guice/cassandra/destination/conf/elasticsearch.properties). +Note that you need to run a guice/cassandra version of James. + +## Presentation of the different boards + + - Percentiles for IMAP / JMAP / SMTP commands + - Requests counts for IMAP / JMAP / SMTP commands + - Some other, diverse informations on the James server internals \ No newline at end of file --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
