Page tree

SAYMON документация

Skip to end of metadata
Go to start of metadata

Some elements of SAYMON web interface can be configured in the client configuration file /usr/local/saymon/client/client-config.js.

In some cases the file  client-config.js can be stored in another directory. The directory can be found by either checking the nginx configuration file or using the following command:

sudo find / -name "client-config.js"

Section/Parameter                                   Description
agentInstallerUrlA link to download an agent installation script.

authEnabled

It activates manual registration for users;

    • false | registration is disabled,
    • true | registration is enabled.

By default false | registration is disabled.

canEditObjectStyleIt allows to configure CSS styles for objects and links. With the option is enabled, the section Parameters contains the subsection Style (of objects, links).
collapseSections

It specifies the way graphs are displayed. If it is set to true then the sections are collapsed, otherwise the section are opened.

    • false | graphs are shown,
    • true | graphs are hidden.

By default false | graphs are shown.

Comet

Along with standard HTTP, SAYMON utilizes Comet to exchange data between the client and the server.

comet: {
    port: 8091
},
...
comet.port

Port number that the Comet server listens on.

By default 8091.

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 identificator, for example, 29.

defaultClassImage.'<number>'.
img

Path to the image relatively 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

Name of the widget.

defaultEmbeddableLink.url

URL to which the widget refers.

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:

Documentation

This section allows to set links to various documentation for SAYMON.

documentation: {
	main: {
    	root: 'https://wiki.saymon.info/display/SAYMONEN',
        ru: 'https://wiki.saymon.info/display/SAYMONRU'
    },
    notificationTemplates: {
    	root: 'https://wiki.saymon.info/display/SAYMONEN/Notification+templates',
        ru: 'https://wiki.saymon.info/display/SAYMONRU/Notification+templates'
    }
},
...
documentation.mainLinks to user documentation.
documentation.main.rootLink to English-language documentation.
documentation.main.ruLink 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.
enableConditionalIncidents

It enables incidents functionality;

    • false | functionality is disabled,
    • true | functionality is enabled.

By default false | functionality is disabled.

enableSmsTrigger

It enables SMS-notifications;

    • false | SMS-notifications are disabled,
    • true | SMS-notifications are enabled.

By default false | SMS-notifications are disabled.

enableVoiceCallTrigger

It enables voice notifications;

    • false | voice notifications are disabled,
    • true | voice notifications are enabled.

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:

  • 1 (Root),
  • 3 (Host),
  • 13 (Node),
  • 43 (Dashboard).

GeoMap

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

geoMap: {
    serverName: undefined,
    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.

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
},
...
grid.border

Maximum indent between objects and grid border (in pixels).

By default 4.

grid.color

Grid color in the RGBA format.

Be 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

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.colWidthWidth of objects with gridView.cols = 0 (in pixels).
gridView.gutterSize

Indent between objects (in pixels).

By default 5.

gridView.rowHeight

Height of objects (in pixels).

By default 90.

hideConnectionStatusNotifications

It hides notifications about the status of the current connection;

    • false | notifications are not hidden,
    • true | SMS-notifications are hidden.

By default false | notifications are not hidden.

History

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

history: {
    slider: false,
    downsampling: [
        [[1, 'hours'], '15s-avg'],
        [[1, 'days'], '5m-avg'],
        [[1, 'weeks'], '1h-avg'],
        ['1d-avg']
    ],
    modelChangeAnnotations: false
},
...
history.downsamplingDownsampling parameters.
history.modelChangeAnnotations

It activates the option which allows to change annotations on graphs;

    • false | annotation changing is disabled,
    • true | annotation changing is enabled.

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 deactivated,
    • true | slider is activated.

By default false | slider is deactivated.

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 is 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.

millisecondMonitoring

It enables data update every millisecond.

    • false | update is disabled,
    • true | update is enabled.

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.

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 $SAYMON_ROOT/target/client/css.

$SAYMON_ROOT/target/client/css is the directory where SAYMON is installed.

  • No labels