The CrateDB Admin UI

CrateDB ships with a web administration user interface (or Admin UI).

The CrateDB Admin UI runs on every CrateDB node. You can use it to inspect and interact with the whole CrateDB cluster in a number of ways.

See also

The CrateDB Admin UI is an open source project and is hosted on GitHub.

Table of contents

Connecting

You can access the Admin UI via HTTP on port 4200:

http://HOSTNAME:4200/

Replace HOSTNAME with the hostname of the CrateDB node. If CrateDB is running locally, this will be localhost.

Navigate to this URL in a web browser.

Tip

If you access port 4200 via a client library or command-line tool like curl or wget, the request will be handled by the CrateDB Rest API, and the response will be in JSON.

Navigating

This is what the Admin UI looks like when it first loads:

Take note of the status bar (at the top) and the tabs (down the left side).

Status bar

Along the top of the screen, from left to right, the status bar shows:

• Cluster name

• CrateDB version

• Number of nodes in the cluster

• Health checks

  • Data status

    • Green – All data is replicated and available

    • Yellow – Some records are unreplicated

    • Red – Some data is unavailable

  • Cluster status:

    • Green – Good configuration

    • Yellow – Some configuration warnings

    • Red – Some configuration errors

• Average cluster load (for the past 1 minute, 5 minutes, and 15 minutes)

• Settings and notifications menu

Tabs

On the left-hand side, from top to bottom, the tabs are:

• Overview screen

• SQL console

• Tables browser

• Views browser

• Shards browser

• Cluster browser

• Monitoring overview

• Privileges browser

• Help screen