Web application configuration

Configuration parameters of Saymon web application are stored in the configuration file /etc/saymon/saymon-client.yaml.

Web application configuration files can also be stored in the following locations (in descending order of priority):

  • MongoDB – parameters that can be edited via Rest API;

  • /etc/saymon/saymon-client.yaml – web application configuration parameters in YAML format;

  • /etc/saymon/saymon-client.json – web application configuration parameters in JSON format;

  • /etc/saymon/client-config.js – web application configuration parameters in the old JS format (used with old versions of the web application);

  • ./backend/server/saymon-client.yaml – default web application configuration parameters.

A lower priority configuration file is used if there is no higher priority configuration file.

Below is a description of the configuration parameters that are stored in saymon-client.yaml.

authentication

In this section, you can configure user authentication parameters.

authentication:
  availableMethods:
    - native
    - keycloak
  methodByDefault: keycloak
    services:
      keycloak:
        configUri: keycloak_frontend.json
        legacySupport: false

authentication.availableMethods

List of available user authentication methods:

  • "native" – username and password authentication

  • "keycloak" – authentication via Keycloak

By default "native" is used.

authentication.methodByDefault

Authentication method that is used by default.

By default "native" is used.

authentication.services

Section with configuration parameters of authentication services.

authentication.services.keycloak

Section with parameters for authentication via Keycloak.

authentication.services.keycloak.configUri

Name of the configuration file generated by the Keycloak server for the web application.

The file must be placed on the SAYMON server in the /etc/saymon directory.

authentication.services.keycloak.legacySupport

Enables support for Keycloak server version 19 and older;

  • false – support for Keycloak server version 19 and older is disabled;

  • true – support for Keycloak server version 19 and older is enabled.

By default false – disabled.

comet

Section with parameters that define interaction between the web application and Saymon via the Comet server.

comet:
  port: 8091
  url:
    - "https://cpult.ru/ws"
    - "http://10.78.5.11:8092"

comet.port

Port number that the web application uses to connect to the Comet server.

Port 8091 is used by default.

comet.url

Address for connecting the web application to the Comet server from different networks.

If the comet.url parameter is specified, then the comet.port parameter is ignored.

configuration

Section with system configuration window parameters.

configuration:
  objectPermissions:
    displayType: tree

configuration.objectPermissions

Object access settings.

configuration.objectPermissions.displayType

Object access menu display settings.

  • tree – Display object access menu as a tree of all objects in the system,

  • simple – Display a simplified object access interface.

Default value – tree.

defaultClassImage

It allows to set a standard icon and its size for objects of a particular class.

defaultClassImage:
  "29":
    img: /images/cloud.svg
    dim:
      - 100
      - 75

defaultClassImage.<number>

Class ID, 29, for example.

defaultClassImage.<number>.img

Path to the image relative to the directory where the configuration file is located.

defaultClassImage.<number>.dim

Size of the image (in pixels, [width, height]).

defaultEmbeddableLink

It allows to embed widgets with information about objects to external resources.

defaultEmbeddableLink:
  url: http://saymon.info/
  name: SAYMON

defaultEmbeddableLink.name

Widget name.

defaultEmbeddableLink.url

URL to which the widget refers.

documentation

This section allows to set links to SAYMON documentation.

documentation:
  main:
    root: https://wiki.saymon.info/display/SAYMONEN
    ru: https://wiki.saymon.info
  notificationTemplates:
    root: https://wiki.saymon.info/display/SAYMONEN/Notification+templates
    ru: https://wiki.saymon.info/pages/viewpage.action?pageId=45385140
  restApi:
    root: https://api.saymon.tech

documentation.main

Links to user documentation.

documentation.main.root

Link to English-language documentation.

documentation.main.ru

Link to Russian-language documentation.

documentation.notificationTemplates

Links to notification templates.

documentation.notificationTemplates.root

Links to English-language notification templates.

documentation.notificationTemplates.ru

Links to Russian-language notification templates.

documentation.restApi

Links to REST API documentation.

documentation.restApi.root

Link to REST API documentation.

geoMap

