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