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

common-fs2: add telemetry #489

Closed
ebedford420 opened this issue Aug 16, 2021 · 0 comments
Closed

common-fs2: add telemetry #489

ebedford420 opened this issue Aug 16, 2021 · 0 comments
Milestone

Comments

@ebedford420
Copy link

Addition of telemetry to enrich-kinesis & enrich-pubsub asset so that we can start to understand some basic information about open source usage to help guide us on where we can improve our OSS:

  • Application: so that we know which apps are most commonly used by open source users (we want to incorporate telemetry into other Snowplow apps in the future)
  • App version: so we can start to associate value to a release, and understand how many open source user are upgrading / which versions of our apps are in most use
  • Heartbeat event: tells us how long an app is running for, so we can understand usage over time
  • User provided id: an optional input, but when populated allows us to tie events together across applications so that we can get an idea of which applications are being used together

Acceptance Criteria:

  • The schemas for the telemetry events & entity are published to Iglu central
  • Telemetry will be opt-out, and documentation on docs.snowplowanalytics.com describes how to disable this feature
  • The configuration examples must include an example of disabling the feature
  • It must send the following event on a regular basis (hourly):
    ** application_heartbeat
  • It must send the following fields in the context:
    ** Application name
    ** Application version
    ** Auto generated ID
    ** Cloud
    ** Region
  • It must be possible for users to provide the following field, but this is optional:
    ** User provided ID
  • The following fields in the context are optional and will only be provided when app is deployed using the quick start module (will be passed as environment variable):
    ** Module version
    ** Module name

Note: we will always be transparent about what we are tracking and why. You can find more about our telemetry principles on this page.

@benjben benjben added this to the 3.0.0 milestone Sep 20, 2021
@benjben benjben changed the title Addition of telemetry to enrich-kinesis and enrich-pubsub Add telemetry Sep 21, 2021
benjben added a commit that referenced this issue Sep 23, 2021
benjben added a commit that referenced this issue Oct 5, 2021
benjben added a commit that referenced this issue Oct 21, 2021
benjben added a commit that referenced this issue Dec 15, 2021
benjben added a commit that referenced this issue Dec 15, 2021
benjben added a commit that referenced this issue Jan 3, 2022
benjben added a commit that referenced this issue Jan 4, 2022
benjben added a commit that referenced this issue Jan 12, 2022
benjben added a commit that referenced this issue Jan 13, 2022
benjben added a commit that referenced this issue Jan 14, 2022
benjben added a commit that referenced this issue Jan 14, 2022
@benjben benjben changed the title Add telemetry common-fs2: add telemetry Jan 25, 2022
benjben added a commit that referenced this issue Jan 25, 2022
benjben added a commit that referenced this issue Jan 26, 2022
benjben added a commit that referenced this issue Jan 26, 2022
benjben added a commit that referenced this issue Jan 26, 2022
benjben added a commit that referenced this issue Jan 27, 2022
benjben added a commit that referenced this issue Feb 1, 2022
benjben added a commit that referenced this issue Feb 11, 2022
benjben added a commit that referenced this issue Feb 17, 2022
benjben added a commit that referenced this issue Feb 17, 2022
benjben added a commit that referenced this issue Feb 18, 2022
benjben added a commit that referenced this issue Feb 18, 2022
benjben added a commit that referenced this issue Feb 25, 2022
benjben added a commit that referenced this issue Mar 4, 2022
@benjben benjben closed this as completed in 678c603 Mar 7, 2022
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

No branches or pull requests

2 participants