Skip to content
Tadaya Tsuyukubo edited this page Feb 23, 2017 · 6 revisions

Overview

Xenon provides a built-in application which federates information from nodes across the node groups and visualize them in a single pane of UI. It also offers a rich set of features that can help you:

  • Navigate to any node within the node groups and browse node-specific document contents.
  • Add/Edit/Delete instances with test payloads.
  • Generate query tasks interactively.
  • Trace operations.
  • Extract logs that are specific to each node.

Availability

Xenon UI comes with every Xenon jar after 0.9.5 and is available in http://localhost:8000/core/ui/default.

Configuration

  • Include xenon-ui.jar
  <dependency>
    <groupId>com.vmware.xenon</groupId>
    <artifactId>xenon-ui</artifactId>
    <version>[VERSION]</version>
  </dependency>
  • Start UiService in your ServiceHost#start()
   super.startService(new UiService());

Browser Compatibility

As of now Xenon UI is fully compatible with Chrome. Better compatibility with other browsers will be introduced in future releases.

Note It is still in its early stage of development and is expected to iterate/change rapidly.

Features

Node Selector

Displays all the peer nodes and their system info in the current group, and you can select a specific node so the UI shows all the information relevant to this node.

Node Selector

Dashboard

Shows stats for CPU, Memory and Disk usage, and logs.

Dashboard

Services

Lists all the available factory services with their status and options.

Factory Services

Under each factory service comes detailed information and stats of the service instances.

Service Instance Details

You can also easily Create, Edit(PATCH/PUT) and Delete instances from the UI.

Logs

Since logs are specific to each node, the UI provides an easy way to browse the logs on different nodes.

Logs

Queries

Interactive query builder for generating simple queries (up to one level of nested boolean clauses).

Queries

If you are really savvy with the queries, try out the "Advanced" query.

Queries Advanced

Query results will be displayed on the same page for further review.

Query Result

Operation Tracing

Provides a visual way for you to see what operation hits which service at what time. This is very helpful when debugging Xenon’s asynchronous operations.

Operation Tracing

Documentation

Refer to Xenon UI Readme

Build Your Own UI?

Refer to Host Your UI

Clone this wiki locally