Skip to main content

Monitoring Tool

Overview​

TimeBase Monitor provides an interface to control and monitor live data being stored in TimeBase. The tool shows data for active cursors, loaders, connections, and locks.

Launch​

TimeBase Monitor is available at the Web URL: http://<TimeBase host>:<TimeBase port>/tb.

If you run TimeBase Monitor locally, you can access it using a local host and port at http://localhost:8011/tb.

Cursors​

Readers use cursors to read from TimeBase. The Cursors page displays all available cursors and their details.

To monitor the messages that cursors recieve from TimeBase:

To display a selected cursor's details:

  • Click +.

The following cursor details are available:

  • Cursor ID: Object internal ascending sequence number.
  • Subscription: Subscription entities and types.
  • Streams: Active streams.
  • User: user of the application reading stream data.
  • Application: application reading stream data.
  • Options: cursor options.
  • Opened: Cursor opening time.
  • Last Reset: Cursor last reset time and date.
  • Closed: Time that the cursor is closed.
  • Messages: Total number of written messages. Tracking has to be enabled.
    • May be used for monitoring and debugging purposes.
    • To update count, refresh the page.
  • Last Msg Time: Last message time.
  • Last next() Time: Last next message time.

To display more of the cursor's details and statistics:

  • Click the ID number.

Cursor information:

Cursor subscription:

Cursor statistics:

Loaders​

Writers use loaders to write data into TimeBase. The Loaders page displays all active loaders and their details.

To monitor the messages that loaders write to TimeBase:

To display a selected loader's details:

  • Click +.

The following loader details are available:

  • Id: Object internal sequence (ascending).
  • Streams: Active streams.
  • Application: Applications consuming stream data.
  • User: User of applications consuming stream data.
  • Options: Cursor options.
  • Messages: Total number of written messages. Tracking has to be enabled.
    • May be used for monitoring and debugging purposes.
    • To update count, refresh the page.
  • Loader ID: Id.
  • Opened: Loader opening time.
  • Last Msg Time: Last message time.
  • Last send() Time: Last sent message time.

To display more of the loader's details and statistics:

  • Click the ID number.

Loader information:

Global sorting:

Loader statistics:

Connections​

The Connections page displays real-time connections' statistics.

To display a selected connection's details:

  • Click +.

Active connections display average and current connection throughput.

To display a connection's advanced details and virtual channels:

  • Click a client ID.

Connection information:

Virtual channels:

Locks​

The Locks page displays all current stream Locks and their details.

To display a selected connection's details:

  • Click +.

READ and WRITE locks can be attributed to a particular stream.

  • WRITE lock: Only the selected client can write to the stream.
  • READ lock: Many clients can read, but none can write (edit) to the stream.

License​

The License page displays the current TimeBase license details.

Live Tracking​

Live tracking allows you to monitor the messages that cursors and loaders send to and recieve from TimeBase (TB). Collecting this data can help you debug issues, like a situation where data is not coming into TB.

Using this feature requires additional CPU and affects the performance of cursors and loaders. As such, use the live tracking feature for a defined period of time, and do not leave it running indefinitely. This will allow you to save server resources.

Until you turn on live tracking, the # Msgs column displays a zero message count.

To turn on live tracking:

  • Click Start Tracking.

To turn off live tracking:

  • Click Stop Tracking.

To see an updated message count:

  • Refresh the page.

FAQ​

Q: Why am I seeing a zero message count?

A: Until you turn on live tracking, the # Msgs column displays a zero message count. Turn on live tracking and refresh the page. Tracked messages will appear in the table. Remember to turn off live tracking when you are finished in order to not waste CPU.

Q: If I start and stop live tracking more than once, what data does the UI reflect?

A: The information presented in the tables reflects the cumulative data for all live tracking sessions.