Skip to content

Connector implementation for sending messages arriving at Kinesis stream to ThingWorx platform. Connector listens to Kinesis Data stream using 'Spring Cloud Stream Binder Kinesis' library, provides them to a pool of connectors through JMS, which then publish the messages via WebSocket channel.

Notifications You must be signed in to change notification settings

unni-vp/thingworx-kinesis-connector

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

thingworx-kinesis-connector

Connector implementation for sending messages arriving at Kinesis stream to ThingWorx platform. Connector listens to Kinesis Data stream using 'Spring Cloud Stream Binder Kinesis' library, provides them to a pool of connectors through JMS, which then publishes the messages via WebSocket channel.

Pre-launch Configuration

Modify the 'application.yml' file before you launch the application. The below properties need to be specified:

Cloud and Kinesis configurations

  • cloud.aws.credentials : Specify the AWS access-key and secret-key required for accessing the Kinesis Data stream resource.
  • cloud.aws.region.static : Region for the Kinesis Data stream resource.
  • spring.cloud.stream.bindings.input.destination : Name of the Kinesis Data stream for consumption.

ThingWorx configurations

  • connectorCount : The number of connectors require to process the incoming telemetry messages. Identify a count according to your requiremnts. Can be set as low as 1 for low volume streaming data and as high as 1000 for high volume streaming data.
  • host : Host name of Thingworx Foundation server
  • port : Port of Thingworx Foundation server
  • secureConnection : Provide this as 'true' if using a secure (https) connection, else 'false'
  • appKey : Thingworx application key that provides service execution permissions for the telemetry and health services
  • telemetryThing : The Thing containing the service for telemetry processing
  • telemetryService : The ThingWorx service that processes the telemetry message.
  • healthThing : The Thing containing the service for health check
  • healthService : The ThingWorx service that performs health check.

Note : A sample ThingWorx entity can be found in the 'entities' folder. The 'Thing' entity has sample services for telemetry processing and health check.

Installation

Use maven to compile and build project:

mvn clean install 

Run the spring-boot application:

mvn spring-boot:run

Disclaimer: This is a proof-of -concept project, meant to demonstrate ThingWorx websocket based ingestion from AWS Kinesis. It would not be advisable to use this as is in a production environment. Ideally the internal JMS implementation for message queuing, should be replaced with an external queue implementation (AWS SQS, Kafka) to manage memory, scale and performance.

About

Connector implementation for sending messages arriving at Kinesis stream to ThingWorx platform. Connector listens to Kinesis Data stream using 'Spring Cloud Stream Binder Kinesis' library, provides them to a pool of connectors through JMS, which then publish the messages via WebSocket channel.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages