← Back to packages

Package sentry_protos.snuba.v1

Message AttributeKey

Message VirtualColumnContext

Message StrArray

Message IntArray

Message AttributeValue

Message AttributeAggregation

Message AndFilter

Message OrFilter

Message NotFilter

Message ComparisonFilter

Message ExistsFilter

Message TraceItemFilter

Message RequestMeta

Message PageToken

Message TimeSeriesRequest

Message DataPoint

Message TimeSeries

Message TimeSeriesResponse

Message TraceItemAttributeNamesRequest

Message Attribute

Message TraceItemAttributeNamesResponse

Message TraceItemAttributeValuesRequest

Message TraceItemAttributeValuesResponse

Message OrderBy

Message TraceItemTableRequest

Message Column

Message TraceItemColumnValues

Message TraceItemTableResponse

Message Error

Enum Function

Enum ExtrapolationMode

Enum Type

Enum Op

Enum TraceItemName

Messages

message AttributeKey sentry_protos/snuba/v1/trace_item_attribute.proto

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

the name of the trace item attribute, everything that sentry sends by default is prefixed with
sentry. to allow users to send attributes of the same name.
Exampe: sentry.duration, sentry.span_id etc

message VirtualColumnContext sentry_protos/snuba/v1/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 StrArray sentry_protos/snuba/v1/trace_item_attribute.proto

Field Type Description
1 values repeated string

message IntArray sentry_protos/snuba/v1/trace_item_attribute.proto

Field Type Description
1 values repeated int64

message AttributeValue sentry_protos/snuba/v1/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
5 val_null bool

set to true if value is null
6 val_str_array sentry_protos.snuba.v1.StrArray
7 val_int_array sentry_protos.snuba.v1.IntArray

message AttributeAggregation sentry_protos/snuba/v1/trace_item_attribute.proto

Field Type Description
1 aggregate sentry_protos.snuba.v1.Function
2 key sentry_protos.snuba.v1.AttributeKey
3 label string
4 extrapolation_mode sentry_protos.snuba.v1.ExtrapolationMode

message AndFilter sentry_protos/snuba/v1/trace_item_filter.proto

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

message OrFilter sentry_protos/snuba/v1/trace_item_filter.proto

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

message NotFilter sentry_protos/snuba/v1/trace_item_filter.proto

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

message ComparisonFilter sentry_protos/snuba/v1/trace_item_filter.proto

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

message ExistsFilter sentry_protos/snuba/v1/trace_item_filter.proto

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

message TraceItemFilter sentry_protos/snuba/v1/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.v1.AndFilter
2 or_filter sentry_protos.snuba.v1.OrFilter
3 not_filter sentry_protos.snuba.v1.NotFilter
4 comparison_filter sentry_protos.snuba.v1.ComparisonFilter
5 exists_filter sentry_protos.snuba.v1.ExistsFilter

message RequestMeta sentry_protos/snuba/v1/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.v1.TraceItemName

message PageToken sentry_protos/snuba/v1/request_common.proto

Field Type Description
oneof value
1 offset uint64
2 filter_offset sentry_protos.snuba.v1.TraceItemFilter

