UDMI / Docs / Specs / Categories
Categories are assembled in a hierarchical fashion to represent the intended level
of detail (more specific is better). E.g. a complete system config parsing message
would be categorized as system.config.parse, while a system config entry of
unspecified category would be just system.config. Defined categories come with
implicit expected level values, indicated by '(LEVEL)' in the hierarchy below,
this is not to say it's the only level allowed for that category, but rather
that is the expected normal value for that category. E.g., pointset.point.nominal
could be used with a WARNING level for a warning case during normal operation.
- system: Basic system operation
- base: Baseline system operational messages
- start: (NOTICE) System is in the process of (re)starting and essentially offline
- shutdown: (NOTICE) System is shutting down
- ready: (NOTICE) System is fully ready for operation
- comms: Baseline message handling
- config: Configuration message handling
- receive: (DEBUG) Receiving a config message
- parse: (DEBUG) Parsing a received message
- apply: (NOTICE) Application of a parsed config message
- auth: Authentication to local application (e.g. web server, SSH)
- login: (NOTICE) Successful login. The entry message should include the username and application
- logout: (NOTICE) Successful logout
- fail: (WARNING) Failed authentication attempt. The entry message should include the application
- base: Baseline system operational messages
- pointset: Handling managing data point conditions
- point: Conditions relating to a specific point, the entry
messageshould start with "Point pointname"- nominal: (INFO) Category for normal operating state (also default).
- applied: (INFO) The
set_valuefor a point has been applied - updating: (NOTICE) The point is in the process of updating
- overridden: (WARNING) The reported value has been overridden locally
- failure: (ERROR) The system failed to read/write the point
- invalid: (ERROR) A
configparameter for the point is invalid in some way
- point: Conditions relating to a specific point, the entry
- localnet: Aspects of working with various local networks
- network: (INFO) Aspects of a specific network
- connect: (NOTICE) Connected status of the device on
- network: (INFO) Aspects of a specific network
- gateway: Aspects of managing gateway connections
- setup: Relating to initial device setup, reported in the gateway.status field
- attach: (ERROR) Expected status for attachment failures between gateway and cloud
- proxy: Relating to proxied devices, reported as part of the proxied device state
- target: (WARNING) Basic target block specification, missing (warning) or unprocessable (error)
- connect: (ERROR) Fieldbus connection between gateway and proxied device (error on failure)
- setup: Relating to initial device setup, reported in the gateway.status field
- discovery: Handling on-prem discovery flow
- family: Conditions specific to an entire address family (e.g. bacnet)
- scan: (INFO) Relating to scanning a particular address family
- device: Conditions specific to device scanning
- enumerate: (INFO) Handling point enumeration for a given device
- point: Conditions specific to point enumeration
- describe: (INFO) Relating to describing a particular point
- family: Conditions specific to an entire address family (e.g. bacnet)
- mapping: Mapping processing for devices
- device: Relating to a specific individual device
- apply: (INFO) Stage of applying a device mapping
- device: Relating to a specific individual device
- blobset: Handling update of device data blobs
- blob: Conditions specific to an individual blob
- receive: (DEBUG) About receiving a blob update
- fetch: (DEBUG) Fetching a blob update
- apply: (NOTICE) Applying a blob update
- blob: Conditions specific to an individual blob
- validation: Handling validation pipeline messages
- device: Conditions specific to processing a given device message.
- receive: (DEBUG) Receiving/processing a message for validation.
- schema: (INFO) Basic schema and structure validation.
- content: (INFO) Errors validating semantic content of the message.
- multiple: (INFO) Multiple issues reported.
- extra: (INFO) Device was unexpected (not in site model).
- summary: Conditions specific to an overall site summary.
- report: (INFO) The validation summary report.
- feature: Results of feature sequence testing.
- sequence: (INFO) An individual line-item sequence test.
- schema: (INFO) Feature message schema validations.
- capability: (INFO) Sequence test capability.
- device: Conditions specific to processing a given device message.
- device: Device specific messages (ignored by UDMI system)
- ???: (INFO) Special wildcard category, anything prefixed by 'device.' lands here!