You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sirona.apache.org by rm...@apache.org on 2016/07/02 19:38:39 UTC
svn commit: r1751092 [3/14] - in /incubator/sirona/site: ./ css/ involved/
js/ releases/
Modified: incubator/sirona/site/collector.html
URL: http://svn.apache.org/viewvc/incubator/sirona/site/collector.html?rev=1751092&r1=1751091&r2=1751092&view=diff
==============================================================================
--- incubator/sirona/site/collector.html (original)
+++ incubator/sirona/site/collector.html Sat Jul 2 19:38:39 2016
@@ -1,373 +1,382 @@
-<!DOCTYPE html>
-<!--
- | Generated by Apache Maven Doxia
- | Rendered using Apache Maven Fluido Skin 1.3.1
--->
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
- <head>
- <meta charset="UTF-8" />
- <meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20151122" />
- <meta http-equiv="Content-Language" content="en" />
- <title>Apache Sirona - Collector</title>
- <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.1.min.css" />
- <link rel="stylesheet" href="./css/site.css" />
- <link rel="stylesheet" href="./css/print.css" media="print" />
-
-
- <script type="text/javascript" src="./js/apache-maven-fluido-1.3.1.min.js"></script>
-
-
- <!-- Google Analytics -->
- <script type="text/javascript">
-
- var _gaq = _gaq || [];
- _gaq.push(['_setAccount', 'UA-3211522-14']);
- _gaq.push(['_trackPageview']);
-
- (function() {
- var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
- ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
- var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
- })();
-
- </script>
- </head>
- <body class="topBarEnabled">
-
-
-
-
-
- <div id="topbar" class="navbar navbar-fixed-top ">
- <div class="navbar-inner">
- <div class="container" style="width: auto;"><div class="nav-collapse">
-
-
-
- <ul class="nav">
- <li class="dropdown">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">User Guide <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
- <li> <a href="quick-start.html" title="Quick start">Quick start</a>
-</li>
-
- <li> <a href="concepts.html" title="Concepts">Concepts</a>
-</li>
-
- <li> <a href="basis.html" title="Basis">Basis</a>
-</li>
-
- <li> <a href="configuration.html" title="Configuration">Configuration</a>
-</li>
-
- <li> <a href="instrumentation.html" title="Instrumentation">Instrumentation</a>
-</li>
-
- <li> <a href="reporting.html" title="Reporting">Reporting</a>
-</li>
-
- <li> <a href="plugins.html" title="Plugins">Plugins</a>
-</li>
-
- <li> <a href="jta.html" title="JTA">JTA</a>
-</li>
-
- <li> <a href="jpa.html" title="JPA">JPA</a>
-</li>
-
- <li> <a href="jdbc.html" title="JDBC">JDBC</a>
-</li>
-
- <li> <a href="web.html" title="Web">Web</a>
-</li>
-
- <li> <a href="graphite.html" title="Graphite">Graphite</a>
-</li>
-
- <li> <a href="cube.html" title="Cube">Cube</a>
-</li>
-
- <li> <a href="collector.html" title="Collector">Collector</a>
-</li>
-
- <li> <a href="cassandra.html" title="Cassandra">Cassandra</a>
-</li>
-
- <li> <a href="websocket.html" title="WebSocket">WebSocket</a>
-</li>
-
- <li> <a href="alerts.html" title="Alerts">Alerts</a>
-</li>
-
- <li> <a href="download.cgi" title="Download">Download</a>
-</li>
- </ul>
- </li>
- <li class="dropdown">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">Project Reports <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
- <li> <a href="docs/0.3-incubating" title="Last Release Docs 0.3-incubating">Last Release Docs 0.3-incubating</a>
-</li>
-
- <li> <a href="releases/release-notes-0.3-incubating.html" title="Last Release 0.3-incubating Changelog">Last Release 0.3-incubating Changelog</a>
-</li>
-
- <li> <a href="docs/0.4-incubating-SNAPSHOT" title="Dev Docs 0.4-incubating-SNAPSHOT">Dev Docs 0.4-incubating-SNAPSHOT</a>
-</li>
-
- <li> <a href="docs/0.4-incubating-SNAPSHOT/jira-report.html" title="Dev Changelog 0.4-incubating-SNAPSHOT">Dev Changelog 0.4-incubating-SNAPSHOT</a>
-</li>
- </ul>
- </li>
- <li class="dropdown">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">Get Involved <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
- <li> <a href="irc.html" title="IRC">IRC</a>
-</li>
-
- <li> <a href="mail-lists.html" title="Mailing Lists">Mailing Lists</a>
-</li>
-
- <li> <a href="issue-tracking.html" title="Issues">Issues</a>
-</li>
-
- <li> <a href="team-list.html" title="Team">Team</a>
-</li>
-
- <li> <a href="source-repository.html" title="Sources">Sources</a>
-</li>
-
- <li> <a href="integration.html" title="Continuous Integration">Continuous Integration</a>
-</li>
-
- <li> <a href="involved/building.html" title="Building Guide">Building Guide</a>
-</li>
-
- <li> <a href="involved/releasing.html" title="Release Guide">Release Guide</a>
-</li>
- </ul>
- </li>
- <li class="dropdown">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">Project Documentation <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
- <li class="dropdown-submenu">
- <a href="project-info.html" title="Project Information">Project Information</a>
- <ul class="dropdown-menu">
- <li> <a href="integration.html" title="Continuous Integration">Continuous Integration</a>
-</li>
- <li> <a href="mail-lists.html" title="Mailing Lists">Mailing Lists</a>
-</li>
- <li> <a href="issue-tracking.html" title="Issue Tracking">Issue Tracking</a>
-</li>
- <li> <a href="license.html" title="Project License">Project License</a>
-</li>
- <li> <a href="team-list.html" title="Project Team">Project Team</a>
-</li>
- <li> <a href="source-repository.html" title="Source Repository">Source Repository</a>
-</li>
- </ul>
- </li>
- </ul>
- </li>
- <li class="dropdown">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">ASF <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
- <li> <a href="http://www.apache.org/foundation/how-it-works.html" title="How Apache Works">How Apache Works</a>
-</li>
-
- <li> <a href="http://www.apache.org/foundation/" title="Foundation">Foundation</a>
-</li>
-
- <li> <a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsoring Apache">Sponsoring Apache</a>
-</li>
-
- <li> <a href="http://www.apache.org/foundation/thanks.html" title="Thanks">Thanks</a>
-</li>
- </ul>
- </li>
- </ul>
-
-
-
-
-
- <ul class="nav pull-right"><li>
-
- <a href="https://twitter.com/ApacheSirona" class="twitter-follow-button" data-show-count="true" data-align="right" data-size="large" data-show-screen-name="true" data-lang="en">Follow ApacheSirona</a>
- <script type="text/javascript">!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src="//platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script>
-
- </li></ul>
-
-
- </div>
-
- </div>
- </div>
- </div>
-
- <div class="container">
- <div id="banner">
- <div class="pull-left">
- <a href="index.html" id="bannerLeft" title="Apache Sirona logo">
- <h2>Apache Sirona</h2>
- </a>
- </div>
- <div class="pull-right"> <a href="http://incubator.apache.org/" id="bannerRight">
- <img src="http://incubator.apache.org/images/egg-logo.png" />
- </a>
- </div>
- <div class="clear"><hr/></div>
- </div>
-
- <div id="breadcrumbs">
- <ul class="breadcrumb">
-
-
- <li class="">
- <a href="http://www.apache.org/" class="externalLink" title="Apache">
- Apache</a>
- <span class="divider">/</span>
- </li>
- <li class="active ">Collector</li>
-
-
-
- <li id="publishDate" class="pull-right">Last Published: 22 Nov 2015</li>
-
- </ul>
- </div>
-
-
-
- <div id="bodyColumn" >
-
- <!-- -
-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. --><h1>Collector</h1>
-<p>Collector modules aims to aggregate data from multiple instances.</p>
-<div class="section">
-<h2>Features<a name="Features"></a></h2>
-<p>Default implementation only store data in memory but you can easily extend it to store data in MongoDB or whatever you want.</p>
-<p>Note: this is on our roadmap</p></div>
-<div class="section">
-<h2>For the impatient<a name="For_the_impatient"></a></h2>
-<p>Take a servlet container and deploy <tt>sirona-collector-[version].war</tt>. Collection is done on <tt>/collector</tt> endpoint and reporting view is accesible through <tt>/sirona</tt> endpoint.</p></div>
-<div class="section">
-<h2>Configuration<a name="Configuration"></a></h2>
-<p>Just use the collector <tt>DataStoreFactory</tt>: <tt>org.apache.sirona.store.CollectorDataStoreFactory</tt>.</p>
-<p>For instance your <tt>sirona.properties</tt> can look like:</p>
-
-<div>
-<pre class="prettyprint linenums">
-org.apache.sirona.store.DataStoreFactory = org.apache.sirona.store.CollectorDataStoreFactory
-</pre></div>
-<p>The <tt>GaugeDataStore</tt> can be configured through <tt>org.apache.sirona.collector.gauge.store-class</tt> property. By default it uses the in memory implementation but you can set your own one if you want.</p>
-<p>Note: if your <tt>GaugeDataStore</tt> has a constructor with a <tt>String</tt>, the marker of the store will be passed to the <tt>GaugeDataStore</tt>.</p>
-<p>The <tt>CounterDataStore</tt> needs to be an instance of <tt>org.apache.sirona.store.counter.CollectorCounterStore</tt>. By default it is in memory too but it is easily extensible to be persisted if needed.</p></div>
-<div class="section">
-<h2>Installing the collector<a name="Installing_the_collector"></a></h2>
-<p>To setup the collector you just need to configure the <tt>DataStoreFactory</tt> (see configuration part) and configure the servlet <tt>org.apache.sirona.collector.server.Collector</tt>.</p></div>
-<div class="section">
-<h2>Pushing data<a name="Pushing_data"></a></h2>
-<p>The input is an array of event. Events are either gauges or counters.</p>
-<p>Here is an array with a single gauge:</p>
-
-<div>
-<pre class="prettyprint linenums">
-[
- {
- "type": "gauge",
- "time": "-",
- "data": {
- "unit": "u",
- "marker": "client1",
- "value": 0.0,
- "role": "mock"
- }
- }
-]
-</pre></div>
-<p>And here is an array with a single counter:</p>
-
-<div>
-<pre class="prettyprint linenums">
-[
- {
- "type": "counter",
- "time": "2013-10-21T12:50:40Z",
- "data": {
- "min": 1.4,
- "unit": "ns",
- "hits": 4,
- "max": 2.9,
- "marker": "client1",
- "name": "test",
- "concurrency": 0,
- "m2": 1.4099999999999997,
- "sum": 8.2,
- "mean": 2.05,
- "role": "performances",
- "variance": 0.4699999999999999
- }
- }
-]
-</pre></div></div>
- </div>
- </div>
-
- <hr/>
-
- <footer>
- <div class="container">
- <div class="row">
- <p >Copyright © 2008–2015
- <a href="http://www.apache.org/">The Apache Software Foundation</a>.
- All rights reserved.
-
- </p>
- </div>
-
-
-<div class="row span16">
- <div>Apache Sirona, Apache, the Apache feather logo, and the Apache Sirona project logos are trademarks of The Apache Software Foundation.
- All other marks mentioned may be trademarks or registered trademarks of their respective owners.</div>
- <a href="http://sirona.incubator.apache.org/privacy-policy.html">Privacy Policy</a>
-</div>
-
- <p id="poweredBy" class="pull-right">
- <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
- <img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
- </a>
- </p>
-
-
-
-
-
- <div id="ohloh" class="pull-right">
- <script type="text/javascript" src="http://www.ohloh.net/p/sirona/widgets/project_basic_stats.js"></script>
- </div>
- </div>
- </footer>
- </body>
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia
+ | Rendered using Apache Maven Fluido Skin 1.3.1
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="Date-Revision-yyyymmdd" content="20160702" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Apache Sirona - Collector</title>
+ <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.1.min.css" />
+ <link rel="stylesheet" href="./css/site.css" />
+ <link rel="stylesheet" href="./css/print.css" media="print" />
+
+
+ <script type="text/javascript" src="./js/apache-maven-fluido-1.3.1.min.js"></script>
+
+
+ <!-- Google Analytics -->
+ <script type="text/javascript">
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-3211522-14']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+ </script>
+ </head>
+ <body class="topBarEnabled">
+
+
+
+
+
+ <div id="topbar" class="navbar navbar-fixed-top ">
+ <div class="navbar-inner">
+ <div class="container" style="width: auto;"><div class="nav-collapse">
+
+
+
+ <ul class="nav">
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">User Guide <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="quick-start.html" title="Quick start">Quick start</a>
+</li>
+
+ <li> <a href="concepts.html" title="Concepts">Concepts</a>
+</li>
+
+ <li> <a href="basis.html" title="Basis">Basis</a>
+</li>
+
+ <li> <a href="configuration.html" title="Configuration">Configuration</a>
+</li>
+
+ <li> <a href="instrumentation.html" title="Instrumentation">Instrumentation</a>
+</li>
+
+ <li> <a href="reporting.html" title="Reporting">Reporting</a>
+</li>
+
+ <li> <a href="plugins.html" title="Plugins">Plugins</a>
+</li>
+
+ <li> <a href="jta.html" title="JTA">JTA</a>
+</li>
+
+ <li> <a href="jpa.html" title="JPA">JPA</a>
+</li>
+
+ <li> <a href="jdbc.html" title="JDBC">JDBC</a>
+</li>
+
+ <li> <a href="web.html" title="Web">Web</a>
+</li>
+
+ <li> <a href="graphite.html" title="Graphite">Graphite</a>
+</li>
+
+ <li> <a href="cube.html" title="Cube">Cube</a>
+</li>
+
+ <li> <a href="collector.html" title="Collector">Collector</a>
+</li>
+
+ <li> <a href="cassandra.html" title="Cassandra">Cassandra</a>
+</li>
+
+ <li> <a href="websocket.html" title="WebSocket">WebSocket</a>
+</li>
+
+ <li> <a href="alerts.html" title="Alerts">Alerts</a>
+</li>
+
+ <li> <a href="download.cgi" title="Download">Download</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Project Reports <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="docs/0.3-incubating" title="Last Release Docs 0.3-incubating">Last Release Docs 0.3-incubating</a>
+</li>
+
+ <li> <a href="releases/release-notes-0.3-incubating.html" title="Last Release 0.3-incubating Changelog">Last Release 0.3-incubating Changelog</a>
+</li>
+
+ <li> <a href="docs/0.4-incubating-SNAPSHOT" title="Dev Docs 0.4-incubating-SNAPSHOT">Dev Docs 0.4-incubating-SNAPSHOT</a>
+</li>
+
+ <li> <a href="docs/0.4-incubating-SNAPSHOT/jira-report.html" title="Dev Changelog 0.4-incubating-SNAPSHOT">Dev Changelog 0.4-incubating-SNAPSHOT</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Get Involved <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="irc.html" title="IRC">IRC</a>
+</li>
+
+ <li> <a href="mail-lists.html" title="Mailing Lists">Mailing Lists</a>
+</li>
+
+ <li> <a href="issue-tracking.html" title="Issues">Issues</a>
+</li>
+
+ <li> <a href="team-list.html" title="Team">Team</a>
+</li>
+
+ <li> <a href="source-repository.html" title="Sources">Sources</a>
+</li>
+
+ <li> <a href="integration.html" title="Continuous Integration">Continuous Integration</a>
+</li>
+
+ <li> <a href="involved/building.html" title="Building Guide">Building Guide</a>
+</li>
+
+ <li> <a href="involved/releasing.html" title="Release Guide">Release Guide</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Project Documentation <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li class="dropdown-submenu">
+ <a href="project-info.html" title="Project Information">Project Information</a>
+ <ul class="dropdown-menu">
+ <li> <a href="integration.html" title="Continuous Integration">Continuous Integration</a>
+</li>
+ <li> <a href="mail-lists.html" title="Mailing Lists">Mailing Lists</a>
+</li>
+ <li> <a href="issue-tracking.html" title="Issue Tracking">Issue Tracking</a>
+</li>
+ <li> <a href="license.html" title="Project License">Project License</a>
+</li>
+ <li> <a href="team-list.html" title="Project Team">Project Team</a>
+</li>
+ <li> <a href="source-repository.html" title="Source Repository">Source Repository</a>
+</li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">ASF <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="http://www.apache.org/foundation/how-it-works.html" title="How Apache Works">How Apache Works</a>
+</li>
+
+ <li> <a href="http://www.apache.org/foundation/" title="Foundation">Foundation</a>
+</li>
+
+ <li> <a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsoring Apache">Sponsoring Apache</a>
+</li>
+
+ <li> <a href="http://www.apache.org/foundation/thanks.html" title="Thanks">Thanks</a>
+</li>
+ </ul>
+ </li>
+ </ul>
+
+
+
+
+
+ <ul class="nav pull-right"><li>
+
+ <a href="https://twitter.com/ApacheSirona" class="twitter-follow-button" data-show-count="true" data-align="right" data-size="large" data-show-screen-name="true" data-lang="en">Follow ApacheSirona</a>
+ <script type="text/javascript">!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src="//platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script>
+
+ </li></ul>
+
+
+ </div>
+
+ </div>
+ </div>
+ </div>
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <a href="index.html" id="bannerLeft" title="Apache Sirona logo">
+ <h2>Apache Sirona</h2>
+ </a>
+ </div>
+ <div class="pull-right"> <a href="http://incubator.apache.org/" id="bannerRight">
+ <img src="http://incubator.apache.org/images/egg-logo.png" />
+ </a>
+ </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="http://www.apache.org/" class="externalLink" title="Apache">
+ Apache</a>
+ <span class="divider">/</span>
+ </li>
+ <li class="active ">Collector</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 02 Jul 2016</li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <!-- -
+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. --><h1>Collector</h1>
+<p>Collector modules aims to aggregate data from multiple instances.</p>
+<div class="section">
+<h2>Features<a name="Features"></a></h2>
+<p>Default implementation only store data in memory but you can easily extend it to store data in MongoDB or whatever you want.</p>
+<p>Note: this is on our roadmap</p></div>
+<div class="section">
+<h2>For the impatient<a name="For_the_impatient"></a></h2>
+<p>Take a servlet container and deploy <tt>sirona-collector-[version].war</tt>. Collection is done on <tt>/collector</tt> endpoint and reporting view is accesible through <tt>/sirona</tt> endpoint.</p></div>
+<div class="section">
+<h2>Configuration<a name="Configuration"></a></h2>
+<p>Just use the collector <tt>DataStoreFactory</tt>: <tt>org.apache.sirona.store.CollectorDataStoreFactory</tt>.</p>
+<p>For instance your <tt>sirona.properties</tt> can look like:</p>
+
+<div>
+<pre class="prettyprint linenums">
+org.apache.sirona.store.DataStoreFactory = org.apache.sirona.store.CollectorDataStoreFactory
+</pre></div>
+<p>The <tt>GaugeDataStore</tt> can be configured through <tt>org.apache.sirona.collector.gauge.store-class</tt> property. By default it uses the in memory implementation but you can set your own one if you want.</p>
+<p>Note: if your <tt>GaugeDataStore</tt> has a constructor with a <tt>String</tt>, the marker of the store will be passed to the <tt>GaugeDataStore</tt>.</p>
+<p>The <tt>CounterDataStore</tt> needs to be an instance of <tt>org.apache.sirona.store.counter.CollectorCounterStore</tt>. By default it is in memory too but it is easily extensible to be persisted if needed.</p></div>
+<div class="section">
+<h2>Installing the collector<a name="Installing_the_collector"></a></h2>
+<p>To setup the collector you just need to configure the <tt>DataStoreFactory</tt> (see configuration part) and configure the servlet <tt>org.apache.sirona.collector.server.Collector</tt>.</p></div>
+<div class="section">
+<h2>Pushing data<a name="Pushing_data"></a></h2>
+<p>The input is an array of event. Events are either gauges or counters.</p>
+<p>Here is an array with a single gauge:</p>
+
+<div>
+<pre class="prettyprint linenums">
+[
+ {
+ "type": "gauge",
+ "time": "-",
+ "data": {
+ "unit": "u",
+ "marker": "client1",
+ "value": 0.0,
+ "role": "mock"
+ }
+ }
+]
+</pre></div>
+<p>And here is an array with a single counter:</p>
+
+<div>
+<pre class="prettyprint linenums">
+[
+ {
+ "type": "counter",
+ "time": "2013-10-21T12:50:40Z",
+ "data": {
+ "min": 1.4,
+ "unit": "ns",
+ "hits": 4,
+ "max": 2.9,
+ "marker": "client1",
+ "name": "test",
+ "concurrency": 0,
+ "m2": 1.4099999999999997,
+ "sum": 8.2,
+ "mean": 2.05,
+ "role": "performances",
+ "variance": 0.4699999999999999
+ }
+ }
+]
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row">
+ <p >Copyright © 2008–2016
+ <a href="http://www.apache.org/">The Apache Software Foundation</a>.
+ All rights reserved.
+
+ </p>
+ </div>
+
+
+<p class="text-muted">Apache Sirona, Apache, the Apache feather logo, and the Apache Sirona project logos are trademarks of The Apache
+ Software Foundation.
+ All other marks mentioned may be trademarks or registered trademarks of their respective owners.</p>
+
+<p class="text-muted">
+ <small>Apache Sirona is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by
+ the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates
+ that the infrastructure, communications, and decision making process have stabilized in a manner consistent
+ with other successful ASF projects. While incubation status is not necessarily a reflection of the
+ completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the
+ ASF.</small>
+</p>
+
+<a href="http://sirona.incubator.apache.org/privacy-policy.html">Privacy Policy</a>
+
+ <p id="poweredBy" class="pull-right">
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
+ </a>
+ </p>
+
+
+
+
+
+ <div id="ohloh" class="pull-right">
+ <script type="text/javascript" src="http://www.ohloh.net/p/sirona/widgets/project_basic_stats.js"></script>
+ </div>
+ </div>
+ </footer>
+ </body>
</html>
\ No newline at end of file
Modified: incubator/sirona/site/concepts.html
URL: http://svn.apache.org/viewvc/incubator/sirona/site/concepts.html?rev=1751092&r1=1751091&r2=1751092&view=diff
==============================================================================
--- incubator/sirona/site/concepts.html (original)
+++ incubator/sirona/site/concepts.html Sat Jul 2 19:38:39 2016
@@ -1,393 +1,402 @@
-<!DOCTYPE html>
-<!--
- | Generated by Apache Maven Doxia
- | Rendered using Apache Maven Fluido Skin 1.3.1
--->
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
- <head>
- <meta charset="UTF-8" />
- <meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20151122" />
- <meta http-equiv="Content-Language" content="en" />
- <title>Apache Sirona - Repository</title>
- <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.1.min.css" />
- <link rel="stylesheet" href="./css/site.css" />
- <link rel="stylesheet" href="./css/print.css" media="print" />
-
-
- <script type="text/javascript" src="./js/apache-maven-fluido-1.3.1.min.js"></script>
-
-
- <!-- Google Analytics -->
- <script type="text/javascript">
-
- var _gaq = _gaq || [];
- _gaq.push(['_setAccount', 'UA-3211522-14']);
- _gaq.push(['_trackPageview']);
-
- (function() {
- var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
- ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
- var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
- })();
-
- </script>
- </head>
- <body class="topBarEnabled">
-
-
-
-
-
- <div id="topbar" class="navbar navbar-fixed-top ">
- <div class="navbar-inner">
- <div class="container" style="width: auto;"><div class="nav-collapse">
-
-
-
- <ul class="nav">
- <li class="dropdown">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">User Guide <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
- <li> <a href="quick-start.html" title="Quick start">Quick start</a>
-</li>
-
- <li> <a href="concepts.html" title="Concepts">Concepts</a>
-</li>
-
- <li> <a href="basis.html" title="Basis">Basis</a>
-</li>
-
- <li> <a href="configuration.html" title="Configuration">Configuration</a>
-</li>
-
- <li> <a href="instrumentation.html" title="Instrumentation">Instrumentation</a>
-</li>
-
- <li> <a href="reporting.html" title="Reporting">Reporting</a>
-</li>
-
- <li> <a href="plugins.html" title="Plugins">Plugins</a>
-</li>
-
- <li> <a href="jta.html" title="JTA">JTA</a>
-</li>
-
- <li> <a href="jpa.html" title="JPA">JPA</a>
-</li>
-
- <li> <a href="jdbc.html" title="JDBC">JDBC</a>
-</li>
-
- <li> <a href="web.html" title="Web">Web</a>
-</li>
-
- <li> <a href="graphite.html" title="Graphite">Graphite</a>
-</li>
-
- <li> <a href="cube.html" title="Cube">Cube</a>
-</li>
-
- <li> <a href="collector.html" title="Collector">Collector</a>
-</li>
-
- <li> <a href="cassandra.html" title="Cassandra">Cassandra</a>
-</li>
-
- <li> <a href="websocket.html" title="WebSocket">WebSocket</a>
-</li>
-
- <li> <a href="alerts.html" title="Alerts">Alerts</a>
-</li>
-
- <li> <a href="download.cgi" title="Download">Download</a>
-</li>
- </ul>
- </li>
- <li class="dropdown">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">Project Reports <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
- <li> <a href="docs/0.3-incubating" title="Last Release Docs 0.3-incubating">Last Release Docs 0.3-incubating</a>
-</li>
-
- <li> <a href="releases/release-notes-0.3-incubating.html" title="Last Release 0.3-incubating Changelog">Last Release 0.3-incubating Changelog</a>
-</li>
-
- <li> <a href="docs/0.4-incubating-SNAPSHOT" title="Dev Docs 0.4-incubating-SNAPSHOT">Dev Docs 0.4-incubating-SNAPSHOT</a>
-</li>
-
- <li> <a href="docs/0.4-incubating-SNAPSHOT/jira-report.html" title="Dev Changelog 0.4-incubating-SNAPSHOT">Dev Changelog 0.4-incubating-SNAPSHOT</a>
-</li>
- </ul>
- </li>
- <li class="dropdown">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">Get Involved <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
- <li> <a href="irc.html" title="IRC">IRC</a>
-</li>
-
- <li> <a href="mail-lists.html" title="Mailing Lists">Mailing Lists</a>
-</li>
-
- <li> <a href="issue-tracking.html" title="Issues">Issues</a>
-</li>
-
- <li> <a href="team-list.html" title="Team">Team</a>
-</li>
-
- <li> <a href="source-repository.html" title="Sources">Sources</a>
-</li>
-
- <li> <a href="integration.html" title="Continuous Integration">Continuous Integration</a>
-</li>
-
- <li> <a href="involved/building.html" title="Building Guide">Building Guide</a>
-</li>
-
- <li> <a href="involved/releasing.html" title="Release Guide">Release Guide</a>
-</li>
- </ul>
- </li>
- <li class="dropdown">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">Project Documentation <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
- <li class="dropdown-submenu">
- <a href="project-info.html" title="Project Information">Project Information</a>
- <ul class="dropdown-menu">
- <li> <a href="integration.html" title="Continuous Integration">Continuous Integration</a>
-</li>
- <li> <a href="mail-lists.html" title="Mailing Lists">Mailing Lists</a>
-</li>
- <li> <a href="issue-tracking.html" title="Issue Tracking">Issue Tracking</a>
-</li>
- <li> <a href="license.html" title="Project License">Project License</a>
-</li>
- <li> <a href="team-list.html" title="Project Team">Project Team</a>
-</li>
- <li> <a href="source-repository.html" title="Source Repository">Source Repository</a>
-</li>
- </ul>
- </li>
- </ul>
- </li>
- <li class="dropdown">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">ASF <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
- <li> <a href="http://www.apache.org/foundation/how-it-works.html" title="How Apache Works">How Apache Works</a>
-</li>
-
- <li> <a href="http://www.apache.org/foundation/" title="Foundation">Foundation</a>
-</li>
-
- <li> <a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsoring Apache">Sponsoring Apache</a>
-</li>
-
- <li> <a href="http://www.apache.org/foundation/thanks.html" title="Thanks">Thanks</a>
-</li>
- </ul>
- </li>
- </ul>
-
-
-
-
-
- <ul class="nav pull-right"><li>
-
- <a href="https://twitter.com/ApacheSirona" class="twitter-follow-button" data-show-count="true" data-align="right" data-size="large" data-show-screen-name="true" data-lang="en">Follow ApacheSirona</a>
- <script type="text/javascript">!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src="//platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script>
-
- </li></ul>
-
-
- </div>
-
- </div>
- </div>
- </div>
-
- <div class="container">
- <div id="banner">
- <div class="pull-left">
- <a href="index.html" id="bannerLeft" title="Apache Sirona logo">
- <h2>Apache Sirona</h2>
- </a>
- </div>
- <div class="pull-right"> <a href="http://incubator.apache.org/" id="bannerRight">
- <img src="http://incubator.apache.org/images/egg-logo.png" />
- </a>
- </div>
- <div class="clear"><hr/></div>
- </div>
-
- <div id="breadcrumbs">
- <ul class="breadcrumb">
-
-
- <li class="">
- <a href="http://www.apache.org/" class="externalLink" title="Apache">
- Apache</a>
- <span class="divider">/</span>
- </li>
- <li class="active ">Repository</li>
-
-
-
- <li id="publishDate" class="pull-right">Last Published: 22 Nov 2015</li>
-
- </ul>
- </div>
-
-
-
- <div id="bodyColumn" >
-
- <!-- -
-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. --><h1>Repository</h1>
-<p>The repository is a singleton for the JVM. It is the entry point to get access to counters and gauges.</p>
-
-<div>
-<pre class="prettyprint linenums">
-public interface Repository extends Iterable<Counter> {
- Counter getCounter(Counter.Key key);
- void clear();
- StopWatch start(Counter counter);
-
- Map<Long, Double> getGaugeValues(long start, long end, Role role);
- void stopGauge(Role role);
-}
-</pre></div>
-<h1>Counter</h1>
-<p>A counter is a statistic and concurrency holder. It aggregates the information provided computing the average, min, max, sum of logs, ….</p>
-
-<div>
-<pre class="prettyprint linenums">
-public interface Counter {
- Key getKey();
- void reset();
-
- void add(double delta);
-
- AtomicInteger currentConcurrency();
- int getMaxConcurrency();
-
- double getMax();
- double getMin();
- long getHits();
- double getSum();
- double getStandardDeviation();
- double getVariance();
- double getMean();
- double getSecondMoment();
-}
-</pre></div>
-<h1>Gauge</h1>
-<p>A gauge is a way to get a measure. It is intended to get a history of a metric.</p>
-
-<div>
-<pre class="prettyprint linenums">
-public interface Gauge {
- Role role();
- double value();
-}
-</pre></div>
-<h1>StopWatch</h1>
-<p>A StopWatch is just a handler for a measure with a counter.</p>
-
-<div>
-<pre class="prettyprint linenums">
-public interface StopWatch {
- long getElapsedTime();
-
- StopWatch stop();
-}
-</pre></div>
-<h1>Node status</h1>
-<p>Node statuses can be reported using <tt>org.apache.sirona.status.Validation</tt>. <tt>Validation</tt> and <tt>ValidationFactory</tt> (just a list of validation) can be registered using <tt>SPI</tt> mecanism (<tt>META-INF/services/org.apache.sirona.status.Validation</tt> and <tt>META-INF/services/org.apache.sirona.status.ValidationFactory</tt> by default).</p>
-<p><tt>Validation</tt> API is the following one:</p>
-
-<div>
-<pre class="prettyprint linenums">
-public interface Validation {
- ValidationResult validate();
-}
-</pre></div>
-<p>A <tt>ValidationResult</tt> is just a message, a validation name and a status. It is aggregated by node to compute the node status keeping the lowest of all statuses of validation results.</p>
-<h1>DataStore</h1>
-<p>Counters, Gauges and status are saved and queried (in memory by default) through a DataStore. it allows you to plug behind it any kind of persistence you would like. There are generally two kind of stores: local or remote.</p>
-<p>Here are the entry points if you want more details:</p>
-
-<ul>
-
-<li><tt>org.apache.sirona.store.counter.CounterDataStore</tt></li>
-
-<li><tt>org.apache.sirona.store.gauge.GaugeDataStore</tt></li>
-
-<li><tt>org.apache.sirona.store.status.NodeStatusDataStore</tt></li>
-
-<li><tt>org.apache.sirona.store.counter.CollectorCounterStore</tt></li>
-
-<li><tt>org.apache.sirona.store.gauge.CollectorGaugeDataStore</tt></li>
-</ul>
-<h1>AlertListener</h1>
-<p>Most of <tt>NodeStatusDataStore</tt> are able to maintain an <tt>AlertListener</tt> list. This allows to be called when a <tt>NodeStatus</tt> is <tt>DEGRADED</tt> or <tt>KO</tt> - nothing when it is <tt>OK</tt>.</p>
-<p>It will typically be used to send a mail or trigger an alert using a custom system.</p>
- </div>
- </div>
-
- <hr/>
-
- <footer>
- <div class="container">
- <div class="row">
- <p >Copyright © 2008–2015
- <a href="http://www.apache.org/">The Apache Software Foundation</a>.
- All rights reserved.
-
- </p>
- </div>
-
-
-<div class="row span16">
- <div>Apache Sirona, Apache, the Apache feather logo, and the Apache Sirona project logos are trademarks of The Apache Software Foundation.
- All other marks mentioned may be trademarks or registered trademarks of their respective owners.</div>
- <a href="http://sirona.incubator.apache.org/privacy-policy.html">Privacy Policy</a>
-</div>
-
- <p id="poweredBy" class="pull-right">
- <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
- <img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
- </a>
- </p>
-
-
-
-
-
- <div id="ohloh" class="pull-right">
- <script type="text/javascript" src="http://www.ohloh.net/p/sirona/widgets/project_basic_stats.js"></script>
- </div>
- </div>
- </footer>
- </body>
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia
+ | Rendered using Apache Maven Fluido Skin 1.3.1
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="Date-Revision-yyyymmdd" content="20160702" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Apache Sirona - Repository</title>
+ <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.1.min.css" />
+ <link rel="stylesheet" href="./css/site.css" />
+ <link rel="stylesheet" href="./css/print.css" media="print" />
+
+
+ <script type="text/javascript" src="./js/apache-maven-fluido-1.3.1.min.js"></script>
+
+
+ <!-- Google Analytics -->
+ <script type="text/javascript">
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-3211522-14']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+ </script>
+ </head>
+ <body class="topBarEnabled">
+
+
+
+
+
+ <div id="topbar" class="navbar navbar-fixed-top ">
+ <div class="navbar-inner">
+ <div class="container" style="width: auto;"><div class="nav-collapse">
+
+
+
+ <ul class="nav">
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">User Guide <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="quick-start.html" title="Quick start">Quick start</a>
+</li>
+
+ <li> <a href="concepts.html" title="Concepts">Concepts</a>
+</li>
+
+ <li> <a href="basis.html" title="Basis">Basis</a>
+</li>
+
+ <li> <a href="configuration.html" title="Configuration">Configuration</a>
+</li>
+
+ <li> <a href="instrumentation.html" title="Instrumentation">Instrumentation</a>
+</li>
+
+ <li> <a href="reporting.html" title="Reporting">Reporting</a>
+</li>
+
+ <li> <a href="plugins.html" title="Plugins">Plugins</a>
+</li>
+
+ <li> <a href="jta.html" title="JTA">JTA</a>
+</li>
+
+ <li> <a href="jpa.html" title="JPA">JPA</a>
+</li>
+
+ <li> <a href="jdbc.html" title="JDBC">JDBC</a>
+</li>
+
+ <li> <a href="web.html" title="Web">Web</a>
+</li>
+
+ <li> <a href="graphite.html" title="Graphite">Graphite</a>
+</li>
+
+ <li> <a href="cube.html" title="Cube">Cube</a>
+</li>
+
+ <li> <a href="collector.html" title="Collector">Collector</a>
+</li>
+
+ <li> <a href="cassandra.html" title="Cassandra">Cassandra</a>
+</li>
+
+ <li> <a href="websocket.html" title="WebSocket">WebSocket</a>
+</li>
+
+ <li> <a href="alerts.html" title="Alerts">Alerts</a>
+</li>
+
+ <li> <a href="download.cgi" title="Download">Download</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Project Reports <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="docs/0.3-incubating" title="Last Release Docs 0.3-incubating">Last Release Docs 0.3-incubating</a>
+</li>
+
+ <li> <a href="releases/release-notes-0.3-incubating.html" title="Last Release 0.3-incubating Changelog">Last Release 0.3-incubating Changelog</a>
+</li>
+
+ <li> <a href="docs/0.4-incubating-SNAPSHOT" title="Dev Docs 0.4-incubating-SNAPSHOT">Dev Docs 0.4-incubating-SNAPSHOT</a>
+</li>
+
+ <li> <a href="docs/0.4-incubating-SNAPSHOT/jira-report.html" title="Dev Changelog 0.4-incubating-SNAPSHOT">Dev Changelog 0.4-incubating-SNAPSHOT</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Get Involved <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="irc.html" title="IRC">IRC</a>
+</li>
+
+ <li> <a href="mail-lists.html" title="Mailing Lists">Mailing Lists</a>
+</li>
+
+ <li> <a href="issue-tracking.html" title="Issues">Issues</a>
+</li>
+
+ <li> <a href="team-list.html" title="Team">Team</a>
+</li>
+
+ <li> <a href="source-repository.html" title="Sources">Sources</a>
+</li>
+
+ <li> <a href="integration.html" title="Continuous Integration">Continuous Integration</a>
+</li>
+
+ <li> <a href="involved/building.html" title="Building Guide">Building Guide</a>
+</li>
+
+ <li> <a href="involved/releasing.html" title="Release Guide">Release Guide</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Project Documentation <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li class="dropdown-submenu">
+ <a href="project-info.html" title="Project Information">Project Information</a>
+ <ul class="dropdown-menu">
+ <li> <a href="integration.html" title="Continuous Integration">Continuous Integration</a>
+</li>
+ <li> <a href="mail-lists.html" title="Mailing Lists">Mailing Lists</a>
+</li>
+ <li> <a href="issue-tracking.html" title="Issue Tracking">Issue Tracking</a>
+</li>
+ <li> <a href="license.html" title="Project License">Project License</a>
+</li>
+ <li> <a href="team-list.html" title="Project Team">Project Team</a>
+</li>
+ <li> <a href="source-repository.html" title="Source Repository">Source Repository</a>
+</li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">ASF <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="http://www.apache.org/foundation/how-it-works.html" title="How Apache Works">How Apache Works</a>
+</li>
+
+ <li> <a href="http://www.apache.org/foundation/" title="Foundation">Foundation</a>
+</li>
+
+ <li> <a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsoring Apache">Sponsoring Apache</a>
+</li>
+
+ <li> <a href="http://www.apache.org/foundation/thanks.html" title="Thanks">Thanks</a>
+</li>
+ </ul>
+ </li>
+ </ul>
+
+
+
+
+
+ <ul class="nav pull-right"><li>
+
+ <a href="https://twitter.com/ApacheSirona" class="twitter-follow-button" data-show-count="true" data-align="right" data-size="large" data-show-screen-name="true" data-lang="en">Follow ApacheSirona</a>
+ <script type="text/javascript">!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src="//platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script>
+
+ </li></ul>
+
+
+ </div>
+
+ </div>
+ </div>
+ </div>
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <a href="index.html" id="bannerLeft" title="Apache Sirona logo">
+ <h2>Apache Sirona</h2>
+ </a>
+ </div>
+ <div class="pull-right"> <a href="http://incubator.apache.org/" id="bannerRight">
+ <img src="http://incubator.apache.org/images/egg-logo.png" />
+ </a>
+ </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="http://www.apache.org/" class="externalLink" title="Apache">
+ Apache</a>
+ <span class="divider">/</span>
+ </li>
+ <li class="active ">Repository</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 02 Jul 2016</li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <!-- -
+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. --><h1>Repository</h1>
+<p>The repository is a singleton for the JVM. It is the entry point to get access to counters and gauges.</p>
+
+<div>
+<pre class="prettyprint linenums">
+public interface Repository extends Iterable<Counter> {
+ Counter getCounter(Counter.Key key);
+ void clear();
+ StopWatch start(Counter counter);
+
+ Map<Long, Double> getGaugeValues(long start, long end, Role role);
+ void stopGauge(Role role);
+}
+</pre></div>
+<h1>Counter</h1>
+<p>A counter is a statistic and concurrency holder. It aggregates the information provided computing the average, min, max, sum of logs, ….</p>
+
+<div>
+<pre class="prettyprint linenums">
+public interface Counter {
+ Key getKey();
+ void reset();
+
+ void add(double delta);
+
+ AtomicInteger currentConcurrency();
+ int getMaxConcurrency();
+
+ double getMax();
+ double getMin();
+ long getHits();
+ double getSum();
+ double getStandardDeviation();
+ double getVariance();
+ double getMean();
+ double getSecondMoment();
+}
+</pre></div>
+<h1>Gauge</h1>
+<p>A gauge is a way to get a measure. It is intended to get a history of a metric.</p>
+
+<div>
+<pre class="prettyprint linenums">
+public interface Gauge {
+ Role role();
+ double value();
+}
+</pre></div>
+<h1>StopWatch</h1>
+<p>A StopWatch is just a handler for a measure with a counter.</p>
+
+<div>
+<pre class="prettyprint linenums">
+public interface StopWatch {
+ long getElapsedTime();
+
+ StopWatch stop();
+}
+</pre></div>
+<h1>Node status</h1>
+<p>Node statuses can be reported using <tt>org.apache.sirona.status.Validation</tt>. <tt>Validation</tt> and <tt>ValidationFactory</tt> (just a list of validation) can be registered using <tt>SPI</tt> mecanism (<tt>META-INF/services/org.apache.sirona.status.Validation</tt> and <tt>META-INF/services/org.apache.sirona.status.ValidationFactory</tt> by default).</p>
+<p><tt>Validation</tt> API is the following one:</p>
+
+<div>
+<pre class="prettyprint linenums">
+public interface Validation {
+ ValidationResult validate();
+}
+</pre></div>
+<p>A <tt>ValidationResult</tt> is just a message, a validation name and a status. It is aggregated by node to compute the node status keeping the lowest of all statuses of validation results.</p>
+<h1>DataStore</h1>
+<p>Counters, Gauges and status are saved and queried (in memory by default) through a DataStore. it allows you to plug behind it any kind of persistence you would like. There are generally two kind of stores: local or remote.</p>
+<p>Here are the entry points if you want more details:</p>
+
+<ul>
+
+<li><tt>org.apache.sirona.store.counter.CounterDataStore</tt></li>
+
+<li><tt>org.apache.sirona.store.gauge.GaugeDataStore</tt></li>
+
+<li><tt>org.apache.sirona.store.status.NodeStatusDataStore</tt></li>
+
+<li><tt>org.apache.sirona.store.counter.CollectorCounterStore</tt></li>
+
+<li><tt>org.apache.sirona.store.gauge.CollectorGaugeDataStore</tt></li>
+</ul>
+<h1>AlertListener</h1>
+<p>Most of <tt>NodeStatusDataStore</tt> are able to maintain an <tt>AlertListener</tt> list. This allows to be called when a <tt>NodeStatus</tt> is <tt>DEGRADED</tt> or <tt>KO</tt> - nothing when it is <tt>OK</tt>.</p>
+<p>It will typically be used to send a mail or trigger an alert using a custom system.</p>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row">
+ <p >Copyright © 2008–2016
+ <a href="http://www.apache.org/">The Apache Software Foundation</a>.
+ All rights reserved.
+
+ </p>
+ </div>
+
+
+<p class="text-muted">Apache Sirona, Apache, the Apache feather logo, and the Apache Sirona project logos are trademarks of The Apache
+ Software Foundation.
+ All other marks mentioned may be trademarks or registered trademarks of their respective owners.</p>
+
+<p class="text-muted">
+ <small>Apache Sirona is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by
+ the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates
+ that the infrastructure, communications, and decision making process have stabilized in a manner consistent
+ with other successful ASF projects. While incubation status is not necessarily a reflection of the
+ completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the
+ ASF.</small>
+</p>
+
+<a href="http://sirona.incubator.apache.org/privacy-policy.html">Privacy Policy</a>
+
+ <p id="poweredBy" class="pull-right">
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
+ </a>
+ </p>
+
+
+
+
+
+ <div id="ohloh" class="pull-right">
+ <script type="text/javascript" src="http://www.ohloh.net/p/sirona/widgets/project_basic_stats.js"></script>
+ </div>
+ </div>
+ </footer>
+ </body>
</html>
\ No newline at end of file