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 2015/11/02 05:45:52 UTC
svn commit: r1711897 - in /incubator/sirona/site: alerts.html concepts.html
Author: rmannibucau
Date: Mon Nov 2 04:45:52 2015
New Revision: 1711897
URL: http://svn.apache.org/viewvc?rev=1711897&view=rev
Log:
Site checkin for project Apache Sirona Incubator
Added:
incubator/sirona/site/alerts.html
Modified:
incubator/sirona/site/concepts.html
Added: incubator/sirona/site/alerts.html
URL: http://svn.apache.org/viewvc/incubator/sirona/site/alerts.html?rev=1711897&view=auto
==============================================================================
--- incubator/sirona/site/alerts.html (added)
+++ incubator/sirona/site/alerts.html Mon Nov 2 04:45:52 2015
@@ -0,0 +1,350 @@
+<!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="20151101" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Apache Sirona - AlertListener</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="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.2-incubating" title="Last Release Docs 0.2-incubating">Last Release Docs 0.2-incubating</a>
+</li>
+
+ <li> <a href="releases/release-notes-0.2-incubating.html" title="Last Release 0.2-incubating Changelog">Last Release 0.2-incubating Changelog</a>
+</li>
+
+ <li> <a href="docs/0.3-incubating-SNAPSHOT" title="Dev Docs 0.3-incubating-SNAPSHOT">Dev Docs 0.3-incubating-SNAPSHOT</a>
+</li>
+
+ <li> <a href="docs/0.3-incubating-SNAPSHOT/jira-report.html" title="Dev Changelog 0.3-incubating-SNAPSHOT">Dev Changelog 0.3-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 ">AlertListener</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 01 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>AlertListener</h1>
+<p><tt>AlertListener</tt> can be registered on <tt>NodeStatusDataStore</tt> either programmatically using <tt>addAlerter()</tt>/<tt>removeAlerter()</tt> or through sirona configuration (aka sirona.properties).</p>
+<div class="section">
+<h2>Configuration<a name="Configuration"></a></h2>
+<p>The configuration is based on the key: <tt>org.apache.sirona.alerters</tt>. The value is a list of alerter name/alias:</p>
+
+<div>
+<pre class="prettyprint linenums">
+org.apache.sirona.alerters = mail,webhook
+</pre></div>
+<p>The class of the alerter is set using <tt>{alerterName}.class</tt>:</p>
+
+<div>
+<pre class="prettyprint linenums">
+mail.class = com.company.sirona.alerter.MailAlerter
+</pre></div>
+<p>The alerters are then configured individually using <tt>@AutoSet</tt> feature of sirona:</p>
+
+<div>
+<pre class="prettyprint linenums">
+# just a sample of an optional config
+mail.host = xxxxx
+mail.password = ...
+mail.protocol = smtp
+</pre></div></div>
+<div class="section">
+<h2>MailAlerter<a name="MailAlerter"></a></h2>
+<p><tt>sirona-alerter-mail</tt> provides a javamail alerter.</p>
+<p>Here is the configuration supposing your alerter is named <tt>mail</tt>:</p>
+
+<div>
+<pre class="prettyprint linenums">
+mail.from = me@provider.com
+mail.port = 1234
+mail.host = provider.com
+mail.to = target@provider.com
+mail.user = xxx
+mail.password = xxx
+mail.timeout = 60000
+mail.tls = true
+mail.auth = true
+mail.protocol = smtp
+mail.template = ${marker} throw an alert for:\n${resultsCsv}
+mail.subjectTemplate = ${marker} throw an alert at ${date}
+
+
+# true to use the default javamail session with the previous configuration (Session.getDefaultInstance())
+mail.useDefault = false
+</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>
+</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=1711897&r1=1711896&r2=1711897&view=diff
==============================================================================
--- incubator/sirona/site/concepts.html (original)
+++ incubator/sirona/site/concepts.html Mon Nov 2 04:45:52 2015
@@ -346,6 +346,9 @@ public interface Validation {
<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>