Need ODM SDF Syntax to Cover Event Importance

[gerickson]

In Weave Data Language (WDL), events may be tagged with an importance to help prioritize buffering and retention through various nodes and actors in the network and ecosystem. To be expressed in ODM SDF losslessly, a syntax construct for representing event importance is needed.

Relevant Example Schema Input Files

• weave/trait/power/battery_power_source_trait.proto
• weave/trait/power/power_source_trait.proto
• weave/trait/security/bolt_lock_trait.proto

Missing or Unmapped WDL-to-ODM SDF Syntax

• event_importance
  • This is an enumerated key indicating a qualitative determination of the criticality that a particular event be eventually delivered. It indicates the system or customer impact of losing an event and is therefore used for quality of service (QoS) design considerations. It may be one of the following values:
  • _EVENT_IMPORTANCEUNSPECIFIED
    • Denotes events which have not specified any other criticality.
  • _EVENT_IMPORTANCE_PRODUCTIONCRITICAL
    • Denotes events whose loss would have significant impact on critical customer-facing features or functionality. They are the highest importance/priority and should be used sparingly and with consideration of product constraints like power and memory.
  • _EVENT_IMPORTANCE_PRODUCTIONSTANDARD
    • Denotes events whose loss would have direct impact on customer-facing features or functionality, including loss thereof.
  • _EVENT_IMPORTANCEINFO
    • Denotes events that provide extra insight and diagnostics into the running system, but whose loss would not directly impact customer-facing features or functionality.
  • _EVENT_IMPORTANCEDEBUG
    • Denotes events of interest to the developers of the system whose loss would not directly affect customers or business.

Example Input WDL

message BatteryChangedEvent {
    option (wdl.message_type) = EVENT;

    option (wdl.event) = {
        Id:               1,
        event_importance: EVENT_IMPORTANCE_PRODUCTION_STANDARD,
        extends:          "weave.trait.power.PowerSourceTrait.PowerSourceChangedEvent",
        extendable:       true,
        reserved_tag_min: 16,
        reserved_tag_max: 31
    };

    // SUPER PROPERTIES

    weave.trait.power.PowerSourceTrait.PowerSourceCondition  condition              =  1;
    weave.trait.power.PowerSourceTrait.PowerSourceStatus     status                 =  2;

    // EXTENDED PROPERTIES

    BatteryReplacementIndicator                              replacement_indicator  = 16;
    BatteryRemaining                                         remaining              = 17;
}

Example Output ODM SDF

"odmEvent" : {
    "BatteryChangedEvent" : {
        "odmProperty" : {
            "condition" : {
                "description" : "TBD",
                "name"        : "condition",
                "type"        : {
                    "$ref" : "#/odmData/weave.trait.power.PowerSourceTrait.PowerSourceCondition"
                },
                "id"          : 1,
                "optional"    : false,
                "nullable"    : false
            }
        },
        "odmProperty" : {
            "status" : {
                "description" : "TBD",
                "name"        : "status",
                "type"        : {
                    "$ref" : "#/odmData/weave.trait.power.PowerSourceTrait.PowerSourceStatus"
                },
                "id"          : 2,
                "optional"    : false,
                "nullable"    : false
            }
        },
        "odmProperty" : {
            "replacement_indicator" : {
                "description" : "TBD",
                "name"        : "replacement_indicator",
                "type"        : {
                    "$ref" : "#/odmData/BatteryReplacementIndicator"
                },
                "id"          : 16,
                "optional"    : false,
                "nullable"    : false
            }
        },
        "odmProperty" : {
            "remaining" : {
                "description" : "TBD",
                "name"        : "remaining",
                "type"        : {
                    "$ref" : "#/odmProperty/BatteryRemaining"
                },
                "id"          : 17,
                "optional"    : false,
                "nullable"    : false
            }
        }
    }
}

[mjkoster]

We agreed to add a quality for events to define "severity" or equivalent

[asoloway64]

F2F4: It was decided that this is not a schema issue, but can be handled as part of "ODM Defined Data Types" which is a set of pre-defined values to be used by all data models. These will allow for vendor extensions.

[gerickson]

Is there more context on this resolution / outcome for those not at the F2F4?

/cc/ @mrjerryjohns

[asoloway64]

Please see if the notes at https://iotliaison.org/wg/onedm/wiki/f2f-4-notes sufficiently capture the discussion.