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):
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
Section/Parameter | Description |
---|---|
authentication.availableMethods |
List of availabe user authentication methods:
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.
Section/Parameter | Description | ||
---|---|---|---|
authentication.services.keycloak |
Section with parameters for authentication via Keycloak. |
||
authentication.services.keycloak. |
Name of the configuration file generated by the Keycloak server for the web application.
|
||
authentication.services.keycloak. |
enables support for Keycloak server version 19 and older;
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"
Section/Parameter | Description | ||
---|---|---|---|
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.
|
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
DefaultEmbeddableLink
It allows to embed widgets with information about objects to external resources.
defaultEmbeddableLink:
url: http://saymon.info/
name: SAYMON
Section/Parameter | Description |
---|---|
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.
Section/Parameter | Description |
---|---|
documentation.main.root |
Link to English-language documentation. |
documentation.main.ru |
Link to Russian-language 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
Section/Parameter | Description |
---|---|
geoMap.initialPosition |
Initial position on the map [longitude, latitude]. By default Russia, Saint Petersburg. |
geoMap.initialZoom |
Initial zoom of the map. By default - 8. |
geoMap.serverName |
Name of the server used for displaying the map. By 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
Section/Parameter | Description |
---|---|
grid.border |
Maximum indent between objects and grid border (in pixels) By default - 4. |
grid.color |
Grid color in the RGBA format. By default - "rgba(128, 128, 128, 0.3)." |
grid.dim |
Grid size (in pixels). By default - 20. |
GridView
This section contains parameters of displaying objects in the Grid view.
gridView:
cols: 6
colWidth: 240
rowHeight: 90
gutterSize: 5
Section/Parameter | Description |
---|---|
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. By default - 6. |
gridView.colWidth |
Object width with gridView.cols = 0 (in pixels). By default - 240. |
gridView.gutterSize |
Indent between objects (in pixels). By default - 5. |
gridView.rowHeight |
Height of objects (in pixels). By 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
Section/Parameter | Description |
---|---|
history.downsampling |
Downsampling parameters. |
history.modelChangeAnnotations |
Whether to allow annotation changing on graphs
By 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. By 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
Section/Parameter | Description |
---|---|
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.
Section/Parameter | Description |
---|---|
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. - es, - gb, - it, - ru, - us. |
Monitoring
This section contains parameters to hide unused monitoring probes from the interface.
monitoring:
standardTasks:
- ping
- snmpGet
Section/Parameter | Description |
---|---|
monitoring.standardTasks |
The array of identifiers of the displayed standard probes. |
Tree
This section contains parameters for object tree.
tree:
filterSubmit: true
Section/Parameter | Description |
---|---|
tree.filterSubmit |
It enables the apply filter button and disables the automatic filtering;
By default - false - button is disabled. |
Other parameters
Section/Parameter | Description | ||
---|---|---|---|
agentInstallerUrl |
A link to download an agent installation script. |
||
authEnabled |
It activates manual registration for users;
By default - false - registration is disabled. |
||
canEditObjectStyle |
|||
collapseSections |
|||
defaultPieChartColors |
Default colors for pie chart (Circle).
|
||
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;
By default - false - analytics disabled. |
||
enableConditionalIncidents |
It enables incidents functionality;
By default - false - functionality is disabled. |
||
enableSmsTrigger |
It enables SMS-notifications;
By default - false - SMS-notifications are disabled. |
||
enableSnmpTranslate |
It enables translation of numeric SNMP OIDs to the text format;
By default - false - translation is disabled. |
||
enableVoiceCallTrigger |
It enables voice notifications;
By 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:
|
||
hideConnectionStatusNotifications |
It hides notifications about connection status with the Comet server;
By 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;
By default - false - notifications are displayed in the web interface.
|
||
millisecondMonitoring |
It enables data update every millisecond.;
By 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). By 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). By default - 60000 - 1 minute. |
||
Show the "Stat history" button.
By default – false |
|||
title |
Header for tabs, and also the name, displayed at the top left corner of web interface. By 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
|
||
useNaturalSort |
It enables sorting objects with the javascript-natural-sort library:
By default - false - objects are sorted with native functions of the browser.
|