README
¶
VMWare Go KCL v2
Overview
VMware-Go-KCL-V2 is a native open-source Go library for Amazon Kinesis Data Stream (KDS) consumption. It allows developers to program KDS consumers in lightweight Go language and still take advantage of the features presented by the native KDS Java API libraries.
vmware-go-kcl-v2 is a VMWare originated open-source project for AWS Kinesis Client Library in Go. Within VMware, we have seen adoption in vSecureState and Carbon Black. In addition, Carbon Black has contributed to the vmware-go-kcl codebase and heavily used it in the product. Besides, vmware-go-kcl-v2 has got recognition, and contributions from the industry.
vmware-go-kcl-v2 is the v2 version of VMWare KCL for the Go programming language by utilizing AWS Go SDK V2.
Try it out
Prerequisites
- aws-sdk-go-v2
- The v2 SDK requires a minimum version of
Go 1.17. - gosec
Build & Run
-
Initialize Project
-
Build
make build -
Test
make test
Documentation
VMware-Go-KCL matches exactly the same interface and programming model from original Amazon KCL, the best place for getting reference, tutorial is from Amazon itself:
Contributing
The vmware-go-kcl-v2 project team welcomes contributions from the community. Before you start working with vmware-go-kcl-v2, please read our Developer Certificate of Origin. All contributions to this repository must be signed as described on that page. Your signature certifies that you wrote the patch or have the right to pass it on as an open-source patch. For more detailed information, refer to CONTRIBUTING.md.
License
MIT License
Directories
¶
| Path | Synopsis |
|---|---|
|
clientlibrary
|
|
|
checkpoint
Package checkpoint The implementation is derived from https://github.com/patrobinson/gokini
|
Package checkpoint The implementation is derived from https://github.com/patrobinson/gokini |
|
interfaces
Package interfaces The implementation is derived from https://github.com/awslabs/amazon-kinesis-client
|
Package interfaces The implementation is derived from https://github.com/awslabs/amazon-kinesis-client |
|
metrics
Package metrics The implementation is derived from https://github.com/patrobinson/gokini
|
Package metrics The implementation is derived from https://github.com/patrobinson/gokini |
|
metrics/cloudwatch
Package cloudwatch The implementation is derived from https://github.com/patrobinson/gokini
|
Package cloudwatch The implementation is derived from https://github.com/patrobinson/gokini |
|
metrics/prometheus
Package prometheus The implementation is derived from https://github.com/patrobinson/gokini
|
Package prometheus The implementation is derived from https://github.com/patrobinson/gokini |
|
partition
Package partition The implementation is derived from https://github.com/patrobinson/gokini
|
Package partition The implementation is derived from https://github.com/patrobinson/gokini |
|
utils
Package utils
|
Package utils |
|
worker
Package worker
|
Package worker |
|
zerolog
Package zerolog implements the KCL logger using RS Zerolog logger
|
Package zerolog implements the KCL logger using RS Zerolog logger |