SAYMON allows to link objects to their geographical location and browse them on a map.

geoMap:
  serverName: openstreetmap.org
  initialPosition:
    - 30.341306
    - 59.930089
  initialZoom: 8

geoMap.initialPosition

Initial position on the map [longitude, latitude].

By default Russia, Saint Petersburg.

geoMap.initialZoom

Initial zoom of the map.

Default – 8.

geoMap.serverName

Name of the server used for displaying the map.

Default – openstreetmap.org.

It is also possible to use a local OSM server.

grid

This section allows to set a grid for objects alignment in the Standard view.

grid:
  dim: 20
  color: rgba(128, 128, 128, 0.3)
  border: 4

grid.border

Maximum indent between objects and grid border (in pixels)

Default – 4.

grid.color

Grid color in the RGBA format.

Default – "rgba(128, 128, 128, 0.3)."

grid.dim

Grid size (in pixels).

Default – 20.

gridView

This section contains parameters of displaying objects in the Grid view.

gridView:
  cols: 6
  colWidth: 240
  rowHeight: 90
  gutterSize: 5

gridView.cols

Amount of objects placed in one row of the grid.

With gridView.cols > 0 width of objects changes automatically.

With gridView.cols = 0 the number of objects in a row adjusts to the screen width.

Default – 6.

gridView.colWidth

Object width with gridView.cols = 0 (in pixels).

Default – 240.

gridView.gutterSize

Indent between objects (in pixels).

Default – 5.

gridView.rowHeight

Height of objects (in pixels).

Default – 90.

history

This section contains parameters for displaying data on graphs, also some additional interface elements, used for plotting, can be activated here.

history:
  slider: false,
  downsampling:
    - period: 1-hours
      dsp: 15s-avg
    - period: 1-days
      dsp: 5m-avg
    - period: 1-weeks
      dsp: 1h-avg
    - dsp: 1d-avg
  modelChangeAnnotations: false

history.downsampling

Downsampling parameters.

history.modelChangeAnnotations

Whether to allow annotation changing on graphs

  • false – annotation changing is disabled,

  • true – annotation changing is enabled.

Default – false – annotation changing is disabled.

history.slider

It activates the slider, which is used for setting time range of data displaying;

  • false – slider is disabled,

  • true – slider is enabled.

Default – false – slider is disabled.

incidents

In this section additional fields for the lists of active alarms and historical alarms can be set.

incidents:
  additionalFields:
    - properties.address,
  additionalFieldNames:
    - IP-address

incidents.additionalFieldNames

Names of the additional fields, which are displayed in the web interface.

incidents.additionalFields

Data sources for the additional fields.

languages

This section allows to control installed languages of web interface.

languages:
  en:
    short: us
    long: English
  ru:
    short: ru
    long: Русский
  it:
    short: it
    long: Italiano

languages.<id>

Language identifier. Web interface is available on three languages:

  • en | English,

  • it | Italian,

  • ru | Russian.

languages.<id>.long

Language full name.

This name displayed in SAYMON current user menu with selecting an interface language.

languages.<id>.short

Identifier of the flag icon.

This icon displayed in SAYMON current user menu with selecting an interface language.

image – es,

image – gb,

image – it,

image – ru,

image – us.

monitoring

This section contains parameters to hide unused monitoring probes from the interface.

monitoring:
  standardTasks:
    - ping
    - snmpGet

monitoring.standardTasks

The array of identifiers of the displayed standard probes.

tree

This section contains parameters for object tree.

tree:
  filterSubmit: true

tree.filterSubmit

It enables the apply filter button and disables the automatic filtering;

  • false – button is disabled,

  • true – button is enabled.

Default – false – button is disabled.

Other parameters

agentInstallerUrl

A link to download an agent installation script.

authEnabled

It activates manual registration for users;

  • false – registration is disabled,

  • true – registration is enabled.

Default – false – registration is disabled.

canEditObjectStyle

It allows to configure CSS styles for objects and links.

With the option is enabled, the section Parameters contains the subsection Style (of objects, links);

  • false – style configuration is disabled,

  • true – style configuration is enabled.

