https://github.com/edgee-cloud/amazon-kinesis-component
Amazon Kinesis Edgee Component
https://github.com/edgee-cloud/amazon-kinesis-component
Last synced: 2 months ago
JSON representation
Amazon Kinesis Edgee Component
- Host: GitHub
- URL: https://github.com/edgee-cloud/amazon-kinesis-component
- Owner: edgee-cloud
- License: apache-2.0
- Created: 2025-02-17T22:54:54.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-02-27T17:35:41.000Z (3 months ago)
- Last Synced: 2025-03-11T07:45:31.253Z (2 months ago)
- Language: Rust
- Size: 55.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Amazon Kinesis component for Edgee
[](https://coveralls.io/github/edgee-cloud/amazon-kinesis-component)
[](https://github.com/edgee-cloud/amazon-kinesis-component/issues)
[](https://www.edgee.cloud/edgee/amazon-kinesis-component)
This component enables seamless integration between [Edgee](https://www.edgee.cloud) and [Amazon Kinesis](https://aws.amazon.com/kinesis/), allowing you to collect and forward analytics events to your streaming pipelines.
## Quick Start
1. Download the latest component version from our [releases page](../../releases)
2. Place the `kinesis.wasm` file in your server (e.g., `/var/edgee/components`)
3. Add the following configuration to your `edgee.toml`:
```toml
[[destinations.data_collection]]
id = "kinesis"
file = "/var/edgee/components/kinesis.wasm"
settings.aws_access_key = "YOUR_AWS_ACCESS_KEY"
settings.aws_secret_key = "YOUR_AWS_SECRET_KEY"
settings.aws_region = "YOUR_AWS_REGION"
settings.kinesis_stream = "YOUR_STREAM_NAME_OR_ARN"
```
## Event Handling
### Event Mapping
The component maps Edgee events to Kinesis records as follows:
| Edgee Event | Kinesis record | Description |
|-------------|----------------|-------------|
| Page | `full-event.json` | Full JSON dump of the Page event |
| Track | `full-event.json` | Full JSON dump of the Track event |
| User | `full-event.json` | Full JSON dump of the User event |
## Configuration Options
### Basic Configuration
```toml
[[destinations.data_collection]]
id = "kinesis"
file = "/var/edgee/components/kinesis.wasm"
settings.aws_access_key = "YOUR_AWS_ACCESS_KEY"
settings.aws_secret_key = "YOUR_AWS_SECRET_KEY"
settings.aws_region = "YOUR_AWS_REGION"
settings.kinesis_stream = "YOUR_STREAM_NAME_OR_ARN"
# Optional configurations
settings.aws_session_token = "YOUR_AWS_SESSION_TOKEN" # Useful for tests, not recommended in prod since it's short-lived
settings.kinesis_partition = "static-partition-key" # Optional, used for all PutRecord calls
```
### Event Controls
Control which events are forwarded to Amazon Kinesis:
```toml
settings.edgee_page_event_enabled = true # Enable/disable page view tracking
settings.edgee_track_event_enabled = true # Enable/disable custom event tracking
settings.edgee_user_event_enabled = true # Enable/disable user identification
```
## Development
### Building from Source
Prerequisites:
- [Rust](https://www.rust-lang.org/tools/install)
- wit-deps: `cargo install wit-deps`
Build command:
```bash
make build
```
Test command:
```bash
make test
```
Test coverage command:
```bash
make test.coverage[.html]
```
### Contributing
Interested in contributing? Read our [contribution guidelines](./CONTRIBUTING.md)
### Security
Report security vulnerabilities to [[email protected]](mailto:[email protected])