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
Page Table of Content

Version

This page concerns v2.0 of the Specification. Supporting material on v1.0 is SWIM-SERV-028 Service monitoring

Requirement

Title

Service monitoring

Identifier

SWIM-SERV-230

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

The mechanisms allow the monitoring of the services provided based on e.g.

  • status
  • uptime
  • response times

A heartbeat service can be used to periodically check the status of the service and determine whether it is available.

Service monitoring is explained in the EUROCONTROL Specification for SWIM Technical Infrastructure (TI) Yellow Profile. See SWIM-TIYP-0105 that explains that monitoring ensures a service's "state is known and maintained up to date and that any eventual threshold violations on their use can be identified to be handled in an appropriate manner".

Verification Support

Completeness

Check that:

[  ] The service description includes or refers to information that describe how to use the service monitoring mechanism.

Examples

The following example shows the content as a table.

service monitoring

A heartbeat service is used to periodically check the status of the service and determine whether it is available.



The following example shows an extract of the content of a JSON file that conforms to the Service Metadata Schema

Example of SWIM-SERV-230 using Service Metadata Schema
"technicalDescription": {
 "serviceMonitoring": {
  "monitoringDescription": "A heartbeat service is used to periodically check the status of the service and determine whether it is available."
 }
}

Complete examples are available at Example service description.

  • No labels