Skip to content

Niall/kinesis base64 remove #2640

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 23, 2022
Merged

Niall/kinesis base64 remove #2640

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d1b4178
remove base 64 docs
Mar 23, 2022
56fab0a
remove base 64 docs
Mar 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 7 additions & 9 deletions src/connections/destinations/catalog/amazon-kinesis/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,17 +92,15 @@ Let's say you're connecting your Segment customer data stream to Kinesis Stream

The Segment Kinesis destination issues a `PutRecord` request with the following parameters:
```js
kinesis.putRecord({
Data: new Buffer(JSON.stringify(msg)).toString('base64')
PartitionKey: msg.userId() || msg.anonymousId(),
StreamName: 'stream-name'
});
const payload = {
Data: JSON.stringify(msg.json()),
StreamName: this.settings.stream,
PartitionKey: this.settings.useMessageId ? msg.field('messageId') : msg.userId() || msg.anonymousId()
}
const request = kinesis.putRecord(payload)
```

Segment uses the the `userId || anonymousId` as the `PartitionKey`. The partition key is used by Amazon Kinesis to distribute data across shards. Amazon Kinesis segregates the data records that belong to a stream into multiple shards, using the partition key associated with each data record to determine which shard a given data record belongs to.

> note ""
> **NOTE:** The JSON payload is base64 stringified.
Segment uses the `messageId` or the `userId || anonymousId` as the `PartitionKey`. The partition key is used by Amazon Kinesis to distribute data across shards. Amazon Kinesis segregates the data records that belong to a stream into multiple shards, using the partition key associated with each data record to determine which shard a given data record belongs to.

## Group
If you're not familiar with the Segment Specs, take a look to understand what the [Group method](/docs/connections/spec/group/) does.
Expand Down