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 2015/10/03 10:19:15 UTC
svn commit: r967596 - in /websites/production/camel/content:
cache/main.pageCache splunk.html
Author: buildbot
Date: Sat Oct 3 08:19:15 2015
New Revision: 967596
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 Sat Oct 3 08:19:15 2015
@@ -103,7 +103,7 @@
<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[ from("splunk://normal?delay=5s&username=user&password=123&initEarliestTime=-10s&search=search index=myindex sourcetype=someSourcetype")
.to("direct:search-result");
]]></script>
-</div></div><p>camel-splunk creates a route exchange per search result with a SplunkEvent in the body.</p><h3 id="Splunk-URIOptions">URI Options</h3><div class="confluenceTableSmall"><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Default Value</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Context</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>host</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>localhost</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Both</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Splunk host.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>port</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>8089</p></td><td colspan="1" rowspan="1" class="confluenceTd"
><p>Both</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Splunk port</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">scheme</td><td colspan="1" rowspan="1" class="confluenceTd">https</td><td colspan="1" rowspan="1" class="confluenceTd">Both</td><td colspan="1" rowspan="1" class="confluenceTd">Scheme to use as either http or https</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>username</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>null</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Both</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Username for Splunk</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>password</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>null</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Both</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Password for Splunk</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceT
d"><p>connectionTimeout</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>5000</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Both</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Timeout in MS when connecting to Splunk server</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>useSunHttpsHandler</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>false</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Both</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Use sun.net.www.protocol.https.Handler Https handler to establish the Splunk Connection. <br clear="none"> Can be useful when running in application servers to avoid app. server https handling.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">sslProtocol</td><td colspan="1" rowspan="1" class="confluenceTd">TLSv1.2</td><td colspan="1" rowspan="1" class="confluenceTd">Both</td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Camel
2.16:</strong> The SSL protocol to use. Can be any of TLSv1.2,TLSv1.1,TLSv1,SSLv3. This is only in use if scheme is https</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>index</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>null</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Producer</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Splunk index to write to</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>sourceType</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>null</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Producer</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Splunk sourcetype arguement</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>source</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>null</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Producer</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Splunk sourc
e arguement</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>tcpReceiverPort</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>0</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Producer</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Splunk tcp receiver port when using tcp producer endpoint.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">raw</td><td colspan="1" rowspan="1" class="confluenceTd">false</td><td colspan="1" rowspan="1" class="confluenceTd">Producer</td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.16.0</strong> : Should the body be inserted raw (true/false). <br clear="none">If true, the body will be transformed to a string before it's send to Splunk.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>initEarliestTime</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>null</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Consumer</p></td><t
d colspan="1" rowspan="1" class="confluenceTd"><p>Initial start offset of the first search. Required</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>earliestTime</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>null</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Consumer</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Earliest time of the search time window.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>latestTime</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>null</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Consumer</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Latest time of the search time window.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>count</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>0</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Consumer</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>
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</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>search</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>null</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Consumer</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The Splunk query to run</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>savedSearch</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>null</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Consumer</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The name of the query saved in Splunk to run</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>streaming</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>false</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Consumer</p></t
d><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.14.0</strong> : Stream exchanges as they are received from Splunk, rather than returning all of them in one batch. This has the benefit of receiving results faster, as well as requiring less memory as exchanges aren't buffered in the component.</p></td></tr></tbody></table></div></div><h3 id="Splunk-Messagebody">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"> for the producer. Likewise it will be returned in the body per search result for the consumer.</p><p>As of Camel 2.16.0 you can send raw data to Splunk by setting the raw option on the producer endpoint. This is useful for eg. json/xml and other payloads where Splunk has build in support. </p><h3 id="Splunk-UseCases">Use Cases</h3><p>Search Twitter for tweets with music and publish events to Splunk</p><div class="code panel pdl" style
="border-width: 1px;"><div class="codeContent panelContent pdl">
+</div></div><p>camel-splunk creates a route exchange per search result with a SplunkEvent in the body.</p><h3 id="Splunk-URIOptions">URI Options</h3><div class="confluenceTableSmall"><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Default Value</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Context</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>host</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>localhost</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Both</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Splunk host.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>port</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>8089</p></td><td colspan="1" rowspan="1" class="confluenceTd"
><p>Both</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Splunk port</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">scheme</td><td colspan="1" rowspan="1" class="confluenceTd">https</td><td colspan="1" rowspan="1" class="confluenceTd">Both</td><td colspan="1" rowspan="1" class="confluenceTd">Scheme to use as either http or https</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>username</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>null</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Both</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Username for Splunk</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>password</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>null</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Both</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Password for Splunk</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceT
d"><p>connectionTimeout</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>5000</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Both</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Timeout in MS when connecting to Splunk server</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>useSunHttpsHandler</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>false</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Both</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Use sun.net.www.protocol.https.Handler Https handler to establish the Splunk Connection. <br clear="none"> Can be useful when running in application servers to avoid app. server https handling.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">sslProtocol</td><td colspan="1" rowspan="1" class="confluenceTd">TLSv1.2</td><td colspan="1" rowspan="1" class="confluenceTd">Both</td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Camel
2.16:</strong> The SSL protocol to use. Can be any of TLSv1.2,TLSv1.1,TLSv1,SSLv3. This is only in use if scheme is https</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>index</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>null</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Producer</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Splunk index to write to</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>sourceType</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>null</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Producer</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Splunk sourcetype arguement</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>source</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>null</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Producer</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Splunk sourc
e arguement</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>tcpReceiverPort</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>0</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Producer</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Splunk tcp receiver port when using tcp producer endpoint.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">raw</td><td colspan="1" rowspan="1" class="confluenceTd">false</td><td colspan="1" rowspan="1" class="confluenceTd">Producer</td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.16.0</strong> : Should the body be inserted raw (true/false). <br clear="none">If true, the body will be transformed to a string before it's send to Splunk.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>initEarliestTime</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>null</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Consumer</p></td><t
d colspan="1" rowspan="1" class="confluenceTd"><p>Initial start offset of the first search. Required</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>earliestTime</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>null</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Consumer</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Earliest time of the search time window.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>latestTime</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>null</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Consumer</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Latest time of the search time window.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>count</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>0</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Consumer</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>
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</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>search</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>null</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Consumer</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The Splunk query to run</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>savedSearch</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>null</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Consumer</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The name of the query saved in Splunk to run</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>streaming</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>false</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Consumer</p></t
d><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.14.0</strong> : Stream exchanges as they are received from Splunk, rather than returning all of them in one batch. This has the benefit of receiving results faster, as well as requiring less memory as exchanges aren't buffered in the component.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">eventHost</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"><strong>Camel 2.17:</strong>  Override the default Splunk event host field</td></tr></tbody></table></div></div><h3 id="Splunk-Messagebody">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"> for the producer. Likewise it will be returned in the body per search result for the consumer.</p><p>As of Camel 2.16.
0 you can send raw data to Splunk by setting the raw option on the producer endpoint. This is useful for eg. json/xml and other payloads where Splunk has build in support. </p><h3 id="Splunk-UseCases">Use Cases</h3><p>Search Twitter for tweets with music and publish events to Splunk</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[ from("twitter://search?type=polling&keywords=music&delay=10&consumerKey=abc&consumerSecret=def&accessToken=hij&accessTokenSecret=xxx")
.convertBodyTo(SplunkEvent.class)
.to("splunk://submit?username=foo&password=bar&index=camel-tweets&sourceType=twitter&source=music-tweets");