Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/admin/telemetry/protocol.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ To learn more, refer to our [telemetry documentation](https://sourcegraph.com/do
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| id | [string](#string) | | <p>Generated ID of the event, currently expected to be UUID v4.</p> |
| timestamp | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | <p>Timestamp of when the original event was recorded.</p> |
| timestamp | google.protobuf.Timestamp | | <p>Timestamp of when the original event was recorded.</p> |
| feature | [string](#string) | | <p>Feature associated with the event in camelCase, e.g. 'myFeature'.</p> |
| action | [string](#string) | | <p>Action associated with the event in camelCase, e.g. 'pageView'.</p> |
| source | [EventSource](#telemetrygateway-v1-EventSource) | | <p>Source of the event.</p> |
Expand Down Expand Up @@ -194,7 +194,7 @@ callsites, and is the primary means of recording product interaction metadata.
| version | [int32](#int32) | | <p>Version of the event parameters, used for indicating the "shape" of this</p><p>event's metadata, beginning at 0. Useful for denoting if the shape of</p><p>metadata has changed in any way.</p> |
| legacy_metadata | [EventParameters.LegacyMetadataEntry](#telemetrygateway-v1-EventParameters-LegacyMetadataEntry) | repeated | **Deprecated.** <p>DEPRECATED, legacy metadata format that only accepted int64 - use the new</p><p>'metadata' field instead, which accepts float values. Values sent through</p><p>this proto field will be merged into the new metadata attributes.</p> |
| metadata | [EventParameters.MetadataEntry](#telemetrygateway-v1-EventParameters-MetadataEntry) | repeated | <p>Strictly typed exported-by-default metadata, restricted to numeric values</p><p>to ensure no sensitive attributes are exported. Sourcegraph telemetry SDKs</p><p>must use programming language type-checking to ensure metadata keys are</p><p>statically known.</p> |
| private_metadata | [google.protobuf.Struct](#google-protobuf-Struct) | optional | <p>Additional potentially sensitive metadata - i.e. not restricted to numeric</p><p>values.</p><p>🚨 SECURITY: This metadata is NOT exported from instances by default, as it</p><p>can contain arbitrarily-shaped data that may accidentally contain sensitive</p><p>or private contents.</p><p>This metadata is only exported on an allowlist basis based on terms of</p><p>use agreements and combinations of event feature and action, alongside</p><p>careful audit of callsites. For the list of allowlisted properties, refer</p><p>to this generated page:</p><p>https://sourcegraph.com/docs/admin/telemetry/private-metadata-allowlist</p> |
| private_metadata | google.protobuf.Struct | optional | <p>Additional potentially sensitive metadata - i.e. not restricted to numeric</p><p>values.</p><p>🚨 SECURITY: This metadata is NOT exported from instances by default, as it</p><p>can contain arbitrarily-shaped data that may accidentally contain sensitive</p><p>or private contents.</p><p>This metadata is only exported on an allowlist basis based on terms of</p><p>use agreements and combinations of event feature and action, alongside</p><p>careful audit of callsites. For the list of allowlisted properties, refer</p><p>to this generated page:</p><p>https://sourcegraph.com/docs/admin/telemetry/private-metadata-allowlist</p> |
| billing_metadata | [EventBillingMetadata](#telemetrygateway-v1-EventBillingMetadata) | optional | <p>Optional billing-related metadata.</p> |


Expand Down
Loading