SAYMON Documentation
Page tree

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

Skip to end of metadata
Go to start of metadata

Server configuration is performed in the file /etc/saymon/saymon-server.conf.

To apply changes the service saymon-server must be restarted:

sudo service saymon-server restart

The following is description of the sections and settings.


Section/Parameter                        Description

Cache

The section contains Redis server settings.
cache.auth_passPassword for access to the Redis server.
cache.host

The Redis server address.

By default "127.0.0.1".

cache.port

The Redis server port.

By default 6379.

Kafka

This section contains settings for connection to Kafka broker. 
kafka.create_topics

It enables automatic creation of topics;

    • false | automatic creation is disabled,
    • true | automatic creation is enabled.

By default false | automatic creation is disabled.

kafka.fetch_latest

It enables taking the last messages from the broker;

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

By default false | taking is disabled.

kafka.host

Kafka broker address.

By default "localhost".

kafka.logLevel

Kafka logging level;

    • 0 | NOTHING,
    • 1 | ERROR,
    • 2 | WARN,
    • 4 | INFO,
    • 5 | DEBUG.

By default 2 | WARN.

kafka.port

Kafka broker port.

By default 9092.

kafka.requestTimeout

The client waiting time for answer (in milliseconds).

By default 30000 | 30 seconds.

LDAP 

This section contains parameters of outer LDAP server for authorization.

