Config

Availability table

Controller availability

Module	Available
module.scripts
module.keycloak

config controller

Provides access of configuration elements like dashboard, severities, …

config.getDashboards()

Get all dashboards defined in the web module

Returns:

Contains a list of dashboards, each with its associated properties. The result includes a content key, which contains a dashboards key holding a list of Dashboard() objects. Each Dashboard() object includes properties such as id, description, tags and folders.

config.getSeverities()

Get all severity levels defined in the web module

Returns:

Contains a list of severity levels, each with all its associated properties. The result includes a content key, which contains a severities key holding a list of Severity() objects. Each Severity() object includes properties such as id, name, description and severity.

Color

class config.Color()

A color used be the front-end to display element.

Color.light

The color used for the light theme with the format #AABBCC.

The type of the field is string.

Color.dark

The color used for the dark theme with the format #AABBCC.

The type of the field is string.

Dashboard

class config.Dashboard()

Object representing a dashboard.

Dashboard.id

The id of the dashboard.

The type of the field is string.

Dashboard.title

The title of the dashboard.

The type of the field is string.

Dashboard.description

The description of the dashboard.

The type of the field is string.

Dashboard.tags

The tags of the dashboard.

The type of the field is string[].

Dashboard.folders

The folders of the dashboard.

The type of the field is string[].

Dashboard.searchBehavior

The search behavior of the dashboard.

The type of the field is string.

Dashboard.getDescription()

Get the description of the dashboard

Deprecated since version 2.1.0: Use config.Dashboard.description instead.

Returns:

A string representing the description of the dashboard

Dashboard.getFolders()

Get the tags of the folders

Deprecated since version 2.1.0: Use config.Dashboard.folders instead.

Returns:

A list of string representing the folders of the dashboard

Dashboard.getId()

Get the id of the dashboard

Deprecated since version 2.1.0: Use config.Dashboard.id instead.

Returns:

A string representing the id of the dashboard

Dashboard.getTags()

Get the tags of the dashboard

Deprecated since version 2.1.0: Use config.Dashboard.tags instead.

Returns:

A list of string representing the tags of the dashboard

Severity

class config.Severity()

Object representing a severity.

Severity.id

The id of the severity.

The type of the field is string.

Severity.name

The name of the severity.

The type of the field is string.

Severity.description

The description of the severity.

The type of the field is string.

Severity.severity

The value of the severity.

The type of the field is number.

Severity.fallback

The fallback status of the severity. If true, this severity will be used when an unknown severity is encounter.

The type of the field is boolean.

Severity.fgColor

The foreground color of the severity. See config.Color().

The type of the field is Color.

Severity.bgColor

The background color of the severity. See config.Color().

The type of the field is Color.

Severity.fgHiColor

The highlighted foreground color of the severity. See config.Color().

The type of the field is Color.

Severity.bgHiColor

The highlighted background color of the severity. See config.Color().

The type of the field is Color.

Severity.getBgColor()

Get the background color

Deprecated since version 2.1.0: Use config.Severity.bgColor instead.

Returns:

A string representing the foreground color used by the severity. See config.Color().

Severity.getBgHiColor()

Get the background color when highlighted

Deprecated since version 2.1.0: Use config.Severity.bgHiColor instead.

Returns:

A string representing the highlighted background color used by the severity. See config.Color().

Severity.getDescription()

Get the description of the severity

Deprecated since version 2.1.0: Use config.Severity.description instead.

Returns:

A string representing the description of the severity

Severity.getFgColor()

Get the foreground color

Deprecated since version 2.1.0: Use config.Severity.fgColor instead.

Returns:

A string representing the foreground color used by the severity. See config.Color().

Severity.getFgHiColor()

Get the foreground color when highlighted

Deprecated since version 2.1.0: Use config.Severity.fgHiColor instead.

Returns:

A string representing the highlighted foreground color used by the severity. See config.Color().

Severity.getId()

Get the id of the severity

Deprecated since version 2.1.0: Use config.Severity.id instead.

Returns:

A string representing the id of the severity

Severity.getName()

Get the name of the severity

Deprecated since version 2.1.0: Use config.Severity.name instead.

Returns:

A string representing the name of the severity

Severity.getSeverity()

Get the severity value

Deprecated since version 2.1.0: Use config.Severity.severity instead.

Returns:

An number representing the value of the severity

Severity.isFallback()

Get the severity fallback status

Deprecated since version 2.1.0: Use config.Severity.fallback instead.

Returns:

true if the severity is the fallback one (aka default)