|
Operations Guide
|
The MCS configuration file must start with this line:
After that, the '<um-mcs>' element contains the rest of the configuration.
Here is a sample short configuration:
Here is a sample "mcs_transp.cfg" file:
context default_interface "en0" context resolver_unicast_daemon "en0"->10.1.2.3:12000 source transport tcp
This conforms to the Automatic Monitoring Sample.
Here is a sample "my_sqlite.properties" file:
sqlite_database_path=/mcs/ummon.db
When the daemon monitor is enabled, the first three lbm attribute option settings are recommended.
Container element which holds the MCS configuration. Also defines the version of the configuration format used by the file.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| version | Version number of user's configuration file. | nonEmptyString | "1.0" |
Example:
Supplies configuration for the monitoring receiver created by MCS.
Example:
Supplies a UM configuration file for the monitoring receiver created by MCS.
Example:
Sets the monitoring receiver to use a wildcard pattern instead of a simple topic to subscribe to statistics data sent by UM components (applications, daemons, etc). If supplied, MCS Element "<topic>" is ignored.
If not supplied, MCS Element "<topic>" is used.
Example:
The topic that the monitoring receiver will subscribe to get statistics data sent by UM components (applications, daemons, etc).
If not supplied, defaults to "/29west/statistics".
Example:
Configures the connector that MCS should use to write statistics data. A connector is typically an interface to a database.
Example:
Specifies a Java properties file to pass to the connector.
See Monitoring Collector Service (MCS).
Example:
Defines the connector type to use. Supported types are "sqlite" or "hdfs".
If not supplied, "sqlite" is used.
See Monitoring Collector Service (MCS).
Example:
Contains elements which define logging behavior and sets a file name for the service's Process ID.
See child elements for details.
Example:
Supplies the desired name of file in which the MCS writes its Process ID (PID).
Example: (MCS writes process ID to "mcs_pid.txt" file)
Configures MCS logging behavior. The value contained within the <log>...</log> is a file name, but is only used if the "type" attribute is set to "file".
When the type attribute is set to "file", the MCS supports "rolling" the log file, which consists a series of files over time so that no one file grows too large.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| type | Where to write log messages. | "file" - Write log messages to a file. "console" - Write log messages to standard output. | "console" |
| frequency | Time-frame by which to roll the log file. | "disable" - Do not roll the log file based on time. "daily" - Roll the log file at midnight. "hourly" - Roll the log file each hour. | "disable" |
| size | Size (in MB, i.e. 2**20, or 1,048,576) of current log file at which it is rolled. Specify 0 to disable rolling by log file size. | positiveInteger | "10" (10,485,760 bytes) |
| max-history | Number of rolled log files at which the oldest file is deleted when the current log file is rolled. | positiveInteger | "10" |
| compression | Enables compression for rolled log files. | "none" - Do not compress log files. "zip" - Compress log files using "zip" format. "gzip" - Compress log files using "gzip" format. | "none" |
Example 1: (write log messages to standard out)
Example 2: (write log messages to "mcs.log" file)