Schema overview

Overview

Schemas give Gateway Hub information about the type of data being published to it from Geneos.

Each dataview that is published to Gateway Hub requires a schema definition.

The schema for a dataview specifies:

  • The name, data type, and any units of measure, of each headline.
  • The name, data type, and any units of measure of each column.
  • If the dataview is pivoted.

Schemas are defined in the Publishing tab of the sampler in the Gateway Setup Editor (GSE).

The Gateway comes packaged with some schemas. See Built-in schemas.

Other schemas must be defined by you. See User-defined schemas.

Built-in schemas

The Gateway is packaged with built-in schemas for plug-ins with dataviews containing a set of known column names and data types.

Built-in schemas specify pivoting for dataviews containing rows that have only one value column and the data type of this column varies between the rows (for example, the Hardware Plug-in).

If a built-in schema exists for a sampler, This <sampler name> sampler has predefined schema(s) is displayed in the Publishing tab of a sampler in the GSE. For a list of samplers with built-in schemas, see Sampler schema types.

The GSE also has a command that can be used to view the schemas currently defined for dataviews on a sampler. See View existing schemas.

If you make any changes to the dataviews in these samplers, for example by adding headlines and columns using the Compute Engine, you must add these additions to the existing schema. See Define a schema.

User-defined schemas

Some plug-ins do not come with any schema definitions. These are plug-ins where the columns are data types are unknown. You must define the schema for:

  • All toolkit-like plug-ins. Examples of these include the SQL-TOOLKIT, JMX, and TOOLKIT plug-ins.
  • Any pre-existing dataviews with any user-defined headlines or columns.

The following are examples where a schema definition is required for pre-existing dataviews:

For how to create a schema, see Define a schema.

Special case: pivoted dataviews

If you add rows to pre-existing pivoted dataviews, you must define them as if they were additional columns. You do not specify the pivot option if there is a built-in schema for the sampler. If you do, and it conflicts with the built-in schema, it is discarded in favour of the user-defined schema.

View existing schemas

To view existing schemas currently defined for dataviews on a sampler, open Active Console 2 and select Show Current Schema.

When the command is run, a window opens showing one table per dataview, describing the schema defined on the sampler. There is a table for every dataview that has a defined schema, irrespective of whether the dataview is in use. Only dataviews that have a schema definition are shown.

Each table combines information from the built-in schema shipped with the Gateway and any additional information added in the GSE.

A description of the columns shown in each table is below:

Column Name Description
Component Describes if this component is a headline or a column.
Name Name of the headline or column.
Type Data type of the headline or column. The data types are: boolean ; date ; dateTime ; float32 ; float64 ; int32 ; int64 ; string .
Units Unit of measure assigned to this headline or column (if present). For a list of units of measure, see .
Source

Origin of the headline or column and the schema. Cells in this column display one of the following:

  • Base — The built-in schema shipped with the Gateway.
  • Overridden — A built-in schema exists for this headline or column, but has been superseded by the user-defined schema in the Publishing tab of the sampler.
  • Enriched by Compute Engine — Headline or column added to the dataview via the Compute Engine. Schema has been defined in the Publishing tab of the sampler.
  • Defined by User in plugin configuration — Headline or column added to the dataview via a method other than the Compute Engine e.g. a toolkit plug-in. Schema has been defined in the Publishing tab of the sampler.

An example of the output of this command is shown below:

How to access the Show Current Schema command

To access the Show Current Schema command in the Active Console 2, perform the following:

  1. Right-click on a sampler or dataview.
  2. Navigate to Sampler SchemaShow Current Schema.

Note: Running on either the sampler or dataview produces the same result.

In the GSE, the command is available in the Publishing tab of the sampler.