kedro-org / kedro-plugins

First-party plugins maintained by the Kedro team.
Apache License 2.0
92 stars 89 forks source link

Create high-level user/project statistics on Heap #36

Closed yetudada closed 1 year ago

yetudada commented 2 years ago

Description

Product usage analytics helps us understand how Kedro is used. This information helps us determine if we have succeeded in developing certain features and gives us a guiding point for identifying if we must improve our approach.

We shipped the first version of Kedro-Telemetry to understand the usage of the CLI and Kedro-Viz. However, we're still missing some high-level information like:

All of these values assume that Kedro-Telemetry is installed and activated according to our consent-based workflow.

Context

Some of the complexities of why it is difficult to do this might lie in defining user identities on Heap.

There are two types of properties that Heap recognises, user and event. Properties are bits of metadata that are captured during user interactions with the application. User properties refer to any data related to the user. In contrast, event properties are metadata associated with any actions the user takes.

Here is what I have observed:

Possible Implementation

There are two parts to this:

  1. How do we have a consistent user identifier on Heap? Can we use the User ID field? Can we send username to replace User ID?
  2. How do we make it possible to create a summative view of projects on Heap? Which may have to look at adding project_name or another project identifier to user properties.

Re: Point 2. This would require some discussion about what is a user. Is a user consistently defined by their username or is a user a username AND project_name.

merelcht commented 1 year ago

This was completed in https://github.com/kedro-org/kedro-plugins/issues/50