Web Console Administration pages

Overview

This guide provides more information about the sections that can be found in the Administration group in the Geneos Web Console:

  • Ingestion Errors — shows errors related to ingesting data from Geneos.
  • Licence — shows current licence status for Gateway Hub.
  • Publishing — page for configuring Kafka publishing.
  • Storage — contains settings to configure the retention policy and retention period for Gateway Hub data.

Ingestion Errors

The Ingestion Errors page collects and displays dataview errors that are generated from Gateway Hub. These errors are generated due to incorrect schema or data coming from the connected Gateway.

For more information about schemas, see Schema overview.

For how to solve ingestion errors, see Resolve an ingestion error.

Ingestion errors table

The table on the page has the following columns:

Column name Description
Last occurrence Date and time when the dataview error occurred.
Dataview Path Full path of the dataview error.
Error Message Error code and details. For more information, see Web Console error codes.
Occurrences Number of times that the dataview error occurred in the past .

Search box

At the top of the Ingestion Errors page there is a search box that has the following parameters:

  • Search by Path — allows you to filter dataview errors results by dataview path.
  • Error Code — a drop-down list that allows you to filter by error code.

Press Search to filter the table with the parameters.

Error Details sidebar

Clicking on an error in the table brings up with Error Details on the right side of the screen. This sidebar provides further information about the error being displayed:

Error Details Description
Origin Path to the dataview where the error occurred.
Error code Shows the error code, details, and the number of occurrences in red.
Dataview schema Shows the schema currently configured for the dataview.

If there is no detected schema in the given dataview path, the Error Details screen displays this:

For more information on the error codes, see Web Console error codes.

Licence

The Licence page shows information relating to your current licence for Gateway Hub. You can also upload new licences for Gateway Hub using this page.

For how to add a licence, see Add licence keys.

General

Gives general information regarding your licence for Gateway Hub.

Field Description
Type

Type of licence.

Customer Name of customer or organisation the licence is registered to.
Version Licence version.
Created By Licence issuer.
Period of Validity Start and end date of your Gateway Hub licence.
Created On Date licence was created.

Licensed products

This table shows information about other licensed products on your Geneos estate.

Publishing

The Publishing page allows you to configure publishing of normalised metric and event data to a downstream Kafka instance. Only one downstream Kafka instance is supported by a Gateway Hub cluster.

For more information on how to configure publishing to an external Kafka instance, see Kafka Publishing Message Formats.

Kafka Publisher Configuration

This section is where you enter the details of your downstream Kafka instance, and any additional settings.

Enable or disable publishing using the toggle to the right of Publishing.

Field Description
Bootstrap servers

Host:port values that the Gateway Hub uses to establish connection to Kafka. More rows can be added using the add button.

Topic Prefix Optional prefix. This allows you to avoid collisions with existing Kafka topic names. The default is itrs-.
Producer Configuration Name Name of an additional Kafka setting. You can use any setting (other than callbacks) defined in the Apache Kafka documentation . Add more rows as needed using the add button.
Producer Configuration Value Value associated with setting defined in Producer Configuration Name.

Click the Request Snapshot to request a snapshot of all metric data.

Click the Request Schema to request all schemas.

Security protocol

This section is where you select and configure the security protocols. The options are:

  • PLAINTEXT
  • SASL_SSL

If you select SASL_SSL, then the following configuration options appear:

Field Description

CA certificate

Use Upload File to select the certificate used to sign the Kafka broker's public keys.
Kerberos principal Principal name used for Kerberos.
Kerberos keytab The keytab file encoding the password for the Kerberos principal.

Storage

The Storage page allows you to configure the retention policy and retention period for storing data.

During retention execution time, the system discards any metric and event data older than their retention period.

Retention policy

This setting allows you to configure when the retention policy is applied.

Execution Time shows when the retention policy was applied. You can edit when this occurs using the From and To drop-downs.

Retention period

These settings control how long the system retains data in storage. The system discards any data and events older than the specified period.

Both Dataviews and Events settings can be adjusted into a specified number of days, weeks, and months.