System views

System views subsystem

❗️

This is a legacy Apache Ignite documentation

The new documentation is hosted here: https://ignite.apache.org/docs/latest/

A new system view subsystem was introduced. The main goal of the new subsystem is to provide the user with the ability to view lists of Ignite internal entities via several independent pluggable exporters.

Almost all users of the classical RDBMS are familiar with the system view concept. Ignite system views provide the same approach as an RDBMS system view. The main difference - Ignite system views can be accessed by any protocol implemented by the exporter. SQL and JMX are supported out of the box.

  • JMX and SQL exporter are enabled by default. No explicit configuration required.
  • SQL views are in SYS schema.
  • Exporters are configured during node startup and can't be changed in runtime.
  • All system views data are local if otherwise not specified explicitly.

Here is the list of available system views:

Entities

  • System view - named list of some Ignite internal objects.
  • System view exporter - Ignite SPI implementation that can export system view by some specific protocol. Exporters configured via IgniteConfiguration#setSysteViewExporterSpi. One can configure several exporters. If you need integration via any protocol that is not supported out of the box, please, consider the creation of custom implementation of org.apache.ignite.spi.systemview.SystemViewExporterSpi.

Exporters

JMX exporter

Each system view exported as a JMX bean that contains TabularData.

SQL exporter

Each system view exported as a SQL System view in the SYS schema.