Working towards the next version of the SWIM Supporting Material
Working towards the next version of the SWIM Supporting Material
Requirement
Title | Service monitoring |
Identifier | SWIM-SERV-028 |
Requirement | If a service monitoring mechanism is available to service consumers, a service description shall describe how to use the service monitoring mechanism. |
Rationale | Allow the service consumer to use the available mechanism and monitor the service. |
Verification | Completeness: If a service monitoring mechanism is available, verify that the information is included. Consistency: Not Applicable. Correctness: Not Applicable. |
Examples/Notes | Examples: Monitoring the availability of the service (e.g. by heartbeat); monitoring response time. |
Level of Implementation | Mandatory Conditional |
Guidance
No guidance provided.
Guidance for JSON service description
Schema
The guidance concerns JSON Schema v0.0.3 (see Schema releases).
Guidance
When such a mechanism is made available to consumers, it is mandatory to describe it.
Rationale: Allow the service consumer to use the available mechanism and monitor the service.
Case 1 - A mechanism is made available
Within field serviceMonitoring, itself within field serviceTechnicalDescription, provide the following attribute
attribute | type | description | guidance | rule |
---|---|---|---|---|
monitoringDescription | string | Description if available of the existing monitoring capabilities and how this can be used by the consumer. | Describe the monitoring mechanism so that the it can be used by the consumer. | Mandatory |
Case 2 - No mechanism is made available
Nothing needs to be described.
Example
"serviceTechnicalDescription": { "serviceMonitoring": { "monitoringDescription": "The service is monitored, however there is no monitoring interface provided to the consumers" } }
"serviceTechnicalDescription": { }
A complete JSON example is available in page JSON example - Donlon TOBT Setting service description.