← Back to packages

Package sentry_protos.snuba.v1alpha

Message RequestMeta

Message AttributeKey

Message VirtualColumnContext

Message AttributeValue

Message AndFilter

Message OrFilter

Message ComparisonFilter

Message ExistsFilter

Message TraceItemFilter

Message AggregateBucketRequest

Message AggregateBucketResponse

Message OrderBy

Message SpanSamplesRequest

Message SpanSample

Message SpanSamplesResponse

Message TraceItemAttributesRequest

Message Tag

Message TraceItemAttributesResponse

Message AttributeValuesRequest

Message AttributeValuesResponse

Enum TraceItemName

Enum Type

Enum Op

Enum Function

Messages

message RequestMeta sentry_protos/snuba/v1alpha/request_common.proto

Field Type Description
1 organization_id uint64
2 cogs_category string
3 referrer string
4 project_ids repeated uint64

can be empty

5 start_timestamp google.protobuf.Timestamp
6 end_timestamp google.protobuf.Timestamp
7 trace_item_name sentry_protos.snuba.v1alpha.TraceItemName

message AttributeKey sentry_protos/snuba/v1alpha/trace_item_attribute.proto

Field Type Description
1 type sentry_protos.snuba.v1alpha.AttributeKey.Type
2 name string

if you use span_id this will route to span.span_id,
if you use derp this will route to attr_{str,num}_{n}['derp']

message VirtualColumnContext sentry_protos/snuba/v1alpha/trace_item_attribute.proto

custom mappings of column values which are not present in EAP storage
for example, project name is changeable by the user and not stored in EAP
but sorting by the project name may be desired. This struct carries that mapping
data

Field Type Description
1 from_column_name string
2 to_column_name string
3 value_map map<string, string>

message AttributeValue sentry_protos/snuba/v1alpha/trace_item_attribute.proto

Field Type Description
oneof value
1 val_bool bool
2 val_str string
3 val_float float
4 val_int int64

message AndFilter sentry_protos/snuba/v1alpha/trace_item_filter.proto

Field Type Description
1 filters repeated sentry_protos.snuba.v1alpha.TraceItemFilter

message OrFilter sentry_protos/snuba/v1alpha/trace_item_filter.proto

Field Type Description
1 filters repeated sentry_protos.snuba.v1alpha.TraceItemFilter

message ComparisonFilter sentry_protos/snuba/v1alpha/trace_item_filter.proto

Field Type Description
1 key sentry_protos.snuba.v1alpha.AttributeKey
2 op sentry_protos.snuba.v1alpha.ComparisonFilter.Op
3 value sentry_protos.snuba.v1alpha.AttributeValue

message ExistsFilter sentry_protos/snuba/v1alpha/trace_item_filter.proto

Field Type Description
1 key sentry_protos.snuba.v1alpha.AttributeKey

message TraceItemFilter sentry_protos/snuba/v1alpha/trace_item_filter.proto

Represents a condition on searching for a particular "trace item"
(e.g., spans, replays, errors)

Field Type Description
oneof value
1 and_filter sentry_protos.snuba.v1alpha.AndFilter
2 or_filter sentry_protos.snuba.v1alpha.OrFilter
3 comparison_filter sentry_protos.snuba.v1alpha.ComparisonFilter
4 exists_filter sentry_protos.snuba.v1alpha.ExistsFilter

message AggregateBucketRequest sentry_protos/snuba/v1alpha/endpoint_aggregate_bucket.proto

Field Type Description
1 meta sentry_protos.snuba.v1alpha.RequestMeta
4 aggregate sentry_protos.snuba.v1alpha.AggregateBucketRequest.Function
5 filter sentry_protos.snuba.v1alpha.TraceItemFilter
6 granularity_secs uint64
7 key sentry_protos.snuba.v1alpha.AttributeKey
8 virtual_column_context repeated sentry_protos.snuba.v1alpha.VirtualColumnContext

message AggregateBucketResponse sentry_protos/snuba/v1alpha/endpoint_aggregate_bucket.proto

Field Type Description
1 result repeated float

