Track push/pull API events for the NPM Registry and Maven Repository
Problem to solve
We currently do not track push and pull events via the API for NPM or Maven. This blocks us from truly understanding usage and better measuring our investments in each feature.
Intended users
Proposal
Begin to track npm publish, npm install, mvn deploy, mvn install events via the CLI and CI/CD and add these events to snowplow and the Package dashboard.
Naming conventions
- npm publish
- se_action:
push_package - event_category:
API::NpmPackages
- se_action:
- npm install
- se_action:
pull_package - event_category:
API::NpmPackages
- se_action:
- npm dist-tag
- mvn deploy
- se_action:
push_package - event_category:
API::MavenPackages
- se_action:
- mvn install
- se_action:
pull_package - event_category:
API::MavenPackages
- se_action:
Permissions and Security
- Analytics and reporting are for internal usage at GitLab
Documentation
- There are no documentation updates required for this change
Testing
- Test to ensure data is available in snowplow.
What does success look like, and how can we measure that?
- Success looks like we are tracking the data and utilizing it to make decisions.
Links / references
Edited by Tim Rizzi