You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by bu...@apache.org on 2013/10/18 11:18:48 UTC
svn commit: r883106 - in /websites/production/camel/content:
cache/main.pageCache splunk.html
Author: buildbot
Date: Fri Oct 18 09:18:48 2013
New Revision: 883106
Log:
Production update by buildbot for camel
Modified:
websites/production/camel/content/cache/main.pageCache
websites/production/camel/content/splunk.html
Modified: websites/production/camel/content/cache/main.pageCache
==============================================================================
Binary files - no diff available.
Modified: websites/production/camel/content/splunk.html
==============================================================================
--- websites/production/camel/content/splunk.html (original)
+++ websites/production/camel/content/splunk.html Fri Oct 18 09:18:48 2013
@@ -40,6 +40,7 @@
<link href='http://camel.apache.org/styles/highlighter/styles/shThemeCamel.css' rel='stylesheet' type='text/css' />
<script src='http://camel.apache.org/styles/highlighter/scripts/shCore.js' type='text/javascript'></script>
<script src='http://camel.apache.org/styles/highlighter/scripts/shBrushJava.js' type='text/javascript'></script>
+ <script src='http://camel.apache.org/styles/highlighter/scripts/shBrushXml.js' type='text/javascript'></script>
<script type="text/javascript">
SyntaxHighlighter.defaults['toolbar'] = false;
@@ -73,7 +74,7 @@
<div class="top_red_bar">
<div id="site-breadcrumbs">
<!-- Breadcrumbs -->
-<a href="index.html">Apache Camel</a> > <a href="splunk.html">Splunk</a>
+<a href="index.html">Apache Camel</a> > <a href="documentation.html">Documentation</a> > <a href="components.html">Components</a> > <a href="splunk.html">Splunk</a>
</div>
<!-- Quicklinks -->
<div id="site-quicklinks"><p><a shape="rect" href="download.html" title="Download">Download</a> | <a shape="rect" href="javadoc.html" title="JavaDoc">JavaDoc</a> | <a shape="rect" href="source.html" title="Source">Source</a> | <a shape="rect" href="discussion-forums.html" title="Discussion Forums">Forums</a> | <a shape="rect" href="support.html" title="Support">Support</a></p></div>
@@ -85,14 +86,13 @@
<tr>
<td valign="top" width="100%">
<div class="wiki-content maincontent"><h2><a shape="rect" name="Splunk-SplunkComponent"></a>Splunk Component</h2>
-
<p><b>Available as of Camel 2.13</b></p>
<p>The Splunk component provides access to <a shape="rect" class="external-link" href="http://docs.splunk.com/Documentation/Splunk/latest" rel="nofollow">Splunk</a> using the Splunk provided <a shape="rect" class="external-link" href="https://github.com/splunk/splunk-sdk-java" rel="nofollow">client</a> api, and it enables you to publish and search for events in Splunk.</p>
<p>Maven users will need to add the following dependency to their pom.xml for this component:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-splunk</artifactId>
@@ -109,13 +109,12 @@
</div></div>
<h3><a shape="rect" name="Splunk-ProducerEndpoints%3A"></a>Producer Endpoints: </h3>
-
-<div class="table-wrap">
+<div class="confluenceTableSmall"><div class="table-wrap">
<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"> Endpoint </th><th colspan="1" rowspan="1" class="confluenceTh"> Description</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> stream </td><td colspan="1" rowspan="1" class="confluenceTd"> Streams data to a named index or the default if not specified. <br clear="none">
When using stream mode be aware of that Splunk has some internal buffer (about 1MB or so) before events gets to the index. <br clear="none">
If you need realtime, better use submit or tcp mode. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> submit </td><td colspan="1" rowspan="1" class="confluenceTd"> submit mode. Uses Splunk rest api to publish events to a named index or the default if not specified. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> tcp </td><td colspan="1" rowspan="1" class="confluenceTd"> tcp mode. Streams data to a tcp port, and requires a open receiver port in Splunk.</td></tr></tbody></table>
</div>
-
+</div>
<p>When publishing events the message body should contain a SplunkEvent. </p>
@@ -129,11 +128,10 @@ If you need realtime, better use submit
<p>In this example a converter is required to convert to a SplunkEvent class. </p>
<h3><a shape="rect" name="Splunk-ConsumerEndpoints%3A"></a>Consumer Endpoints: </h3>
-
-<div class="table-wrap">
+<div class="confluenceTableSmall"><div class="table-wrap">
<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"> Endpoint </th><th colspan="1" rowspan="1" class="confluenceTh"> Description</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">normal </td><td colspan="1" rowspan="1" class="confluenceTd"> Performs normal search and requires a search query in the search option.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">savedsearch</td><td colspan="1" rowspan="1" class="confluenceTd"> Performs search based on a search query saved in splunk and requires the name of the query in the savedSearch option.</td></tr></tbody></table>
</div>
-
+</div>
<p><b>Example</b></p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
@@ -146,12 +144,12 @@ If you need realtime, better use submit
<p>camel-splunk creates a route exchange per search result with a SplunkEvent in the body. </p>
<h3><a shape="rect" name="Splunk-URIOptions"></a>URI Options</h3>
-<div class="table-wrap">
+<div class="confluenceTableSmall"><div class="table-wrap">
<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"> Name </th><th colspan="1" rowspan="1" class="confluenceTh"> Default Value </th><th colspan="1" rowspan="1" class="confluenceTh"> Context </th><th colspan="1" rowspan="1" class="confluenceTh"> Description </th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">host </td><td colspan="1" rowspan="1" class="confluenceTd"> localhost </td><td colspan="1" rowspan="1" class="confluenceTd"> Both </td><td colspan="1" rowspan="1" class="confluenceTd"> Splunk host.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">port </td><td colspan="1" rowspan="1" class="confluenceTd"> 8089 </td><td colspan="1" rowspan="1" class="confluenceTd"> Both </td><td colspan="1" rowspan="1" class="confluenceTd"> Splunk port</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> username </td><td colspan="1" rowspan="1" class="confluenceTd"> null </td><td colspan="1" rowspan="1" class="confluenceTd">
Both </td><td colspan="1" rowspan="1" class="confluenceTd"> Username for Splunk</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> password </td><td colspan="1" rowspan="1" class="confluenceTd"> null </td><td colspan="1" rowspan="1" class="confluenceTd"> Both </td><td colspan="1" rowspan="1" class="confluenceTd"> Password for Splunk</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> connectionTimeout </td><td colspan="1" rowspan="1" class="confluenceTd"> 5000 </td><td colspan="1" rowspan="1" class="confluenceTd"> Both </td><td colspan="1" rowspan="1" class="confluenceTd"> Timeout in MS when connecting to Splunk server</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> useSunHttpsHandler </td><td colspan="1" rowspan="1" class="confluenceTd"> false </td><td colspan="1" rowspan="1" class="confluenceTd"> Both </td><td colspan="1" rowspan="1" class="confluenceTd"> Use sun.net.www.protocol.https.Handler Https hanlder to establish the Splunk Connection.
<br clear="none">
Can be useful when running in application servers to avoid app. server https handling.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> index </td><td colspan="1" rowspan="1" class="confluenceTd"> null </td><td colspan="1" rowspan="1" class="confluenceTd"> Producer </td><td colspan="1" rowspan="1" class="confluenceTd"> Splunk index to write to</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> sourceType </td><td colspan="1" rowspan="1" class="confluenceTd"> null </td><td colspan="1" rowspan="1" class="confluenceTd"> Producer </td><td colspan="1" rowspan="1" class="confluenceTd"> Splunk sourcetype arguement</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> source </td><td colspan="1" rowspan="1" class="confluenceTd"> null </td><td colspan="1" rowspan="1" class="confluenceTd"> Producer </td><td colspan="1" rowspan="1" class="confluenceTd"> Splunk source arguement</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> tcpReceiverPort </td
><td colspan="1" rowspan="1" class="confluenceTd"> 0 </td><td colspan="1" rowspan="1" class="confluenceTd"> Producer </td><td colspan="1" rowspan="1" class="confluenceTd"> Splunk tcp receiver port when using tcp producer endpoint.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> initEarliestTime </td><td colspan="1" rowspan="1" class="confluenceTd"> null </td><td colspan="1" rowspan="1" class="confluenceTd"> Consumer </td><td colspan="1" rowspan="1" class="confluenceTd"> Initial start offset of the first search. Required</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> earliestTime </td><td colspan="1" rowspan="1" class="confluenceTd"> null </td><td colspan="1" rowspan="1" class="confluenceTd"> Consumer </td><td colspan="1" rowspan="1" class="confluenceTd"> Earliest time of the search time window.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> latestTime </td><td colspan="1" rowspan="1" class="confluenceTd"> null </td><td colspan="1" rowsp
an="1" class="confluenceTd"> Consumer </td><td colspan="1" rowspan="1" class="confluenceTd"> Latest time of the search time window.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> count </td><td colspan="1" rowspan="1" class="confluenceTd"> 0 </td><td colspan="1" rowspan="1" class="confluenceTd"> Consumer </td><td colspan="1" rowspan="1" class="confluenceTd"> A number that indicates the maximum number of entities to return. <br clear="none">
Note this is not the same as maxMessagesPerPoll which currently is unsupported</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> search </td><td colspan="1" rowspan="1" class="confluenceTd"> null </td><td colspan="1" rowspan="1" class="confluenceTd"> Consumer </td><td colspan="1" rowspan="1" class="confluenceTd"> The Splunk query to run</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> savedSearch </td><td colspan="1" rowspan="1" class="confluenceTd"> null </td><td colspan="1" rowspan="1" class="confluenceTd"> Consumer </td><td colspan="1" rowspan="1" class="confluenceTd"> The name of the query saved in Splunk to run</td></tr></tbody></table>
</div>
-
+</div>
<h3><a shape="rect" name="Splunk-Messagebody"></a>Message body</h3>
<p>Splunk operates on data in key/value pairs. The SplunkEvent class is a placeholder for such data, and should be in the message body <br clear="none">
@@ -205,9 +203,16 @@ public class Tweet2SplunkEvent {
]]></script>
</div></div>
+
<h3><a shape="rect" name="Splunk-Othercomments"></a>Other comments</h3>
+
<p>Splunk comes with a variety of options for leveraging machine generated data with prebuilt apps for analyzing and displaying this. <br clear="none">
For example the jmx app. could be used to publish jmx attributes, eg. route and jvm metrics to Splunk, and displaying this on a dashboard.</p>
+
+
+<h3><a shape="rect" name="Splunk-SeeAlso"></a>See Also</h3>
+<ul><li><a shape="rect" href="configuring-camel.html" title="Configuring Camel">Configuring Camel</a></li><li><a shape="rect" href="component.html" title="Component">Component</a></li><li><a shape="rect" href="endpoint.html" title="Endpoint">Endpoint</a></li><li><a shape="rect" href="getting-started.html" title="Getting Started">Getting Started</a></li></ul>
+
</div>
</td>
<td valign="top">