The CrateDB Admin UI

CrateDB ships with a web administration user interface (UI), or admin UI for short.

The CrateDB admin UI runs on every CrateDB node, and 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

The admin UI is accessible via HTTP at port 4200, at a URL like so:

http://HOSTNAME:4200/

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

Tip

If port 4200 is accessed 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 JSON.

Overview Screen

Here’s what the admin UI will look like when it first loads:

_images/admin-ui.png

Note

This is the Enterprise version of admin UI. The community version uses a lighter theme.

The navigation is split into two parts:

Status Bar

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

  • Cluster name
  • CrateDB version
  • Number of nodes in the cluster
  • Health checks
    • Data status:
      Green:All data is replicated and available
      Yellow:There are unreplicated records
      Red:Some data is unavailable
    • Cluster status:
      Green:Good configuration
      Yellow:Some configuration warnings
      Red:Some configuration errors
  • Average cluster load (for the past minute, 5 minutes, and 15 minutes)
  • Settings and notifications menu