From bc59eaf3b742c7d04c65e05e92ca7ce08af640fd Mon Sep 17 00:00:00 2001 From: riley206 Date: Mon, 18 Mar 2024 15:28:47 -0700 Subject: [PATCH] updated parameters --- services/ops/LogStatisticsAgent/README.md | 24 +++++++++++------------ 1 file changed, 11 insertions(+), 13 deletions(-) diff --git a/services/ops/LogStatisticsAgent/README.md b/services/ops/LogStatisticsAgent/README.md index b663023012..f444d60d8d 100644 --- a/services/ops/LogStatisticsAgent/README.md +++ b/services/ops/LogStatisticsAgent/README.md @@ -8,23 +8,21 @@ which may be an indication of some sort of failure or breach. ### Configuration -The Log Statistics agent has 4 required configuration values: +The Log Statistics agent has 4 configuration parameters, all of which are required: -- `file_path`: This should be the path to the "volttron.log" file -- `analysis_interval_secs`: The interval in seconds between publishing the size delta statistic to the message bus -- `publish_topic`: Can be used to specify a topic to publish log statistics to which does not get captured by the - historian framework (topics not prefixed by any of: "datalogger", "record", "analysis", "devices") -- `historian_topic`: Can be used to specify a topic to publish log statistics to which gets captured by the - historian framework ("datalogger", "record", "analysis", "devices") - -The following is an example configuration file: +- `file_path`: The file path to the log file. If left as `null`, defaults to `'volttron.log'` located within your VOLTTRON_HOME environment variable. +- `analysis_interval_secs`: The interval in seconds between publishes of the size delta statistic to the message bus. If left as `null`, defaults to 60 seconds. +- `publish_topic`: Used to specify a topic to publish log statistics to which does not get captured by the + historian framework (topics not prefixed by any of: "datalogger", "record", "analysis", "devices"). If left as `null`, defaults to `"platform/log_statistics"`. +- `historian_topic`: Can be used to specify a topic to publish log statistics to which gets captured by the + historian framework ("datalogger", "record", "analysis", "devices"). If left as `null`, defaults to `record/log_statistics`. ```json { - "file_path" : "~/volttron/volttron.log", - "analysis_interval_min" : 60, - "publish_topic" : "platform/log_statistics", - "historian_topic" : "record/log_statistics" + "analysis_interval_sec": 60, + "file_path": null, + "historian_topic": "analysis/log_statistics", + "publish_topic": "platform/log_statistics" } ```