Documentation

Web Interface

FeatureBase may be built with a web UI embedded. If so, this is indicated at startup with a log line resembling the following:

enabled Web UI (g290830e) at http://localhost:10101

To access the UI, visit the address :10101 in a web browser. For example when running a FeatureBase instance locally with default settings, visit http://localhost:10101.

When authentication is enabled, TLS must also be enabled. To access the UI, visit http://localhost:10101. The user will be prompted to login through the identity provider’s website, and will be redirected to FeatureBase home page once authentication is complete. The information available in the web interface may be restricted, depending on the user’s permissions.

Using the user interface you can check the global status of your FeatureBase cluster.

It contains information about the cluster nodes, data, and has an interface for querying the cluster with both PQL and SQL.

Home

introduction

Cluster Health

cluster health problem

Cluster Health shows the global status of the cluster, and it contains an expanded view for each node.

The cluster state display has five possible values:

  • NORMAL: All nodes are working ok and all data is available.

  • DEGRADED: Some nodes are not reachable, but all data is still available.

  • STARTING: Some nodes are not reachable and the cluster is not ready to answer queries.

  • RESIZING: Cluster is resizing. Most endpoints are unavailable until the resize completes.

  • OFFLINE: Cluster cannot be reached from the UI.

Node Health

cluster health

Each node’s individual state is indicated by the colored icon:

  • NORMAL: Node is working ok and all data is available.

  • UNKNOWN: Node is not reachable.

Metrics

metrics

Metrics provide useful information about nodes. More information about them can be found here.

Transactions

Here you can check and finish actual transactions. Clicking Force Finish will close an open transaction. More info about them can be found here.

transaction

Tables

tables ui

All Tables are shown here. We can explore their fields and metadata, like types, cache type and size, and also if there are keys associated with a particular field.

fields

Something missing or incorrect?
Help improve this article or join us on Discord!

© 2022 Molecula Corp. (DBA FeatureBase). All rights reserved.