Instead of using offset (which requires all the scanning and ordering,
the server sends back a filter clause to be added on to the filter conditions
which skips the previous results altogether, avoiding extra scanning and sorting

message TimeSeriesRequest sentry_protos/snuba/v1/endpoint_time_series.proto

Field Type Description
1 meta sentry_protos.snuba.v1.RequestMeta
2 filter sentry_protos.snuba.v1.TraceItemFilter
3 aggregations repeated sentry_protos.snuba.v1.AttributeAggregation
4 granularity_secs uint64
5 group_by repeated sentry_protos.snuba.v1.AttributeKey

message DataPoint sentry_protos/snuba/v1/endpoint_time_series.proto

Field Type Description
1 data float
2 data_present bool

optional, if not set, assume true. Accounts for sparse time series

message TimeSeries sentry_protos/snuba/v1/endpoint_time_series.proto

Field Type Description
1 label string
2 group_by_attributes map<string, string>

the names and values of the attribute keys which
were in the group by
3 buckets repeated google.protobuf.Timestamp

time bucket for each data point in the timeseries
4 data_points repeated sentry_protos.snuba.v1.DataPoint
5 num_events uint64

number of events used to calculate this timeseries
6 avg_sampling_rate float

message TimeSeriesResponse sentry_protos/snuba/v1/endpoint_time_series.proto

Field Type Description
1 result_timeseries repeated sentry_protos.snuba.v1.TimeSeries

message TraceItemAttributeNamesRequest sentry_protos/snuba/v1/endpoint_trace_item_attributes.proto

A request for "which queryable attributes are available for these projects between these dates"
- used for things like autocompletion
EAP does not make a distinction between data stored as columns on a table vs attributes stored
dynamically (e.g. tags, contexts, etc). To the user of the interface, they are the same

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

different typed attributes are queried separately
anything other than TYPE_STRING and TYPE_FLOAT will return empty
6 value_substring_match string

message Attribute (Nested in sentry_protos.snuba.v1.TraceItemAttributeNamesResponse ) sentry_protos/snuba/v1/endpoint_trace_item_attributes.proto

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

message TraceItemAttributeNamesResponse sentry_protos/snuba/v1/endpoint_trace_item_attributes.proto

Field Type Description
1 attributes repeated sentry_protos.snuba.v1.TraceItemAttributeNamesResponse.Attribute

message TraceItemAttributeValuesRequest sentry_protos/snuba/v1/endpoint_trace_item_attributes.proto

This endpoint only supports string values, it does not make sense
to get all the possible values of a numerical attribute

Field Type Description
1 meta sentry_protos.snuba.v1.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 page_token sentry_protos.snuba.v1.PageToken

message TraceItemAttributeValuesResponse sentry_protos/snuba/v1/endpoint_trace_item_attributes.proto

Field Type Description
1 values repeated string
6 page_token sentry_protos.snuba.v1.PageToken

message OrderBy (Nested in sentry_protos.snuba.v1.TraceItemTableRequest ) sentry_protos/snuba/v1/endpoint_trace_item_table.proto

Field Type Description
1 column sentry_protos.snuba.v1.Column
2 descending bool

message TraceItemTableRequest sentry_protos/snuba/v1/endpoint_trace_item_table.proto

Serves requests for table views of the data

Field Type Description
1 meta sentry_protos.snuba.v1.RequestMeta
2 columns repeated sentry_protos.snuba.v1.Column
3 filter sentry_protos.snuba.v1.TraceItemFilter
4 order_by repeated sentry_protos.snuba.v1.TraceItemTableRequest.OrderBy
5 group_by repeated sentry_protos.snuba.v1.AttributeKey
6 limit uint32
7 page_token sentry_protos.snuba.v1.PageToken
8 virtual_column_contexts repeated sentry_protos.snuba.v1.VirtualColumnContext

message Column sentry_protos/snuba/v1/endpoint_trace_item_table.proto

Field Type Description
3 label string
oneof column
1 key sentry_protos.snuba.v1.AttributeKey
2 aggregation sentry_protos.snuba.v1.AttributeAggregation

message TraceItemColumnValues sentry_protos/snuba/v1/endpoint_trace_item_table.proto

Field Type Description
1 attribute_name string
2 results repeated sentry_protos.snuba.v1.AttributeValue

message TraceItemTableResponse sentry_protos/snuba/v1/endpoint_trace_item_table.proto

Field Type Description
1 column_values repeated sentry_protos.snuba.v1.TraceItemColumnValues
2 page_token sentry_protos.snuba.v1.PageToken

message Error sentry_protos/snuba/v1/error.proto

Field Type Description
1 code int32

The HTTP status code corresponding to this error
2 message string

The developer-facing message
3 details repeated google.protobuf.Any

Additional error information

Enums

enum Function sentry_protos/snuba/v1/trace_item_attribute.proto

Name Number Description
FUNCTION_UNSPECIFIED 0
FUNCTION_SUM 1
FUNCTION_AVERAGE 2
FUNCTION_COUNT 3
FUNCTION_P50 4
FUNCTION_P90 5
FUNCTION_P95 6
FUNCTION_P99 7
FUNCTION_AVG 8
FUNCTION_MAX 9
FUNCTION_MIN 10
FUNCTION_UNIQ 11

enum ExtrapolationMode sentry_protos/snuba/v1/trace_item_attribute.proto

Name Number Description
EXTRAPOLATION_MODE_UNSPECIFIED 0
EXTRAPOLATION_MODE_NONE 1
EXTRAPOLATION_MODE_SAMPLE_WEIGHTED 2

enum Type sentry_protos/snuba/v1/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

protobuf requirement, do not send this
TYPE_STRING 1
TYPE_BOOLEAN 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/v1/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
OP_IN 9

array only
OP_NOT_IN 10

array only

enum TraceItemName sentry_protos/snuba/v1/request_common.proto

Name Number Description
TRACE_ITEM_NAME_UNSPECIFIED 0
TRACE_ITEM_NAME_EAP_SPANS 1