Skip to content
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.

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

Snowbridge v3 #1068

Open
wants to merge 65 commits into
base: main
Choose a base branch
from
Open

Snowbridge v3 #1068

wants to merge 65 commits into from

Conversation

colmsnowplow
Copy link
Contributor

PR to update docs for Snowbridge v3

Things to check:

@pondzix - I would appreciate your paying close attention to whether everything is accurate. Specifically I'm not 100% sure of the part that states that setup errors mean we'll stop processing all data for the retry period. Is that accurate?

@stanch - in addition to a normal PR review, I have marked some features as beta, wdyt about this? Happy to discuss to explain!

Copy link

netlify bot commented Nov 7, 2024

Deploy Preview for snowplow-docs ready!

Name Link
🔨 Latest commit 89e985e
🔍 Latest deploy log https://app.netlify.com/sites/snowplow-docs/deploys/67a4ff727d8e4e000845c754
😎 Deploy Preview https://deploy-preview-1068--snowplow-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@colmsnowplow colmsnowplow requested a review from pondzix November 7, 2024 16:56
@colmsnowplow
Copy link
Contributor Author

Note that we may wish to hold off on merging until such a time as we're ready to announce

@pkutaj pkutaj closed this Jan 8, 2025
@pkutaj pkutaj deleted the snowbridge-v3 branch January 8, 2025 11:38
@colmsnowplow colmsnowplow restored the snowbridge-v3 branch January 15, 2025 13:26
@colmsnowplow
Copy link
Contributor Author

@pkutaj any reason this was closed, or was it done in error?

@pondzix pondzix reopened this Jan 20, 2025
@pkutaj
Copy link
Contributor

pkutaj commented Jan 20, 2025

That was surely my mistake, thanks Piotr for re-opening!


Note that this is a breaking change to the pre-v3 default behaviour, in two ways:

1. Previously to v3, we sent data one request per message
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe these could be subheadings rather than numbered list? for visibility


1. Previously to v3, we sent data one request per message

This means that where no template is provided, request bodies will be arrays of JSON rather than individual JSON objects.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This means that where no template is provided, request bodies will be arrays of JSON rather than individual JSON objects.
Request bodies will now be arrays of JSON rather than individual JSON objects.

@@ -0,0 +1,13 @@
In addition to the native functions available in the jq language, the following helper functions are available for use in a jq query:

`epoch` - converts a Go `time.Time` timestamp to an epoch timestamp in seconds, as integer type. jq's native timestamp-based functions expect integer input, but the Snowplow Analytics SDK provides base level timestamps as `time.Time`. This function can be chained with jq native functions to get past this limitation. For example:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

link to Analytics SDK

colmsnowplow and others added 10 commits February 6, 2025 16:54
…ransformations/builtin/reusable/_jqHelpers.md

Co-authored-by: Miranda Wilson <[email protected]>
…ransformations/builtin/reusable/_jqHelpers.md

Co-authored-by: Miranda Wilson <[email protected]>
…ransformations/builtin/jqFilter.md

Co-authored-by: Miranda Wilson <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants