package v1.events.vortex

Get desktop application:
View/edit binary Protocol Buffers messages

string ip = 1
The IP address of the client
bool proxy = 2
Whether the IP address is from a proxy service
optional VortexGeolocation geo = 3
Geographic location information for this IP address

Client platform info that every vortex client will set via X-Vortex-Client-Platform Expected format is "dbt-core/1.7.0 dbt-vortex-python/1.0.0 dbtlabs-proto/4.25.1" See https://github.com/dbt-labs/vortex/pull/101 for more context

Used in: VortexMessageEnrichment

string raw = 1
Full header value as received
string service = 2
Source service of the vortex client (i.e. dbt-core)
string service_version = 3
Version of the source service
string client = 4
Vortex client used (i.e. vortex-client-rust)
string client_version = 5
Version of the vortex client
string dbt_proto_library = 6
Name of the dbt proto library used
string dbt_proto_library_version = 7
Version of the dbt proto library

message VortexDeadLetterMessage

vortex.proto:58

a message that is sent to the dead letter queue when a message is rejected by vortex.

string type_url = 1
type url of failed message
string value = 2
a best effort attempt at serializing the rejected message.
bytes value_bytes = 3
original bytes of failed message (for reconstructing or replaying events).
string reason = 4
the reason that the message was rejected.

Used in: VortexClientIp

string country = 1
Two-letter country code (ISO 3166-1 alpha-2)
string city = 2
Name of the city
double latitude = 3
Latitude coordinate
double longitude = 4
Longitude coordinate
string timezone = 5
Timezone identifier (e.g., "America/New_York")
string continent = 6
Name of the continent

message VortexMessage

vortex.proto:12

Used in: VortexMessageBatch

optional google.protobuf.Any any = 1
this can encapsulate any known protobuf message type. https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/any.proto
optional google.protobuf.Timestamp vortex_event_created_at = 2
the time that the event was created by the client. this could be different than the time that the event was sent to vortex, since the client may buffer events before sending them.
optional google.protobuf.Timestamp vortex_client_sent_at = 3
the time that the client sent the message to vortex (recorded by the vortex client library automatically).
optional google.protobuf.Timestamp vortex_backend_received_at = 4
the time that the vortex api received the message.
optional google.protobuf.Timestamp vortex_backend_processed_at = 5
the time that the vortex backend fully processed the message.

message VortexMessageBatch

vortex.proto:38

internal canonical message for vortex events. this is what you receive when you integrate a streaming consumer with vortex. it is also what vortex uses internally on its queue.

string request_id = 1
a UUID which is a unique identifier for the event, it can be provided by the client or autogenerated by the vortex client library.
repeated VortexMessage payload = 2
the data that was sent to vortex originally. it is retained here so that consumers can re-construct the original message exactly as they sent it. clients will construct this from a valid protobuf message. each batch can contain many different message types. this will be hidden away from streaming consumers, who will instead see the exact protobufs requested come through in their subscription.

message VortexMessageEnrichment

vortex.proto:77

Base enriched event data that all telemetry events inherit from Should be explicitly defined as a field "enrichment"

optional VortexClientIp client_ip = 1
IP address and proxy information of the client
optional VortexClientPlatform client_platform = 2
Information about the client platform, including service, client, and library versions
optional VortexUserAgent user_agent = 3
User agent information for web-based events

For web based events that send the User-Agent header

Used in: VortexMessageEnrichment

string raw = 1
Raw User-Agent string as received from the client
string browser = 2
Name of the browser (e.g., "Chrome", "Firefox")
string browser_version = 3
Version of the browser
string os = 4
Operating system name (e.g., "Windows", "macOS")
string os_version = 5
Operating system version
string device = 6
Device model or identifier
string device_type = 7
Type of device (e.g., "mobile", "desktop", "tablet")

package v1.events.vortex

message VortexClientIp

string ip = 1

bool proxy = 2

optional VortexGeolocation geo = 3

message VortexClientPlatform

string raw = 1

string service = 2

string service_version = 3

string client = 4

string client_version = 5

string dbt_proto_library = 6

string dbt_proto_library_version = 7

message VortexDeadLetterMessage

string type_url = 1

string value = 2

bytes value_bytes = 3

string reason = 4

message VortexGeolocation

string country = 1

string city = 2

double latitude = 3

double longitude = 4

string timezone = 5

string continent = 6

message VortexMessage

optional google.protobuf.Any any = 1

optional google.protobuf.Timestamp vortex_event_created_at = 2

optional google.protobuf.Timestamp vortex_client_sent_at = 3

optional google.protobuf.Timestamp vortex_backend_received_at = 4

optional google.protobuf.Timestamp vortex_backend_processed_at = 5

message VortexMessageBatch

string request_id = 1

repeated VortexMessage payload = 2

message VortexMessageEnrichment

optional VortexClientIp client_ip = 1

optional VortexClientPlatform client_platform = 2

optional VortexUserAgent user_agent = 3

message VortexUserAgent

string raw = 1

string browser = 2

string browser_version = 3

string os = 4

string os_version = 5

string device = 6

string device_type = 7