Skip to content

Commit c4970af

Browse files
committed
Bump the version and add documentation.
1 parent 9c7a992 commit c4970af

File tree

4 files changed

+50
-4
lines changed

4 files changed

+50
-4
lines changed

docs/introduction.rst

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
================
2+
Splunk Connector
3+
================
4+
5+
The Splunk Connector provides a :term:`Source Connector` that emulates a Splunk HEC endpoint and a :term:`Source Connector`
6+
that can be used to write data to a Splunk HEC endpoint.
7+
8+
.. toctree::
9+
:maxdepth: 1
10+
:caption: Source Connectors:
11+
:hidden:
12+
:glob:
13+
14+
sources/*
15+
16+
17+
.. toctree::
18+
:maxdepth: 1
19+
:caption: Sink Connectors:
20+
:hidden:
21+
:glob:
22+
23+
sinks/*
24+
25+
26+
.. toctree::
27+
:maxdepth: 1
28+
:caption: Transformations:
29+
:hidden:
30+
:glob:
31+
32+
transformations/*
33+
34+
35+
.. toctree::
36+
:maxdepth: 0
37+
:caption: Schemas:
38+
:hidden:
39+
40+
schemas
41+
42+

pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
<parent>
2424
<groupId>com.github.jcustenborder.kafka.connect</groupId>
2525
<artifactId>kafka-connect-parent</artifactId>
26-
<version>0.10.2.0-cp1</version>
26+
<version>0.10.2.1-cp1</version>
2727
</parent>
2828
<artifactId>kafka-connect-splunk</artifactId>
2929
<version>0.2.0-SNAPSHOT</version>

src/main/java/com/github/jcustenborder/kafka/connect/splunk/SplunkHttpSinkConnector.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
import java.util.Map;
2929

3030
@Description("The Sink Connector will transform data from a Kafka topic into a batch of json messages that will be written via HTTP to " +
31-
"a configured [Splunk Http Event Collector](http://dev.splunk.com/view/event-collector/SP-CAAAE6M).")
31+
"a configured `Splunk Http Event Collector` <http://dev.splunk.com/view/event-collector/SP-CAAAE6M>`.")
3232
public class SplunkHttpSinkConnector extends SinkConnector {
3333
private static Logger log = LoggerFactory.getLogger(SplunkHttpSinkConnector.class);
3434
Map<String, String> settings;

src/main/java/com/github/jcustenborder/kafka/connect/splunk/SplunkHttpSourceConnector.java

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717

1818
import com.github.jcustenborder.kafka.connect.utils.VersionUtil;
1919
import com.github.jcustenborder.kafka.connect.utils.config.Description;
20+
import com.github.jcustenborder.kafka.connect.utils.config.DocumentationImportant;
2021
import org.apache.kafka.common.config.ConfigDef;
2122
import org.apache.kafka.connect.connector.Task;
2223
import org.apache.kafka.connect.source.SourceConnector;
@@ -25,10 +26,13 @@
2526
import java.util.List;
2627
import java.util.Map;
2728

28-
@Description("The Splunk Source connector allows emulates a [Splunk Http Event Collector](http://dev.splunk.com/view/event-collector/SP-CAAAE6M) to allow " +
29+
@Description("The Splunk Source connector allows emulates a `Splunk Http Event Collector` <http://dev.splunk.com/view/event-collector/SP-CAAAE6M> to allow " +
2930
"application that normally log to Splunk to instead write to Kafka. The goal of this plugin is to make the change nearly " +
30-
"transparent to the user. This plugin currently has support for [X-Forwarded-For](https://en.wikipedia.org/wiki/X-Forwarded-For) so " +
31+
"transparent to the user. This plugin currently has support for `X-Forwarded-For <https://en.wikipedia.org/wiki/X-Forwarded-For>` so " +
3132
"it will sit behind a load balancer nicely.")
33+
@DocumentationImportant("This connector listens on a network port. Running more than one task or running in distributed " +
34+
"mode can cause some undesired effects if another task already has the port open. It is recommended that you run this " +
35+
"connector in :term:`Standalone Mode`.")
3236
public class SplunkHttpSourceConnector extends SourceConnector {
3337
Map<String, String> settings;
3438
private SplunkHttpSourceConnectorConfig config;

0 commit comments

Comments
 (0)