"ldap" : {
	"login" : "cn=admin,dc=saymon,dc=info",
	"pass" : "root",
	"suffix" : "dc=saymon,dc=info",
	"url" : "ldap://127.0.0.1:389"
}
ldap.loginLDAP administrator login.
ldap.passLDAP administrator password.
ldap.suffixThe root element (as a rule it is the organization's domain name).
ldap.urlLDAP server address.

MQTT

This section contains settings for connection to MQTT broker.

"mqtt" : {
"broker" : "mqtt://username:password@localhost:1883"
}
mqtt.broker

Broker address and port.

By default "mqtt://localhost:1883"

In order to use authentication by username and password it is necessary to specify credentials before the server address.

OpenTSDB

This section contains access parameters to OpenTSDB.
openTsdb.enabled

Recording historical data to OpenTSDB;

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

By default true | recording is enabled.

openTsdb.host

Address of the host with OpenTSDB.

By default "localhost".

openTsdb.port

OpenTSDB port.

By default 4242.

Push_notification

This section contains parameters of push notifications in the mobile application. Firebase Cloud Messaging (FCM) is used for work with push notifications.
push_notification.disabled

It disables the notifications;

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

By default true | notifications are disabled.

push_notification.key_path

Path to SAYMON server autorization key on the Firebase server.

By default "/etc/saymon/saymon-mobile-firebase-adminsdk.json".

push_notification.
on_state_change

It enables sending notifications when state changes, in case of another notification source - MQTT messages;

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

By default true | sending is enabled.

push_notification.timeout

Time after which a notification is sent to each user (in milliseconds).

By default 0 | no delay.

push_notification.url

URL, obtained by user from Firebase, to receive notifications content from the server.

By default "https://saymon-mobile.firebaseio.com".

Server

This section contains general server parameters.
server.analytics_enabled

It involves analytics of the metric values in the data processing;

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

By default false | analytics is disabled.

server.analytics_processes

The amount of logical cores used to process the times series analytics.

By default all available cores are used.

server.colorize_log

It enables colorizing log;

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

By default false | colorizing is disabled.

server.comet_ping_interval

Time interval between sending messages by comet server (in milliseconds).

By default 5000 | 5 seconds.

server.comet_ping_timeout

Waiting time for the message from the comet server (in milliseconds).

By default 12000 | 12 seconds.

server.comet_port

Port for the connection.

By default 8091.

server.comet_secure

It enables SSL connection;

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

By default false | connection is disabled.

server.
comet_ssl_certificate		Path to the sertificate.
server.comet_ssl_keyPath to the key.
server.conditional_
incidents_enabled

It enables incidents functionality;

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

By default false | functionality is disabled.

server.debug

It enables debug mode for logging into the file /var/log/saymon/saymon-server.log;

    • false | debug mode is disabled,
    • true | debug mode is enabled.

By default false | debug mode is disabled.

server.
default_result_timeout

Time after which the condition No data on object is triggered since object creation or obtainig the last data (in milliseconds).

By default 120000 | 2 minutes.

server.default_state_id

Object default state.

By default 7 | "No data".

server.discovery_parent_id

ID of the object to place new network devices, discovered by agents.

By default "1".

server.
event_log_max_bytes

MongoDB console records size at which the data is rotated (in bytes).

By default "1 G" | 1 gigabyte.

server.extension_path

Path to the directory with server extensions.
server.history_temporary_
storage_period

Time period (in milliseconds) during which the data is buffered in Redis and then transferred to OpenTSDB.

This parameter works only if history_update_period is equal to 0.

server.
history_update_period

History data recording period (in milliseconds).

0 - immediate recording incoming values.

By default 60000 | 1 minute.

server.notification_
buffering_period

Time period to hoard all messages about state changes of objects and send grouped notification to the user (in milliseconds).

By default 0 | buffering is disabled.

server.retain_expired_stat

It enables storage of the latest received data after their obsolescence;

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

By default false | storage is disabled.

server.
script_trigger_timeout

The maximum execution time of a trigger (in milliseconds).

By default 30000 | 30 seconds.

server.self_object_idID of an object, used for self-monitoring.
server.sms_scriptPath to a script for sending SMS notifications.
server.sql_history_enabled

It enables recording history data to MySQL;

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

By default false | recording is disabled.

server.stat_local_
timestamp_field_name

Name of the field in which the time with which the data must be saved in OpenTSDB is displayed.

By default "LocalTimestamp".

server.stat_scan_period

Validation period of incoming data expiration (in milliseconds).

By default 3000 | 3 seconds.

server.voice_call_scriptPath to a script for implementing voice calls.

server.email

This subsection contains email-server settings.

"email" : {
	"disabled" : false,
	"fields" : {
		"from" : "saymon@saas.saymon.info"
		},
	"max_json_length": 1000,
	"transport" : {
		"auth" {
			"user" : "saymon@saas.saymon.info",
			"pass" : "P@ssw0rd"
		},
		"host" : "smtp.gmail.com",
	    "port" : 465,
	    "secure" : true
	},
}
server.email.disabled

It disables sending email notifications;

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

By default true | sending is disabled.

server.email.fieldsInformation about the sender.
server.email.fields.fromSender's email address
server.email.
max_json_length

Size limit of notification emails (in symbols).

By default 1000 | 1000 symbols.

server.email.transport
server.email.transport.authUser's credentials.
server.email.transport.auth.passUser's password.
server.email.transport.auth.userUser's login.
server.email.transport.hostMail server address.
server.email.transport.portMail server port.
server.email.transport.
secure

It enables TLS while connection to the serve;

    • false | using TLS is disabled,
    • true | using TLS is enabled.

Default value depends on the port.

server.email.transport.
service

Service kit, embedded in the connector.

When using it sets host, port, secure automatically.

By default "Gmail".

server.user

This subsection contains user settings.

"user" : {
	"auth_enabled": "true",
	"new_user_access": "all",
	"template": {
		"permissions": ["manage-objects", "view-section-stat"],
		"objectPermissions": {
			"include": [],
			"exclude": ["5fb643ddf277b96c8401119b", "5f8dc28407e86603bfe281f8"]
		}
	},
	"usersRoot": "5800d9aaac7bf0f90d3d520e" 
}

server.user.auth_enabled

In enables self-account-creation for users;

    • false | self-account-creation is disabled,
    • true | self-account-creation is enabled.

By default false | self-account-creation is disabled.

server.user.lang_default

User language by default;

    • "en" - English,
    • "it" - Italian,
    • "ru" - Russian.

By default "en" | English.

server.user.
new_user_access

Access rights to objects for a new user;

    • "all" | access to all of the objects,
    • "not" | no access to any object.

By default "all" | access to all of the objects.

server.user.template

New user's rights template.

These parameters are applied only for users, who used self-account-creation.

server.user.template.
objectPermissions		User rights to access to objects.
server.user.template.
objectPermissions.include		A list of objects' IDs to which a newly registered user is given access by default.
server.user.template.
objectPermissions.exclude		A list of objects' IDs to which a newly registered user is denied access by default.

server.user.template.
permissions

A list of permissions given to a newly registered user by default.
server.user.usersRoot

ID of the object used as the root for a newly registered user's new objects.

By default "1".

Resource_server

This section contains parameters bonded with storage files, uploaded to Saymon.
resource_server.debug

It enables debug mode for logging into the file /var/log/saymon/saymon-server.log;

    • false | debug mode is disabled,
    • true | debug mode is enabled.

By default false | debug mode is disabled.

resource_server.
file_storage_dir

Path to the directory for storage documents, added to objects.

By default "/var/saymon/resources".

resource_server.ip_address

Resouce server address.

By default "127.0.0.1".

resource_server.port

Resouce server port.

By default 8092.

Rest_server

This section contains REST server settings.
rest_server.base_url

Path to API.

By default "/api".

rest_server.colorize_log

It enables colorizing log;

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

By default false | colorizing is disabled.

rest_server.debug

It enables debug mode for logging into the file /var/log/saymon/saymon-server.log;

    • false | debug mode is disabled,
    • true | debug mode is enabled.

By default false | debug mode is disabled.

rest_server.
document_download_url

URL to files stored in $document_storage_dir.

By default "http://localhost/node/api/docs".

rest_server.ip_address

Host address to run REST server.

By default "127.0.0.1".

rest_server.num_workers

Number of processes to upload data.

By deafult 1.

rest_server.port

REST server port.

By deafult 8090.

rest_server.public_urlAddress for access to the web interface from notifications.
rest_server.
update_download_url

Path to agent update file.

By deafult "http://localhost/node/api/agents/update".

  • No labels