SWIM Supporting Material

Working towards the next version of the SWIM Supporting Material

Page tree

Working towards the next version of the SWIM Supporting Material

Skip to end of metadata
Go to start of metadata


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 

tentative JSON Guidance

Guidance for JSON service descriptions integrated within the SWIM Service Description Handbook.

Schema

The guidance concerns JSON Schema v0.0.3 (see Schema releases).

 Schema excerpt [+]
		"ServiceTechnicalDescription" : 
		{
			"description" : "Description of the technical aspects of the service including data structures, interface and operations behaviour, security mechanisms and technical constraints",
			"type": "object",
			"additionalProperties": false,
			
			"properties":
			{


				"serviceMonitoring":
				{
					"description" : "A service monitoring mechanism available to service consumers. [SWIM-SERV-028]",
					"$ref" : "#/definitions/ServiceMonitoring"
				}


			}
		},
		
		"ServiceMonitoring" : 
		{
			"description" : "Tracking state and operational conditions related to the execution, performance, and real-world effects of services.",
			"type": "object",
			"additionalProperties": false,
			"required": ["monitoringDescription"],
			"properties":
			{
				"monitoringDescription":
				{
					"description" : "Description if available of the existing monitoring capabilities and how this can be used by the consumer. [SWIM-SERV-028].",
					"type" : "string",
					"minLength":1
				}
			}
		}
 Rules [+]

Rules expressed for the cases as defined in Registry URD.

caserules
COMPLIANTConditional Mandatory
CANDIDATEOptional
DEFINITIONOptional

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 


attributetypedescriptionguidancerule
monitoringDescriptionstringDescription 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

A mechanism is made available
		"serviceTechnicalDescription": {

 			"serviceMonitoring": {
				"monitoringDescription": "The service is monitored, however there is no monitoring interface provided to the consumers"
			}

		}
No mechanism is made available
		"serviceTechnicalDescription": {

		}

A complete JSON example is available in page JSON example - Donlon TOBT Setting service description.

  • No labels

Status: Working Material