Update arguments to Snowplow Ruby tracking class

Because they are outdated compared to the current implementation

Update arguments to Snowplow Ruby tracking class
Because they are outdated compared to the current implementation
931d4adb · Alishan Ladhani · 3748ead2 · 931d4adb
Commit 931d4adb authored Jan 14, 2021 by Alishan Ladhani
Hide whitespace changes
Inline Side-by-side

Showing with 8 additions and 5 deletions

doc/development/snowplow.md doc/development/snowplow.md +8 -5

No files found.
--- a/doc/development/snowplow.md
+++ b/doc/development/snowplow.md
@@ -303,11 +303,14 @@ GitLab provides `Gitlab::Tracking`, an interface that wraps the [Snowplow Ruby T

 Custom event tracking and instrumentation can be added by directly calling the `GitLab::Tracking.event` class method, which accepts the following arguments:

-| argument   | type   | default value | description                                                                                                                                                                                                                                                            |
-|:-----------|:-------|:--------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `category` | string | 'application' | Area or aspect of the application. This could be `HealthCheckController` or `Lfs::FileTransformer` for instance.                                                                                                                                                       |
-| `action`   | string | 'generic'     | The action being taken, which can be anything from a controller action like `create` to something like an Active Record callback.                                                                                                                                      |
-| `data`     | object | {}            | Additional data such as `label`, `property`, `value`, and `context` as described in [Structured event taxonomy](#structured-event-taxonomy). These are set as empty strings if you don't provide them. |
+| argument   | type                      | default value | description                                                                                                                       |
+|------------|---------------------------|---------------|-----------------------------------------------------------------------------------------------------------------------------------|
+| `category` | String                    |               | Area or aspect of the application. This could be `HealthCheckController` or `Lfs::FileTransformer` for instance.                  |
+| `action`   | String                    |               | The action being taken, which can be anything from a controller action like `create` to something like an Active Record callback. |
+| `label`    | String                    | nil           | As described in [Structured event taxonomy](#structured-event-taxonomy).                                                          |
+| `property` | String                    | nil           | As described in [Structured event taxonomy](#structured-event-taxonomy).                                                          |
+| `value`    | Numeric                   | nil           | As described in [Structured event taxonomy](#structured-event-taxonomy).                                                          |
+| `context`  | Array[SelfDescribingJSON] | nil           | An array of custom contexts to send with this event. Most events should not have any custom contexts.                             |

 Tracking can be viewed as either tracking user behavior, or can be used for instrumentation to monitor and visualize performance over time in an area or aspect of code.