View as Markdown

SessionAdvancedSearchRequest

Source definition: src/bitdrift/public/unary/timeline/v1/search.proto#L12-L140

Advanced search request for logs within a session.

Field	Type	Description
session_id	string between 1 and 100 chars	The session ID to search within.
start_time	google.protobuf.Timestamp	The start time of the query. If not specified, the query will start from the beginning of the session.
end_time	google.protobuf.Timestamp	The end time of the query. If not specified, the query will end at the end of the session.
limit	optional uint32 between 1 and 5000	The maximum number of results to return.
offset	optional uint32	The result offset for pagination.
include_internal_logs	bool	Whether to include internal logs in the search results. Internal logs include screen capture, resource, and internal SDK logs that do not appear in the default timeline view.
or_query	array of bitdrift.public.unary.timeline.v1.SessionAdvancedSearchRequest.AndQuery between 1 and 20 items	All AndQuery groups are combined with logical OR. (or_query[0].conditions[0] AND or_query[0].conditions[1] AND or_query[0].conditions[2]) OR (or_query[1].conditions[0] AND or_query[1].conditions[1])

Example

JSON

{
  "end_time": "2024-01-15T09:30:00Z",
  "include_internal_logs": true,
  "limit": 25,
  "offset": 0,
  "or_query": [
    {
      "conditions": [
        {
          "field_match": {
            "json_path": "$.fields.os_version",
            "operator": "EQUAL",
            "value": "14.0"
          }
        }
      ]
    }
  ],
  "session_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "start_time": "2024-01-15T09:30:00Z"
}

SessionAdvancedSearchRequest.FieldMatch

Source definition: src/bitdrift/public/unary/timeline/v1/search.proto#L40-L56

Matches against a specific field value.

Field	Type	Description
json_path	string between 1 and 500 chars	The JSONPath expression identifying the field to match against. For a known field type like os_version, this would be $.fields.os_version.
operator	bitdrift.public.unary.common.v1.Operator must be a defined enum value	The operator to use for comparison.
value	string between 1 and 1000 chars	The value to compare against.

Example

JSON

{
  "json_path": "$.fields.os_version",
  "operator": "EQUAL",
  "value": "14.0"
}

SessionAdvancedSearchRequest.LogTypeMatch

Source definition: src/bitdrift/public/unary/timeline/v1/search.proto#L59-L65

Matches against the log type.

Field	Type	Description
operator	bitdrift.public.unary.common.v1.Operator must be a defined enum value	The operator to use for comparison.
log_type	bitdrift_public.protobuf.logging.v1.LogType must be a defined enum value	The log type to match.

Example

JSON

{
  "log_type": "REPLAY",
  "operator": "EQUAL"
}

SessionAdvancedSearchRequest.LogLevelMatch

Source definition: src/bitdrift/public/unary/timeline/v1/search.proto#L68-L74

Matches against the log level.

Field	Type	Description
operator	bitdrift.public.unary.common.v1.Operator must be a defined enum value	The operator to use for comparison.
log_level	bitdrift.public.unary.timeline.v1.Log.LogLevel must be a defined enum value	The log level to match.

Example

JSON

{
  "log_level": "DEBUG",
  "operator": "EQUAL"
}

SessionAdvancedSearchRequest.RawMatch

Source definition: src/bitdrift/public/unary/timeline/v1/search.proto#L95-L104

A full-text search condition.

Searches across top-level log properties and nested values within the fields object.

For example, the search term "1234" against a log like: { "message": "This is a test log", "fields": { "foo_bar": { "baz": { "qux": "1234" } } } }

matches on $.fields.foo_bar because the query runs against each top-level field's value.

Field	Type	Description
query	string between 1 and 1000 chars	The raw search query.
operator	bitdrift.public.unary.common.v1.Operator must be a defined enum value	The operator to use for comparison.

Example

JSON

{
  "operator": "WILDCARD",
  "query": "error"
}

SessionAdvancedSearchRequest.Condition

Source definition: src/bitdrift/public/unary/timeline/v1/search.proto#L106-L121

Field	Type	Description
field_match	bitdrift.public.unary.timeline.v1.SessionAdvancedSearchRequest.FieldMatchonly one of field_match, or raw_match, log_type_match, log_level_match can be set	Matches against a specific field value.
raw_match	bitdrift.public.unary.timeline.v1.SessionAdvancedSearchRequest.RawMatchonly one of raw_match, or field_match, log_type_match, log_level_match can be set	Matches against the full-text content of the log.
log_type_match	bitdrift.public.unary.timeline.v1.SessionAdvancedSearchRequest.LogTypeMatchonly one of log_type_match, or field_match, raw_match, log_level_match can be set	Matches against the log type.
log_level_match	bitdrift.public.unary.timeline.v1.SessionAdvancedSearchRequest.LogLevelMatchonly one of log_level_match, or field_match, raw_match, log_type_match can be set	Matches against the log level.

Example

JSON

{
  "field_match": {
    "json_path": "$.fields.os_version",
    "operator": "EQUAL",
    "value": "14.0"
  }
}

SessionAdvancedSearchRequest.AndQuery

Source definition: src/bitdrift/public/unary/timeline/v1/search.proto#L123-L129

Field	Type	Description
conditions	array of bitdrift.public.unary.timeline.v1.SessionAdvancedSearchRequest.Condition between 1 and 20 items	The conditions to combine with logical AND.

Example

JSON

{
  "conditions": [
    {
      "field_match": {
        "json_path": "$.fields.os_version",
        "operator": "EQUAL",
        "value": "14.0"
      }
    }
  ]
}