Default – true – style configuration is enabled.

collapseSections

It specifies the way sections and graphs are displayed;

  • false – sections are pinned, graphs are shown,,

  • true – sections are unpinned, graphs are hidden.

Default – true – sections are unpinned, graphs are hidden.

defaultPieChartColors

Default colors for pie chart (Circle).

defaultPieChartColors:
  - "#a90329"
  - "#3276b1"
  - "#009F3D"
  - "#9868B8"
  - "#F2C001"
  - "#FF742C"
  - "#90574E"
  - "#EB77BE"
  - "#FF9796"
  - "#AAC6E5"
  - "#8BDE90"
  - "#FDB5D0"

disabledSections

It allows to remove sections shown in the End view in the upper part of the screen.

The list of all available sections:

enableAnalytics

It enables analytics module;

  • false – analytics disabled,

  • true – analytics enabled.

Default – false – analytics disabled.

enableJiraTrigger

Enables creation of a Jira task on object’s state change.

  • false – functionality is disabled,

  • true – functionality is enabled.

Default – false – functionality is disabled.

enableConditionalIncidents

It enables incidents functionality;

  • false – functionality is disabled,

  • true – functionality is enabled.

Default – false – functionality is disabled.

enableSmsTrigger

It enables SMS-notifications;

  • false – SMS-notifications are disabled,

  • true – SMS-notifications are enabled.

Default – false – SMS-notifications are disabled.

enableSnmpTranslate

It enables translation of numeric SNMP OIDs to the text format;

  • false – translation is disabled,

  • true – translation is enabled.

Default – false – translation is disabled.

enableVoiceCallTrigger

It enables voice notifications;

  • false – voice notifications are disabled,

  • true – voice notifications are enabled.

Default – false – voice notifications are disabled.

forceEmptyStandardView

By default, when an object is selected, SAYMON shows its End view, even if the object does not contain other objects.

The list of Class IDs, for which SAYMON will display the Standard view if the selected object is empty, can be set in this parameter.

By default:

  • 1 (Root),

  • 3 (Host),

  • 13 (Node),

  • 43 (Dashboard).

hideConnectionStatusNotifications

It hides notifications about connection status with the Comet server;

  • false – notifications are displayed in the web interface,

  • true – notifications are displayed in the console.

Default – false – notifications about connection status with the Comet server are displayed in the web interface.

hideResponseErrorNotifications

It hides notifications about errors which can take place with sending automatic requests to the server;

  • false – notifications are displayed in the web interface,

  • true – notifications are hidden.

Default – false – notifications are displayed in the web interface.

The errors which take place with the participation of the user, for instance, saving any data in forms, will be displayed in the web interface in any case.

millisecondMonitoring

It enables data update every millisecond.;

  • false – update is disabled,

  • true – update is enabled.

Default – false – update is disabled.

pollInterval

Time period between data requests from the REST server, if the connection between the client and the Comet server is unavailable (in milliseconds).

Default – 5000 – 5 seconds.

pollIntervalSocket

Time period between data requests from the Comet server, if the connection between the client and the Comet server is available (in milliseconds).

Default – 60000 – 1 minute.

statHistory

Show the "Stat history" button.

  • true – button is enabled,

  • false – button is disabled.

Server configuration parameter agent_stat must be enabled.

By default – false

title

Header for tabs, and also the name, displayed at the top left corner of web interface.

Default – SAYMON.

themes

This parameter is used to configure SAYMON themes.

The theme Light is used by default. There is also the available theme Dark.

CSS files with the themes are located in the directory $SAYMON_ROOT/target/client/css.

$SAYMON_ROOT is the directory where SAYMON is installed.

themes:
  default:
    name: Light
  dark:
    name: Dark

useNaturalSort

It enables sorting objects with the javascript-natural-sort library:

  • false – objects are sorted with native functions of the browser,

  • true – objects are sorted with the javascript-natural-sort library.

Default – false – objects are sorted with native functions of the browser.

With set useNaturalSort = true performance of the web interface can degrade if there is huge number of objects in the system (100 000 and more).