hmon: Define configuration schema #340
+305
−0
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| // ******************************************************************************** | ||
| // Copyright (c) 2026 Contributors to the Eclipse Foundation | ||
| // | ||
| // See the NOTICE file(s) distributed with this work for additional | ||
| // information regarding copyright ownership. | ||
| // | ||
| // This program and the accompanying materials are made available under the | ||
| // terms of the Apache License Version 2.0 which is available at | ||
| // https://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| // ******************************************************************************** | ||
|
|
||
| namespace score.mw.health.config; | ||
|
|
||
| file_identifier "HMCF"; | ||
| file_extension "bin"; | ||
|
|
||
| /// Scheduler policy for the monitoring thread. | ||
| enum SchedulerPolicy : byte { | ||
| Other = 0, | ||
| Fifo = 1, | ||
| RoundRobin = 2 | ||
| } | ||
|
|
||
| /// Thread parameters for the monitoring thread. | ||
| table ThreadParameters { | ||
|
eduard-moskalchuk marked this conversation as resolved.
|
||
| policy: SchedulerPolicy = null; | ||
| priority: int32 = null; | ||
| affinity: [uint32]; | ||
| stack_size: uint32 = null; | ||
| } | ||
|
|
||
| /// A time range with minimum and maximum durations in milliseconds. | ||
| table TimeRange { | ||
| min_ms: uint32; | ||
| max_ms: uint32; | ||
| } | ||
|
|
||
| /// A single deadline entry within a deadline monitor. | ||
| table DeadlineEntry { | ||
| deadline_tag: string (required); | ||
| range: TimeRange (required); | ||
| } | ||
|
|
||
| /// Configuration for a deadline monitor. | ||
| table DeadlineMonitor { | ||
| monitor_tag: string (required); | ||
| deadlines: [DeadlineEntry] (required); | ||
| } | ||
|
|
||
| /// Configuration for a heartbeat monitor. | ||
| table HeartbeatMonitor { | ||
| monitor_tag: string (required); | ||
| range: TimeRange (required); | ||
| } | ||
|
|
||
| /// A state and its allowed transitions in a logic monitor. | ||
| table StateNode { | ||
| state: string (required); | ||
| allowed_transitions: [string] (required); | ||
| } | ||
|
|
||
| /// Configuration for a logic monitor. | ||
| table LogicMonitor { | ||
| monitor_tag: string (required); | ||
| initial_state: string (required); | ||
| states: [StateNode] (required); | ||
| } | ||
|
|
||
| /// Root configuration for a HealthMonitor instance. | ||
| table HealthMonitorConfig { | ||
| schema_version: uint32 = null; | ||
|
Contributor
There was a problem hiding this comment. Is the schema version really optional? |
||
| supervisor_api_cycle_ms: uint32; | ||
| internal_processing_cycle_ms: uint32; | ||
|
Contributor
There was a problem hiding this comment. Are supervisor_api_cycle_ms and internal_processing_cycle_ms optional values? |
||
| thread_parameters: ThreadParameters; | ||
| deadline_monitors: [DeadlineMonitor]; | ||
| heartbeat_monitors: [HeartbeatMonitor]; | ||
| logic_monitors: [LogicMonitor]; | ||
| } | ||
|
|
||
| root_type HealthMonitorConfig; | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,223 @@ | ||||||
| { | ||||||
| "$schema": "https://json-schema.org/draft/2020-12/schema", | ||||||
| "$id": "health_monitor_config.schema.json", | ||||||
| "title": "HealthMonitorConfig", | ||||||
| "description": "Configuration schema for HealthMonitor (compatible with health_monitor_config.fbs)", | ||||||
| "type": "object", | ||||||
| "required": [ | ||||||
| "schema_version", | ||||||
| "supervisor_api_cycle_ms", | ||||||
| "internal_processing_cycle_ms" | ||||||
| ], | ||||||
| "properties": { | ||||||
| "schema_version": { | ||||||
| "type": "integer", | ||||||
| "description": "Schema version", | ||||||
| "enum": [ | ||||||
| 1 | ||||||
| ] | ||||||
| }, | ||||||
|
eduard-moskalchuk marked this conversation as resolved.
|
||||||
| "supervisor_api_cycle_ms": { | ||||||
| "type": "integer", | ||||||
| "minimum": 1, | ||||||
| "description": "Cycle duration in ms for supervisor API notifications" | ||||||
| }, | ||||||
|
Comment on lines
+20
to
+24
Contributor
There was a problem hiding this comment. LM is using seconds as the measurement unit of time (e.g., '0.5' for 500 milliseconds). I would be tempted to suggest that we should use the same approach for health monitoring. This way integrator will be not restricted with precision they would like to use. Encoding precision in parameter name will force configuration change, when we would allow different precision. Additionally it may be useful to define time as a reusable type. This type can be then used by supervisor_api_cycle, internal_processing_cycle and TimeRange
Contributor
Author
There was a problem hiding this comment. If we use floating point numbers, we may have to prove that we do it in a safe way. An activity that can be avoided. Please see the issue #345 |
||||||
| "internal_processing_cycle_ms": { | ||||||
| "type": "integer", | ||||||
| "minimum": 1, | ||||||
| "description": "Cycle duration in ms for internal deadline checks" | ||||||
| }, | ||||||
| "thread_parameters": { | ||||||
| "$ref": "#/definitions/ThreadParameters" | ||||||
| }, | ||||||
| "deadline_monitors": { | ||||||
| "type": "array", | ||||||
| "items": { | ||||||
| "$ref": "#/definitions/DeadlineMonitor" | ||||||
| }, | ||||||
| "description": "List of deadline monitors" | ||||||
| }, | ||||||
| "heartbeat_monitors": { | ||||||
| "type": "array", | ||||||
| "items": { | ||||||
| "$ref": "#/definitions/HeartbeatMonitor" | ||||||
| }, | ||||||
| "description": "List of heartbeat monitors" | ||||||
| }, | ||||||
| "logic_monitors": { | ||||||
| "type": "array", | ||||||
| "items": { | ||||||
| "$ref": "#/definitions/LogicMonitor" | ||||||
| }, | ||||||
| "description": "List of logic monitors" | ||||||
| } | ||||||
| }, | ||||||
| "additionalProperties": false, | ||||||
| "definitions": { | ||||||
|
Contributor
There was a problem hiding this comment.
Suggested change
In 2020-12 schema, the recommended location for reusable schema fragments is |
||||||
| "SchedulerPolicy": { | ||||||
| "type": "string", | ||||||
| "enum": [ | ||||||
| "POSIX_OTHER", | ||||||
| "POSIX_FIFO", | ||||||
| "POSIX_RR" | ||||||
| ], | ||||||
| "description": "Scheduler policy for the monitoring thread" | ||||||
| }, | ||||||
|
eduard-moskalchuk marked this conversation as resolved.
|
||||||
| "ThreadParameters": { | ||||||
| "type": "object", | ||||||
| "properties": { | ||||||
| "policy": { | ||||||
| "$ref": "#/definitions/SchedulerPolicy", | ||||||
| "description": "Scheduler policy for the monitoring thread" | ||||||
| }, | ||||||
| "priority": { | ||||||
| "type": "integer", | ||||||
| "description": "Thread priority" | ||||||
| }, | ||||||
| "affinity": { | ||||||
| "type": "array", | ||||||
| "items": { | ||||||
| "type": "integer", | ||||||
| "minimum": 0 | ||||||
| }, | ||||||
| "description": "CPU core IDs the thread can run on" | ||||||
| }, | ||||||
| "stack_size": { | ||||||
|
Contributor
There was a problem hiding this comment. Should we put the unit into the name, as we did with the timing values (_ms)? |
||||||
| "type": "integer", | ||||||
| "minimum": 0, | ||||||
| "description": "Stack size in bytes" | ||||||
| } | ||||||
| }, | ||||||
| "additionalProperties": false | ||||||
| }, | ||||||
| "TimeRange": { | ||||||
| "type": "object", | ||||||
| "required": [ | ||||||
| "min_ms", | ||||||
| "max_ms" | ||||||
| ], | ||||||
| "properties": { | ||||||
| "min_ms": { | ||||||
| "type": "integer", | ||||||
| "minimum": 0, | ||||||
| "description": "Minimum duration in milliseconds" | ||||||
| }, | ||||||
| "max_ms": { | ||||||
| "type": "integer", | ||||||
| "minimum": 0, | ||||||
| "description": "Maximum duration in milliseconds" | ||||||
| } | ||||||
| }, | ||||||
| "additionalProperties": false | ||||||
| }, | ||||||
| "DeadlineEntry": { | ||||||
| "type": "object", | ||||||
| "required": [ | ||||||
| "deadline_tag", | ||||||
| "range" | ||||||
| ], | ||||||
| "properties": { | ||||||
| "deadline_tag": { | ||||||
| "type": "string", | ||||||
| "minLength": 1, | ||||||
| "description": "Unique identifier for the deadline" | ||||||
| }, | ||||||
| "range": { | ||||||
| "$ref": "#/definitions/TimeRange" | ||||||
| } | ||||||
| }, | ||||||
| "additionalProperties": false | ||||||
| }, | ||||||
| "DeadlineMonitor": { | ||||||
| "type": "object", | ||||||
| "required": [ | ||||||
| "monitor_tag", | ||||||
| "deadlines" | ||||||
| ], | ||||||
| "properties": { | ||||||
| "monitor_tag": { | ||||||
| "type": "string", | ||||||
| "minLength": 1, | ||||||
| "description": "Unique identifier for the deadline monitor" | ||||||
| }, | ||||||
| "deadlines": { | ||||||
| "type": "array", | ||||||
| "items": { | ||||||
| "$ref": "#/definitions/DeadlineEntry" | ||||||
| }, | ||||||
| "minItems": 1 | ||||||
| } | ||||||
| }, | ||||||
| "additionalProperties": false | ||||||
| }, | ||||||
| "HeartbeatMonitor": { | ||||||
| "type": "object", | ||||||
| "required": [ | ||||||
| "monitor_tag", | ||||||
| "range" | ||||||
| ], | ||||||
| "properties": { | ||||||
| "monitor_tag": { | ||||||
| "type": "string", | ||||||
| "minLength": 1, | ||||||
| "description": "Unique identifier for the heartbeat monitor" | ||||||
| }, | ||||||
| "range": { | ||||||
| "$ref": "#/definitions/TimeRange" | ||||||
| } | ||||||
| }, | ||||||
| "additionalProperties": false | ||||||
| }, | ||||||
| "StateNode": { | ||||||
| "type": "object", | ||||||
| "required": [ | ||||||
| "state", | ||||||
| "allowed_transitions" | ||||||
| ], | ||||||
| "properties": { | ||||||
| "state": { | ||||||
| "type": "string", | ||||||
| "minLength": 1, | ||||||
| "description": "State identifier" | ||||||
| }, | ||||||
| "allowed_transitions": { | ||||||
| "type": "array", | ||||||
| "items": { | ||||||
| "type": "string", | ||||||
| "minLength": 1 | ||||||
| }, | ||||||
| "description": "List of states reachable from this state" | ||||||
| } | ||||||
| }, | ||||||
| "additionalProperties": false | ||||||
| }, | ||||||
| "LogicMonitor": { | ||||||
| "type": "object", | ||||||
| "required": [ | ||||||
| "monitor_tag", | ||||||
| "initial_state", | ||||||
| "states" | ||||||
| ], | ||||||
| "properties": { | ||||||
| "monitor_tag": { | ||||||
| "type": "string", | ||||||
| "minLength": 1, | ||||||
| "description": "Unique identifier for the logic monitor" | ||||||
| }, | ||||||
| "initial_state": { | ||||||
| "type": "string", | ||||||
| "minLength": 1, | ||||||
| "description": "Starting state of the logic monitor" | ||||||
| }, | ||||||
| "states": { | ||||||
| "type": "array", | ||||||
| "items": { | ||||||
| "$ref": "#/definitions/StateNode" | ||||||
| }, | ||||||
| "minItems": 1 | ||||||
| } | ||||||
| }, | ||||||
| "additionalProperties": false | ||||||
| } | ||||||
| } | ||||||
| } | ||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does this need to be adapted as well to the new names POSIX_OTHER?
I assume you want to directly compile the json to flatbuffer without any conversion script