Skip to content

Commit 2bc8529

Browse files
NathenSampleNathenSample
committed
Comitting Website revitilisation Trello
1 parent f6a158b commit 2bc8529

30 files changed

+3218
-995
lines changed

‎alerts-emailaction.html

+41-1
Original file line numberDiff line numberDiff line change
@@ -309,7 +309,47 @@ <h4>Sorted Events Key Map</h4>
309309
</ul>
310310
<h4>Writing to a Database </h4>
311311
<p>This examples writes the events level and message to a database.</p>
312-
<blockquote>sql = Sql.newInstance("jdbc:sqlite:C:/home/logscape/work/trigger-data.db","org.sqlite.JDBC") </blockquote>
312+
<blockquote>
313+
sql = Sql.newInstance("jdbc:sqlite:C:/home/logscape/work/trigger-data.db","org.sqlite.JDBC")
314+
sortedEvents.each(){ event - \n
315+
server = event["server"]
316+
date = event["Date"]
317+
level = event["Level"]
318+
exception = event["Exception"]
319+
sql.execute("INSERT INTO events (date,host,logLevel,message) VALUES ("+date+","+server+","+level+","+exception+")" )
320+
</blockquote>
321+
<h3>Groovy Script </h3>
322+
<p>When an alert is fired a groovy script is executed when scripts actions are enabled. The groovy script has access to all the event details related to the triggering alert. A HashMap <em>sortedEvents </em>is made available to the groovy script and can used to siphon data out of Logscape into other systems, e.g tickets systems, message buses databases and so on.</p>
323+
<h4>Sorted Events Key Map</h4>
324+
<p>The events key map contains the following the keys: </p>
325+
<ul> <strong>Alert Details </strong>
326+
<li>name - Alert name </li>
327+
<li>triggerSearch - The trigger search assigned to the alert</li>
328+
<li>triggerCount - the number of events need to trigger the alert </li><strong> Trigger Events </strong>
329+
<li>event - all the trigger events as a map</li>
330+
<li>textEvents - the raw trigger events as it appears in the original data</li>
331+
<li>sortedEvents - the events sorted</li>
332+
<li>sortedMap - a key value sorted list of the events</li><strong> Other </strong>
333+
<li>sysout - use this to print to the Logscape system console</li>
334+
<li>log - use this to output data into Logscape log file </li>
335+
<li>currentTime - The time the alert is fired </li>
336+
</ul>
337+
<div class="row">
338+
<div class="col-md-11"><br/><br/><br/>
339+
<div id="disqus_thread">
340+
<script>
341+
/* * * CONFIGURATION VARIABLES: EDIT BEFORE PASTING INTO YOUR WEBPAGE * * */
342+
var disqus_shortname = 'logscape'; // required: replace example with your forum shortname
343+
/* * * DON'T EDIT BELOW THIS LINE * * */
344+
(function() {
345+
var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
346+
dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';
347+
(document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
348+
})();
349+
</script>
350+
</div>
351+
</div>
352+
</div>
313353
</div>
314354
</div>
315355
</div>

‎alerts-examples-highcpualert.html

-1
Original file line numberDiff line numberDiff line change
@@ -261,7 +261,6 @@ <h4>Articles </h4>
261261
<h3>Alerts High Cpu Example </h3>
262262
<p>An alert can use a standard schedule, which executes the trigger search retrospectively or it can be realtime, reporting on events as they occur. The choice between a historical or realtime alert schedule depends on the alert situation. </p>
263263
<p>Let's walk through a High Cpu Alert. The trigger search for this alert is as follows:</p>
264-
<div class="image"><img src="image/alert-examples-highcpualert-triggersearch.png"/></div>
265264
<p> </p>
266265
<div class="image"><img src="images/alerts-examples-highcpualert-general.png"/><img src="images/alerts-examples-highcpualert-trigger.png"/><img src="images/alerts-examples-highcpualert-actions.png"/></div>
267266
</div>

‎alerts-groovyaction.html

+4-6
Original file line numberDiff line numberDiff line change
@@ -259,16 +259,14 @@ <h4>Articles </h4>
259259
<div class="row">
260260
<div class="col-md-8">
261261
<h3>Groovy Script Action </h3>
262-
<p>When an alert is fired a groovy script is executed when scripts actions are enabled. The groovy script has access to all the event details related to the triggering alert. A HashMap <em>sortedEvents </em>is made available to the groovy script and can used to siphon data out of Logscape into other systems, e.g tickets systems, message buses databases and so on.</p>
263-
<h4>Sorted Events Key Map</h4>
264-
<p>The events key map contains the following the keys: </p>
262+
<p>When an alert is fired a groovy script is executed when scripts actions are enabled. The groovy script has access to the following variables - </p>
265263
<ul> <strong>Alert Details </strong>
266264
<li>name - Alert name </li>
267265
<li>triggerSearch - The trigger search assigned to the alert</li>
268266
<li>triggerCount - the number of events need to trigger the alert </li><strong> Trigger Events </strong>
269-
<li>event - all the trigger events as a map</li>
270-
<li>textEvents - the raw trigger events as it appears in the original data</li>
271-
<li>sortedEvents - the events sorted</li>
267+
<li>event - all the trigger events as an array</li>
268+
<li>textEvents - the raw trigger events as it appears in the original data, stored asn array</li>
269+
<li>sortedEvents - the events sorted, as an arrya</li>
272270
<li>sortedMap - a key value sorted list of the events</li><strong> Other </strong>
273271
<li>sysout - use this to print to the Logscape system console</li>
274272
<li>log - use this to output data into Logscape log file </li>

‎alerts-streaming-clients-js.html

+17
Original file line numberDiff line numberDiff line change
@@ -273,8 +273,25 @@ <h3>Testing the Websocket Server</h3>
273273
li put on git hub logscape/streaming-clients/js
274274
275275
p http://stackoverflow.com/questions/13672490/real-time-data-with-d3
276+
276277
-->
277278
</div>
279+
<div class="row">
280+
<div class="col-md-11"><br/><br/><br/>
281+
<div id="disqus_thread">
282+
<script>
283+
/* * * CONFIGURATION VARIABLES: EDIT BEFORE PASTING INTO YOUR WEBPAGE * * */
284+
var disqus_shortname = 'logscape'; // required: replace example with your forum shortname
285+
/* * * DON'T EDIT BELOW THIS LINE * * */
286+
(function() {
287+
var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
288+
dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';
289+
(document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
290+
})();
291+
</script>
292+
</div>
293+
</div>
294+
</div>
278295
</div>
279296
</div>
280297
</div>

‎alerts-trigger_tab.html

+19-1
Original file line numberDiff line numberDiff line change
@@ -268,7 +268,25 @@ <h3>Trigger Tab </h3>
268268
<p>The alert will trigger when the cpu field value is greater than 80%.</p><strong>Correlatation</strong>
269269
<p>Correlated events are used to study a time window for a sequence of values, or average. While correlated events can be used on almost any form of data, they’re at their best when dealing with data such as audit or webserver logs due to the nature of key value pair error codes, but they will excel in any environment that makes use of error messages or codes.</p>
270270
<p>Correlation events have the following fields</p>
271-
<blockquote>Time Window - The window in seconds to look for your event value<br/>Type - Sequence or Average</blockquote>
271+
<blockquote>Time Window - The window in seconds to look for your event value<br/>Type - Sequence or Average<br/>Event Value - The sequence(comma seperated or average value to look for)<br/>Correlation Field - The field to check<br/>Correlation Key - Additional field, Allows you to group values, i.e _host, would mean all values would need to be from one host</blockquote>
272+
<div class="image"><img src="images/alerts-correlated.png"/></div>
273+
<p>Specifying your type as sequence means that the event must occur N times in a row, without another event inbetween, using the correlation field it is possible to group the events, by for example host, meaning N events in a row must originate from the same host, and events from other hosts will not infringe upon this, When choosing sequence, the values to look for must be added to the event value field and seperated by comma's. Choosing avg will simply average the value over the duration of your capture period.</p>
274+
</div>
275+
</div>
276+
<div class="row">
277+
<div class="col-md-11"><br/><br/><br/>
278+
<div id="disqus_thread">
279+
<script>
280+
/* * * CONFIGURATION VARIABLES: EDIT BEFORE PASTING INTO YOUR WEBPAGE * * */
281+
var disqus_shortname = 'logscape'; // required: replace example with your forum shortname
282+
/* * * DON'T EDIT BELOW THIS LINE * * */
283+
(function() {
284+
var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
285+
dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';
286+
(document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
287+
})();
288+
</script>
289+
</div>
272290
</div>
273291
</div>
274292
</div>

‎apps-intro.html

+3-1
Original file line numberDiff line numberDiff line change
@@ -267,7 +267,9 @@ <h3>Logscape Apps</h3>
267267
</ul>
268268
</p>
269269
<p><strong> The Bundle - </strong>Is an xml document that contains a description of what services a Logscape App will execute. In each service description there is a schedule parameter which controls when the Apps service is executed</p>
270-
<p><strong>Config File</strong> - The config file contains all the Searches, Workspaces, types and sources that the App needs to run. </p>
270+
<p><strong>Config File</strong> - The config file contains all the Searches, Workspaces, types and sources that the App needs to run.
271+
- Config file names must be unique within the environment
272+
</p>
271273
<p><strong>scripts -</strong> These are the programs or scripts that are executed by the service sections in the bundle file.
272274

273275
</p>

0 commit comments

Comments
 (0)