Skip to main content

Managing Reporting Database on Zenconsole

Published on:
.
2 min read

The Reporting Database Management page allows administrators to manage reporting database settings for a selected gateway in Zenconsole.

This page, accessible under Gateway Settings, provides gateway-specific controls for configuring how reporting data is stored, retained, and managed. Administrators can view the active reporting database backend and manage reporting-related data directly from the user interface.

Reporting database management is performed on a per-gateway basis, enabling administrators to optimize reporting behavior based on network size, traffic volume, and available hardware resources. Zenconsole provides an intuitive and user-friendly interface that simplifies reporting and database management and reduces configuration complexity.

Figure 1. Reporting Database Management

The Reporting Database Management page provides access to various configuration and management options related to reporting data. Details about the available settings and management capabilities on this page are described in the sections below.

Reporting Database Configuration​

The Reporting Database Configuration section provides an overview of the reporting database settings configured for the selected gateway.

On this page, administrators can view information about the currently active reporting database backend and change the reporting database backend used by the selected gateway.

Figure 2. Reporting Database Configuration Pane

Follow the steps below to access the Reporting Database Configuration page for a gateway:

  1. Log in to your Zenconsole account and select your organization.

  2. Navigate to Settings from the left-hand menu.

  3. Click Gateway Settings.

  4. Select the gateway you want to manage.

  5. Go to Reporting & Data.

  6. Click Reporting Database.

  7. Locate Reporting Database Configuration pane.

    The Reporting Database Configuration page is displayed, where you can view the active reporting database backend and access related management options.

    Figure 3. Reporting Database Page

Supported Reporting Databases​

Zenconsole supports multiple reporting database backends to accommodate different deployment sizes, reporting requirements, and infrastructure capabilities. Each reporting database option offers a different balance between simplicity, scalability, and resource usage.

Before changing the reporting database backend, administrators should carefully evaluate the characteristics and requirements of each option to ensure that it aligns with their network size, traffic volume, and hardware resources.

warning

Changing the reporting database backend will reset the reporting database for the selected gateway.

This action is irreversible and should be carefully considered before proceeding.

You can find the available reporting database backends and their descriptions below.

  1. Elasticsearch (Local): Elasticsearch (local) uses an Elasticsearch service installed and running directly on the gateway. Compared to SQLite, it provides better performance, scalability, and support for higher traffic volumes and longer data retention periods.

    This option is suitable for medium to large networks where the gateway has sufficient CPU, memory, and disk resources to run Elasticsearch reliably.

    note

    Before selecting Elasticsearch (local), Elasticsearch must be installed on the gateway and accessible via the HTTP port without requiring authentication credentials.

    Figure 4. Changing reporting database - Elasticsearch (local)

  2. Elasticsearch (Remote): Elasticsearch (remote) allows the gateway to store reporting data in an external Elasticsearch service reachable over the network. This option enables centralized and scalable reporting architectures, especially in large or distributed environments.

    When this option is selected, administrators must provide the remote Elasticsearch connection details, including the database URL and, if applicable, authentication credentials. The gateway must be able to successfully connect to the remote Elasticsearch service before the change can be applied.

    info

    Database username and password are required only if authentication is enabled on the remote Elasticsearch server.

    Figure 5. Changing reporting database - Elasticsearch (remote)

  3. SQLite (Local): SQLite is a lightweight, file-based reporting database that runs locally on the gateway. It is designed for small-scale deployments and environments with limited reporting requirements.

    This option supports up to 100 devices and requires minimal system resources, making it suitable for test environments, lab setups, or small networks where long-term data retention is not required.

    note

    SQLite is not recommended for large-scale deployments or environments that require extended reporting data retention.

    Figure 6. Changing reporting database - SQLite (local)

Change Reporting Database​

The Change Reporting Database option allows administrators to change the reporting database backend used by the selected gateway.

This option is available on the Reporting Database Configuration pane and can be used to switch between supported reporting database backends according to reporting requirements and infrastructure capabilities.

Follow the steps below to change the reporting database backend:

  1. Log in to your Zenconsole account and select your organization.

  2. Navigate to Settings from the left-hand menu.

  3. Click Gateway Settings.

  4. Select the gateway you want to manage.

  5. Go to Reporting & Data.

  6. Click Reporting Database.

  7. Locate Reporting Database Configuration pane.

  8. Click Change Reporting Database.

  9. The Change Reporting Database dialog is displayed, showing the available reporting database backend options.

    Figure 7. Changing Reporting Database

  10. Select the reporting database backend you want to use.

  11. Review the notes and warnings displayed in the dialog carefully.

  12. If required, enter the necessary configuration details (for example, remote Elasticsearch connection information).

  13. Click Change.

    Figure 8. Changing reporting database - SQLite (local)

  14. In the confirmation dialog (Please read carefully before proceeding), review the information and click Continue to confirm the operation, or click Cancel to abort.

    Figure 9. The Confirmation Dialog

Once confirmed, the reporting database backend is updated for the selected gateway.

Last updated on by Zenarmor