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 [14/14] - in /incubator/sirona/site: ./ css/ involved/
js/ releases/
Modified: incubator/sirona/site/web.html
URL: http://svn.apache.org/viewvc/incubator/sirona/site/web.html?rev=1751092&r1=1751091&r2=1751092&view=diff
==============================================================================
--- incubator/sirona/site/web.html (original)
+++ incubator/sirona/site/web.html Sat Jul 2 19:38:39 2016
@@ -1,379 +1,388 @@
-<!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 - Web module</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 ">Web module</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. --><div class="section">
-<h2>Web module<a name="Web_module"></a></h2>
-<p>Reporting module provides web listener/filter to monitor servlet containers.</p></div>
-<div class="section">
-<h2>Installation<a name="Installation"></a></h2>
-<p>Add sirona-web to your webapp.</p></div>
-<div class="section">
-<h2>Monitor requests<a name="Monitor_requests"></a></h2>
-<p>Simply add the filter <tt>org.apache.sirona.web.servlet.SironaFilter</tt>:</p>
-
-<div>
-<pre class="prettyprint linenums">
-<filter>
- <filter-name>monitoring-request</filter-name>
- <filter-class>org.apache.sirona.web.servlet.SironaFilter</filter-class>
-</filter>
-<filter-mapping>
- <filter-name>monitoring-request</filter-name>
- <url-pattern>/*</url-pattern>
-</filter-mapping>
-</pre></div>
-<p>Note: in a servlet 3 container you can simply configure <tt>org.apache.sirona.web.monitored-urls</tt> to the servlet pattern you want to match. If you want to register the <tt>SironaFilter</tt> yourself just set the init parameter <tt>org.apache.sirona.web.activated</tt> to false.</p></div>
-<div class="section">
-<h2>Monitor sessions<a name="Monitor_sessions"></a></h2>
-<p>Simply add the listener <tt>org.apache.sirona.web.session.SironaSessionListener</tt>:</p>
-
-<div>
-<pre class="prettyprint linenums">
-<listener>
- <listener-class>org.apache.sirona.web.session.SironaSessionListener</listener-class>
-</listener>
-</pre></div>
-<p>Note: in a servlet 3 container and if <tt>org.apache.sirona.web.activated</tt> is not set to false it is added by default.</p></div>
-<div class="section">
-<h2>Monitor JSP<a name="Monitor_JSP"></a></h2>
-<p>JSP can be monitored through standard web monitoring but this includes more than only the JSP. To be more specific you can use JSP monitoring.</p>
-<p>For Servlet 3.0 containers just add the init parameter or sirona property:</p>
-
-<div>
-<pre class="prettyprint linenums">
-org.apache.sirona.web.jsp.activated = true
-</pre></div>
-<p>or in web.xml</p>
-
-<div>
-<pre class="prettyprint linenums">
-<context-param>
- <param-name>org.apache.sirona.web.jsp.activated</param-name>
- <param-value>true</param-value>
-</context-param>
-</pre></div>
-<p>This will use <tt>PageContext</tt> to monitor the JSP rendering (so from the JSP servlet and not from a filter).</p>
-<p>For Servlet 2.5 containers just declare the <tt>Filter</tt> <tt>org.apache.sirona.web.lifecycle.LazyJspMonitoringFilterActivator</tt>:</p>
-
-<div>
-<pre class="prettyprint linenums">
-<filter>
- <filter-name>sirona-jsp-activator</filter-name>
- <filter-class>org.apache.sirona.web.lifecycle.LazyJspMonitoringFilterActivator</filter-class>
-</filter>
-<filter-mapping>
- <filter-name>sirona-jsp-activator</filter-name>
- <!--
- Any url which will use a jsp.
- If you use req.getRequestDispatcher("....jsp").forward(req, resp);
- ensure to match the original pattern (* in the worse case).
- This filter has an overhead almost null (single test).
- -->
- <url-pattern>*.jsp</url-pattern>
-</filter-mapping>
-</pre></div>
-<p>Note: this monitoring wraps default <tt>javax.servlet.jsp.JspFactory</tt> and therefore sirona needs to be shared accross webapps using <tt>JspFactory</tt> (if you have a single webapp or an ear no issue).</p></div>
-<div class="section">
-<h2>Accessing results<a name="Accessing_results"></a></h2>
-<p>If you installed the reporting webapp you should be able to get the result under the report tab.</p></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 - Web module</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 ">Web module</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. --><div class="section">
+<h2>Web module<a name="Web_module"></a></h2>
+<p>Reporting module provides web listener/filter to monitor servlet containers.</p></div>
+<div class="section">
+<h2>Installation<a name="Installation"></a></h2>
+<p>Add sirona-web to your webapp.</p></div>
+<div class="section">
+<h2>Monitor requests<a name="Monitor_requests"></a></h2>
+<p>Simply add the filter <tt>org.apache.sirona.web.servlet.SironaFilter</tt>:</p>
+
+<div>
+<pre class="prettyprint linenums">
+<filter>
+ <filter-name>monitoring-request</filter-name>
+ <filter-class>org.apache.sirona.web.servlet.SironaFilter</filter-class>
+</filter>
+<filter-mapping>
+ <filter-name>monitoring-request</filter-name>
+ <url-pattern>/*</url-pattern>
+</filter-mapping>
+</pre></div>
+<p>Note: in a servlet 3 container you can simply configure <tt>org.apache.sirona.web.monitored-urls</tt> to the servlet pattern you want to match. If you want to register the <tt>SironaFilter</tt> yourself just set the init parameter <tt>org.apache.sirona.web.activated</tt> to false.</p></div>
+<div class="section">
+<h2>Monitor sessions<a name="Monitor_sessions"></a></h2>
+<p>Simply add the listener <tt>org.apache.sirona.web.session.SironaSessionListener</tt>:</p>
+
+<div>
+<pre class="prettyprint linenums">
+<listener>
+ <listener-class>org.apache.sirona.web.session.SironaSessionListener</listener-class>
+</listener>
+</pre></div>
+<p>Note: in a servlet 3 container and if <tt>org.apache.sirona.web.activated</tt> is not set to false it is added by default.</p></div>
+<div class="section">
+<h2>Monitor JSP<a name="Monitor_JSP"></a></h2>
+<p>JSP can be monitored through standard web monitoring but this includes more than only the JSP. To be more specific you can use JSP monitoring.</p>
+<p>For Servlet 3.0 containers just add the init parameter or sirona property:</p>
+
+<div>
+<pre class="prettyprint linenums">
+org.apache.sirona.web.jsp.activated = true
+</pre></div>
+<p>or in web.xml</p>
+
+<div>
+<pre class="prettyprint linenums">
+<context-param>
+ <param-name>org.apache.sirona.web.jsp.activated</param-name>
+ <param-value>true</param-value>
+</context-param>
+</pre></div>
+<p>This will use <tt>PageContext</tt> to monitor the JSP rendering (so from the JSP servlet and not from a filter).</p>
+<p>For Servlet 2.5 containers just declare the <tt>Filter</tt> <tt>org.apache.sirona.web.lifecycle.LazyJspMonitoringFilterActivator</tt>:</p>
+
+<div>
+<pre class="prettyprint linenums">
+<filter>
+ <filter-name>sirona-jsp-activator</filter-name>
+ <filter-class>org.apache.sirona.web.lifecycle.LazyJspMonitoringFilterActivator</filter-class>
+</filter>
+<filter-mapping>
+ <filter-name>sirona-jsp-activator</filter-name>
+ <!--
+ Any url which will use a jsp.
+ If you use req.getRequestDispatcher("....jsp").forward(req, resp);
+ ensure to match the original pattern (* in the worse case).
+ This filter has an overhead almost null (single test).
+ -->
+ <url-pattern>*.jsp</url-pattern>
+</filter-mapping>
+</pre></div>
+<p>Note: this monitoring wraps default <tt>javax.servlet.jsp.JspFactory</tt> and therefore sirona needs to be shared accross webapps using <tt>JspFactory</tt> (if you have a single webapp or an ear no issue).</p></div>
+<div class="section">
+<h2>Accessing results<a name="Accessing_results"></a></h2>
+<p>If you installed the reporting webapp you should be able to get the result under the report tab.</p></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/websocket.html
URL: http://svn.apache.org/viewvc/incubator/sirona/site/websocket.html?rev=1751092&r1=1751091&r2=1751092&view=diff
==============================================================================
--- incubator/sirona/site/websocket.html (original)
+++ incubator/sirona/site/websocket.html Sat Jul 2 19:38:39 2016
@@ -1,352 +1,361 @@
-<!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 - WebSocket</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 ">WebSocket</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>WebSocket</h1>
-<p>WebSocket module uses websocket to send data from an instance to a collector.</p>
-<div class="section">
-<h2>Configuration<a name="Configuration"></a></h2>
-<div class="section">
-<h3>Agent/Client<a name="AgentClient"></a></h3>
-<p>You need <tt>sirona-websocket-client</tt> dependency and to add the following configuration in your <tt>sirona.properties</tt>:</p>
-
-<div class="source">
-<pre>org.apache.sirona.store.DataStoreFactory = org.apache.sirona.websocket.client.WebSocketDataStoreFactory
-org.apache.sirona.websocket.client.WebSocketClientBuilder.marker = test
-org.apache.sirona.websocket.client.WebSocketClientBuilder.uri = ws://localhost:1235/test-websocket/
-# optional
-org.apache.sirona.websocket.client.WebSocketClientBuilder.retries = 2
-org.apache.sirona.websocket.client.WebSocketClientBuilder.authorization = BASIC xxxxx
-</pre></div>
-<p>If you want to specify websocket for a subset of data store use the following classes:</p>
-
-<ul>
-
-<li><tt>org.apache.sirona.websocket.client.WebSocketCounterDataStore</tt> for counters</li>
-
-<li><tt>org.apache.sirona.websocket.client.WebSocketGaugeDataStore</tt> for gauges</li>
-
-<li><tt>org.apache.sirona.websocket.client.WebSocketNodeStatusDataStore</tt> for validation/status</li>
-</ul></div></div>
-<div class="section">
-<h2>Server<a name="Server"></a></h2>
-<p>You need to add <tt>sirona-websocket-server</tt> dependency and configure the collector in websocket mode (no need of HTTP collector if you don’t use it):</p>
-
-<div class="source">
-<pre>org.apache.sirona.store.status.NodeStatusDataStore = org.apache.sirona.store.status.InMemoryCollectorNodeStatusDataStore
-org.apache.sirona.store.counter.CollectorCounterStore = org.apache.sirona.store.memory.counter.InMemoryCollectorCounterStore
-org.apache.sirona.store.gauge.CollectorGaugeDataStore = org.apache.sirona.store.gauge.DelegatedCollectorGaugeDataStore
-# not yet implemented with websockets so if you use it use http push for path tracking or another one
-org.apache.sirona.store.tracking.PathTrackingDataStore = org.apache.sirona.store.memory.tracking.InMemoryPathTrackingDataStore
-</pre></div>
-<div class="section">
-<h3>Send Period<a name="Send_Period"></a></h3>
-<p>You can also configure the period used to flush periodicly data:</p>
-
-<ul>
-
-<li><tt>org.apache.sirona.websocket.period</tt>: which period to use to push counters data to the server (default to 1mn).</li>
-</ul></div></div>
-<div class="section">
-<h2>Limitations (ATM)<a name="Limitations_ATM"></a></h2>
-<p>You cannot yet use WebSocket for path tracking.</p></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 - WebSocket</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 ">WebSocket</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>WebSocket</h1>
+<p>WebSocket module uses websocket to send data from an instance to a collector.</p>
+<div class="section">
+<h2>Configuration<a name="Configuration"></a></h2>
+<div class="section">
+<h3>Agent/Client<a name="AgentClient"></a></h3>
+<p>You need <tt>sirona-websocket-client</tt> dependency and to add the following configuration in your <tt>sirona.properties</tt>:</p>
+
+<div class="source">
+<pre>org.apache.sirona.store.DataStoreFactory = org.apache.sirona.websocket.client.WebSocketDataStoreFactory
+org.apache.sirona.websocket.client.WebSocketClientBuilder.marker = test
+org.apache.sirona.websocket.client.WebSocketClientBuilder.uri = ws://localhost:1235/test-websocket/
+# optional
+org.apache.sirona.websocket.client.WebSocketClientBuilder.retries = 2
+org.apache.sirona.websocket.client.WebSocketClientBuilder.authorization = BASIC xxxxx
+</pre></div>
+<p>If you want to specify websocket for a subset of data store use the following classes:</p>
+
+<ul>
+
+<li><tt>org.apache.sirona.websocket.client.WebSocketCounterDataStore</tt> for counters</li>
+
+<li><tt>org.apache.sirona.websocket.client.WebSocketGaugeDataStore</tt> for gauges</li>
+
+<li><tt>org.apache.sirona.websocket.client.WebSocketNodeStatusDataStore</tt> for validation/status</li>
+</ul></div></div>
+<div class="section">
+<h2>Server<a name="Server"></a></h2>
+<p>You need to add <tt>sirona-websocket-server</tt> dependency and configure the collector in websocket mode (no need of HTTP collector if you don’t use it):</p>
+
+<div class="source">
+<pre>org.apache.sirona.store.status.NodeStatusDataStore = org.apache.sirona.store.status.InMemoryCollectorNodeStatusDataStore
+org.apache.sirona.store.counter.CollectorCounterStore = org.apache.sirona.store.memory.counter.InMemoryCollectorCounterStore
+org.apache.sirona.store.gauge.CollectorGaugeDataStore = org.apache.sirona.store.gauge.DelegatedCollectorGaugeDataStore
+# not yet implemented with websockets so if you use it use http push for path tracking or another one
+org.apache.sirona.store.tracking.PathTrackingDataStore = org.apache.sirona.store.memory.tracking.InMemoryPathTrackingDataStore
+</pre></div>
+<div class="section">
+<h3>Send Period<a name="Send_Period"></a></h3>
+<p>You can also configure the period used to flush periodicly data:</p>
+
+<ul>
+
+<li><tt>org.apache.sirona.websocket.period</tt>: which period to use to push counters data to the server (default to 1mn).</li>
+</ul></div></div>
+<div class="section">
+<h2>Limitations (ATM)<a name="Limitations_ATM"></a></h2>
+<p>You cannot yet use WebSocket for path tracking.</p></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