Skip to content

SAST Config UI telemetry

rossfuhrman requested to merge rf-sast-config-telemetry into master

What does this MR do?

This change allows us to track when the SAST UI Config form is submitted, as well as whether it was a create or an update for the .gitlab-ci.yml file, as well as whether default values were changed.

As per the Preparing your MR for Review section of the documentation, here is sample output of the Snowplow Micro good events:

"se_ac":"update" indicates that the .gitlab-ci.yml is being updated and "se_la":"true" indicates that default values were overridden.

[{"event":{"api":{"vendor":"com.snowplowanalytics.snowplow","version":"tp1"},"parameters":{"e":"se","eid":"63c4b8c3-1bb8-4bbf-a89a-f124d0c91e89","tna":"gl","stm":"1600442830148","tv":"rb-0.6.1","se_ac":"update","se_la":"true","se_ca":"Security::CiConfiguration::SastCreateService","p":"srv","dtm":"1600442830146"},"contentType":null,"source":{"name":"ssc-0.15.0-stdout$","encoding":"UTF-8","hostname":"localhost"},"context":{"timestamp":"2020-09-18T15:27:10.180Z","ipAddress":"172.17.0.1","useragent":"Ruby","refererUri":null,"headers":["Accept-Encoding: gzip, deflate;q=0.6, identity;q=0.3","Accept: */*","User-Agent: Ruby","Connection: close","Host: localhost:9090","Timeout-Access: <function1>"],"userId":"c29a8f36-4b5a-465c-b271-9e6791666798"}},"eventType":"se","schema":null,"contexts":null}]

"se_ac":"update" indicates that the .gitlab-ci.yml is being updated and "se_la":"false" indicates that default values were not overridden.

[{"event":{"api":{"vendor":"com.snowplowanalytics.snowplow","version":"tp1"},"parameters":{"e":"se","eid":"0b67d2c0-477a-4a46-8adc-a65247d475b2","tna":"gl","stm":"1600442781542","tv":"rb-0.6.1","se_ac":"update","se_la":"false","se_ca":"Security::CiConfiguration::SastCreateService","p":"srv","dtm":"1600442781540"},"contentType":null,"source":{"name":"ssc-0.15.0-stdout$","encoding":"UTF-8","hostname":"localhost"},"context":{"timestamp":"2020-09-18T15:26:21.586Z","ipAddress":"172.17.0.1","useragent":"Ruby","refererUri":null,"headers":["Accept-Encoding: gzip, deflate;q=0.6, identity;q=0.3","Accept: */*","User-Agent: Ruby","Connection: close","Host: localhost:9090","Timeout-Access: <function1>"],"userId":"ca8e5f34-f92d-48c8-9a90-fbafa6e42a41"}},"eventType":"se","schema":null,"contexts":null}]

Issue: #235600 (closed)

Screenshots

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
Edited by Saikat Sarkar

Merge request reports

Loading