Dashboard

The dashboard is available at console.batch.sh.

The dashboard is one of the primary ways to interact with the Batch platform.

The dashboard enables you to:

  • Manage collections

  • Manage destinations

  • Manage schemas

  • Manage replays

  • Manage team and account

  • Manage billing settings

Manage Collections

Event Envelope

When Batch receives events, it stores them using the following structure:

{
"batch": {
"collect" : {},
"team": {},
"info": {}
},
"client": {
"payload": "<original payload>"
}
}

Batch metadata

Our collectors enrich your events with a lot of metadata, all of which can be used to further facilitate granular search.

<COMPLETE METADATA LIST>

Search Syntax

The detailed collection view enables you to search through your event data using a Lucene-like syntax (such as used by ElasticSearch) and uses full-text search.

Our search supports the following operations:

  • Value contains or does NOT contain

  • Value is greater than, less than

  • Value is between X and Y

  • Expression chaining

Timestamps are "special". To fetch events that fit a specific time range, use the batch.info.date_human field which uses ISO 8601 format.

Search Examples

All results

Fetch all results (for the picked time interval).

*

Any part of a string

Find any events that contain the string "foo" in any key or field.

foo

Logical NOT

Find all events that do not contain the string foo in batch.info.source.

batch.info.source: (NOT foo)

Events ingested between timestamps

batch.info.date_human: [2021-03-08T22:29:05Z TO 2021-03-08T22:30:26Z]

Chaining multiple conditions

Find all events where client.payload.age is greater than 32 AND client.payload.title is set to "engineer".

client.payload.age: >32 AND client.payload.title: engineer.

Exact matches

Due to how indexing works, searching for an exact values might provide false positives. Search for values that are unique and not part of any existing values. Example Searching for "foo" when there are events with "foobar" will return both "foo" and "foobar". To get around this, add another constraint to the search to further limit the results.

Manage Destinations

Manage Schemas

Manage Replays

Since replays are based off of Parquet data stored in S3, you must specify a key in order to replay data.

This will work for a replay:

client.payload: foo

This won't work:

foo

Limitations

When creating a replay, you can only reference Batch metadata for search. We are actively working on improving this functionality