Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve clarity in config message documentation page #492

Merged
merged 1 commit into from
Nov 9, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 15 additions & 7 deletions docs/messages/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,20 +17,28 @@ It is composed of specific sub-entries for each sub-system { _system_, _pointset
This [working example](../../tests/config.tests/example.json) shows how a typical `config` message
is constructed.

## Config Message
## Config Parameters

### System
* `min_loglevel`: Indicates the minimum loglevel for reporting log messages below which log entries
should not be sent. See note below for a description of the level value.

### Pointset

* `sample_rate_sec`: Sampling rate for the system, which should proactively send an
update (e.g. _pointset_, _logentry_, _discover_ message) at this interval.
* `sample_limit_sec`: Minimum time between sample updates. Updates that happen faster than this time
(e.g. due to _cov_ events) should be coalesced so that only the most recent update is sent.

#### Point

* `set_value`: Set a value to be used during diagnostics and operational use. Should
override any operational values, but not override alarm conditions.
* `min_loglevel`: Indicates the minimum loglevel for reporting log messages below which log entries
should not be sent. See note below for a description of the level value.

## Config Entries

During a config up sequence, the system should produce the following log/status update entries:
## Config Log Entries

* system.config.update
During a config receive/up sequence, the system should produce the following log/status update entries:
* _system.config.receive_: (**DEBUG**) Receiving a config message
* _system.config.parse_: (**DEBUG**) Parsing a received message
* _system.config.apply_: (**NOTICE**) Application of a parsed config message