message OrderBy (Nested in sentry_protos.snuba.v1alpha.SpanSamplesRequest ) sentry_protos/snuba/v1alpha/endpoint_span_samples.proto

Field Type Description
1 key sentry_protos.snuba.v1alpha.AttributeKey
2 descending bool

message SpanSamplesRequest sentry_protos/snuba/v1alpha/endpoint_span_samples.proto

Field Type Description
1 meta sentry_protos.snuba.v1alpha.RequestMeta
2 filter sentry_protos.snuba.v1alpha.TraceItemFilter
3 order_by repeated sentry_protos.snuba.v1alpha.SpanSamplesRequest.OrderBy
4 keys repeated sentry_protos.snuba.v1alpha.AttributeKey
5 limit uint32
6 virtual_column_contexts repeated sentry_protos.snuba.v1alpha.VirtualColumnContext

message SpanSample sentry_protos/snuba/v1alpha/endpoint_span_samples.proto

Field Type Description
1 results map<string, AttributeValue>

message SpanSamplesResponse sentry_protos/snuba/v1alpha/endpoint_span_samples.proto

Field Type Description
1 span_samples repeated sentry_protos.snuba.v1alpha.SpanSample

message TraceItemAttributesRequest sentry_protos/snuba/v1alpha/endpoint_tags_list.proto

A request for "which tags are available for these projects between these dates" - used for things like autocompletion

Field Type Description
1 meta sentry_protos.snuba.v1alpha.RequestMeta
2 limit uint32
3 offset uint32
5 type sentry_protos.snuba.v1alpha.AttributeKey.Type

message Tag (Nested in sentry_protos.snuba.v1alpha.TraceItemAttributesResponse ) sentry_protos/snuba/v1alpha/endpoint_tags_list.proto

Field Type Description
1 name string
2 type sentry_protos.snuba.v1alpha.AttributeKey.Type

message TraceItemAttributesResponse sentry_protos/snuba/v1alpha/endpoint_tags_list.proto

Field Type Description
1 tags repeated sentry_protos.snuba.v1alpha.TraceItemAttributesResponse.Tag

message AttributeValuesRequest sentry_protos/snuba/v1alpha/endpoint_tags_list.proto

Field Type Description
1 meta sentry_protos.snuba.v1alpha.RequestMeta
3 name string
4 value_substring_match string

a substring of the value being searched,
only strict substring supported, no regex

5 limit uint32
6 offset uint32

message AttributeValuesResponse sentry_protos/snuba/v1alpha/endpoint_tags_list.proto

Field Type Description
1 values repeated string

Enums

enum TraceItemName sentry_protos/snuba/v1alpha/request_common.proto

Name Number Description
TRACE_ITEM_NAME_UNSPECIFIED 0
TRACE_ITEM_NAME_EAP_SPANS 1

enum Type sentry_protos/snuba/v1alpha/trace_item_attribute.proto

this mostly reflects what types are able to be ingested, see eap_spans consumer for ingest details

Name Number Description
TYPE_UNSPECIFIED 0

called "none" sometimes

TYPE_BOOLEAN 1
TYPE_STRING 2
TYPE_FLOAT 3
TYPE_INT 4

note: all numbers are stored as float64, so massive integers can be rounded. USE STRING FOR IDS.

enum Op sentry_protos/snuba/v1alpha/trace_item_filter.proto

Name Number Description
OP_UNSPECIFIED 0
OP_LESS_THAN 1
OP_GREATER_THAN 2
OP_LESS_THAN_OR_EQUALS 3
OP_GREATER_THAN_OR_EQUALS 4
OP_EQUALS 5
OP_NOT_EQUALS 6
OP_LIKE 7

string only

OP_NOT_LIKE 8

string only

enum Function sentry_protos/snuba/v1alpha/endpoint_aggregate_bucket.proto

Name Number Description
FUNCTION_UNSPECIFIED 0
FUNCTION_SUM 1
FUNCTION_AVERAGE 2
FUNCTION_COUNT 3
FUNCTION_P50 4
FUNCTION_P95 5
FUNCTION_P99 6
FUNCTION_AVG 7