Console

A guide to the Beneath Console, which is Beneath's graphical user interface

We have often found that it can be frustrating and difficult to maintain and communicate an overview of complex data systems. Beneath changes this with the Console, a web-based UI for Beneath. It’s designed to make it easy to:

  • Discover and explore data on Beneath
  • Monitor the flow and health of streams
  • Understand which streams that are derived or transformed from other streams
  • Share data safely with less experienced users (who might not have a background in data science)

The Console is currently focused on displaying streams, integrations and resources. To create new streams or other resources, use the Beneath CLI.

Browsing the Console

You access the Beneath Console by visiting https://beneath.dev or clicking the “Console” button on the top-right corner of this website. You don’t have to be logged in to use most parts of the Console.

Accessing the Console will take you to the springboard, the entry point to the console. If you are not logged in, it will show you interesting data to explore. If you are logged in, you will see an overview of your usage and your projects.

Resources in the Console follow the /organization/project/stream hierarchy described in Resources. Note that if you’re not part of an organization, your username is your organization name.

Managing public information

User and organization profiles are public on Beneath (similar to Github). You can customize your name, biography and profile picture on your profile page, which is found at beneath.dev/<USERNAME OR ORGANIZATION NAME>.

Issuing secrets

To log into the Beneath CLI or to access streams from your code, you need a secret. You can issue new secrets from the “Secrets” tab of your user or organization page. You can learn more about secrets in the sections Resources and Access management.

Monitoring usage

Use the “Monitoring” tab on the page of any user, organization, service or stream to view usage statistics. This is useful to monitor the health of your streams and to understand costs. Click here to read more about the usage statistics Beneath tracks.

Exploring streams

You can browse the data in a stream in the Beneath Console. It provides different representations of the data, mirroring the different underlying data systems where the data is stored. In short:

  • Log representation lets you browse records in the order they were written. You can sort records by “oldest” or “newest”.
  • Index representation lets you browse records sorted by their key. It only contains the newest record for each key (unlike the log, which contains every version). You can provide a filter to quickly lookup records by their key. See the Reading and Writing Data section for details on the filter query syntax.

The Console automatically subscribes to real-time updates when you view a stream, so the data will update within milliseconds in response to new writes.