Skip to content

Add snowplow tracking to Releases API

Jaime Martinez requested to merge 296612-instrument-release-cli into master

What does this MR do?

Adds snowplow tracking events to the Releases API. The idea is to enable usage tracking for interaction of the release-cli with the API

Related to #296612 (closed)

Screenshots (strongly suggested)

curl "http://localhost:9090/micro/good" | jq '.[] | select(.event.se_category == "API::Releases")| "\(.event.etl_tstamp) \(.event.se_category) \(.event.se_action) \(.event.contexts.data[0].data.extra)"'
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100 17477  100 17477    0     0  1896k      0 --:--:-- --:--:-- --:--:-- 1896k
"2021-04-27T01:19:45.452Z API::Releases get_releases {\"status\":200,\"release_cli\":true}"
"2021-04-27T01:19:38.260Z API::Releases get_releases {\"status\":200,\"release_cli\":false}"
"2021-04-27T01:19:15.364Z API::Releases get_release {\"status\":403,\"release_cli\":false}"
"2021-04-27T01:18:35.267Z API::Releases create_release {\"status\":201,\"release_cli\":true}"

Does this MR meet the acceptance criteria?

Conformity

Availability and Testing

Security

If this MR contains changes to processing or storing of credentials or tokens, authorization and authentication methods and other items described in the security review guidelines:

  • Label as security and @ mention @gitlab-com/gl-security/appsec
  • The MR includes necessary changes to maintain consistency between UI, API, email, or other methods
  • Security reports checked/validated by a reviewer from the AppSec team

Related to #296612 (closed)

Edited by Jaime Martinez

Merge request reports