generated from jcustenborder/kafka-connect-template
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Initial commit. * Changed to kafka-connect-transform-opentsdb
- Loading branch information
1 parent
6724db9
commit 42e8279
Showing
19 changed files
with
379 additions
and
448 deletions.
There are no files selected for viewing
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,66 @@ | ||
# Introduction | ||
[Documentation](https://jcustenborder.github.io/kafka-connect-documentation/projects/kafka-connect-transform-opentsdb) | [Confluent Hub](https://www.confluent.io/hub/jcustenborder/kafka-connect-transform-opentsdb) | ||
|
||
This is a template repository for creating Kafka Connect Plugins. | ||
The plugin provides a mechanism to parse the wire format for OpenTSDB. | ||
|
||
# Installation | ||
|
||
## Confluent Hub | ||
|
||
The following command can be used to install the plugin directly from the Confluent Hub using the | ||
[Confluent Hub Client](https://docs.confluent.io/current/connect/managing/confluent-hub/client.html). | ||
|
||
```bash | ||
confluent-hub install jcustenborder/kafka-connect-transform-opentsdb:latest | ||
``` | ||
|
||
## Manually | ||
|
||
The zip file that is deployed to the [Confluent Hub](https://www.confluent.io/hub/jcustenborder/kafka-connect-transform-opentsdb) is available under | ||
`target/components/packages/`. You can manually extract this zip file which includes all dependencies. All the dependencies | ||
that are required to deploy the plugin are under `target/kafka-connect-target` as well. Make sure that you include all the dependencies that are required | ||
to run the plugin. | ||
|
||
1. Create a directory under the `plugin.path` on your Connect worker. | ||
2. Copy all of the dependencies under the newly created subdirectory. | ||
3. Restart the Connect worker. | ||
|
||
|
||
|
||
|
||
# Transformations | ||
## [Parse OpenTSDB transformation](https://jcustenborder.github.io/kafka-connect-documentation/projects/kafka-connect-transform-opentsdb/transformations/ParseOpenTSDB.html) | ||
|
||
*Key* | ||
``` | ||
com.github.jcustenborder.kafka.connect.opentsdb.ParseOpenTSDB$Key | ||
``` | ||
*Value* | ||
``` | ||
com.github.jcustenborder.kafka.connect.opentsdb.ParseOpenTSDB$Value | ||
``` | ||
|
||
The ParseOpenTSDB transformation will parse data that is formatted with the OpenTSDB wire protocol. | ||
### Tip | ||
|
||
This transformation expects data to be a String. You are most likely going to use the StringConverter. | ||
### Configuration | ||
|
||
|
||
|
||
|
||
# Development | ||
|
||
## Building the source | ||
|
||
```bash | ||
mvn clean package | ||
``` | ||
|
||
## Contributions | ||
|
||
Contributions are always welcomed! Before you start any development please create an issue and | ||
start a discussion. Create a pull request against your newly created issue and we're happy to see | ||
if we can merge your pull request. First and foremost any time you're adding code to the code base | ||
you need to include test coverage. Make sure that you run `mvn clean package` before submitting your | ||
pull to ensure that all of the tests, checkstyle rules, and the package can be successfully built. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -26,11 +26,11 @@ | |
<artifactId>kafka-connect-parent</artifactId> | ||
<version>2.4.0</version> | ||
</parent> | ||
<artifactId>kafka-connect-example</artifactId> | ||
<artifactId>kafka-connect-opentsdb</artifactId> | ||
<version>0.0.2-SNAPSHOT</version> | ||
<name>kafka-connect-example</name> | ||
<name>kafka-connect-opentsdb</name> | ||
<description>A Kafka Connect connector receiving data from example.</description> | ||
<url>https://github.com/jcustenborder/kafka-connect-example</url> | ||
<url>https://github.com/jcustenborder/kafka-connect-opentsdb</url> | ||
<inceptionYear>2019</inceptionYear> | ||
<licenses> | ||
<license> | ||
|
@@ -50,14 +50,14 @@ | |
</developer> | ||
</developers> | ||
<scm> | ||
<connection>scm:git:https://github.com/jcustenborder/kafka-connect-example.git</connection> | ||
<developerConnection>scm:git:[email protected]:jcustenborder/kafka-connect-example.git | ||
<connection>scm:git:https://github.com/jcustenborder/kafka-connect-opentsdb.git</connection> | ||
<developerConnection>scm:git:[email protected]:jcustenborder/kafka-connect-opentsdb.git | ||
</developerConnection> | ||
<url>https://github.com/jcustenborder/kafka-connect-example</url> | ||
<url>https://github.com/jcustenborder/kafka-connect-opentsdb</url> | ||
</scm> | ||
<issueManagement> | ||
<system>github</system> | ||
<url>https://github.com/jcustenborder/kafka-connect-example/issues</url> | ||
<url>https://github.com/jcustenborder/kafka-connect-opentsdb/issues</url> | ||
</issueManagement> | ||
<dependencies/> | ||
<build> | ||
|
This file was deleted.
Oops, something went wrong.
24 changes: 0 additions & 24 deletions
24
src/main/connect-config-classes/ExampleSinkConnectorConfig.json
This file was deleted.
Oops, something went wrong.
24 changes: 0 additions & 24 deletions
24
src/main/connect-config-classes/ExampleSourceConnectorConfig.json
This file was deleted.
Oops, something went wrong.
61 changes: 0 additions & 61 deletions
61
src/main/connect-config-classes/ExampleTransformationConfig.json
This file was deleted.
Oops, something went wrong.
68 changes: 0 additions & 68 deletions
68
src/main/java/com/github/jcustenborder/kafka/connect/example/ExampleSinkConnector.java
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.