X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=doc%2FMON_usage_guide.rst;h=89f75faa41f77d87c89f3ee707c2d3bdc81b4124;hb=9604945f57dbff85cf7948b475d6e86a0e5a2c90;hp=0a28318551fa39a6e69b49f3881ba23d97b851a6;hpb=375f07c018e209ae54391d4d0cb4898d4bdb79b4;p=osm%2FMON.git diff --git a/doc/MON_usage_guide.rst b/doc/MON_usage_guide.rst index 0a28318..89f75fa 100644 --- a/doc/MON_usage_guide.rst +++ b/doc/MON_usage_guide.rst @@ -32,12 +32,6 @@ The topics that the plugins will consume messages based on are: * alarm_request * metric_request -In return the plugins will send messages back to the SO with the following -topics: - -* alarm_response -* metric_response - Each type of request has it's own unique key: * create_alarm_request * create_metric_request @@ -50,11 +44,35 @@ Each type of request has it's own unique key: * acknowledge_alarm_request * read_metric_data_request -Sending Messages ----------------- +In return the plugins will send messages back to the SO with the following +topics: + +* alarm_response +* metric_response + +Each request has a corresponding response key: +* create_alarm_reponse +* create_metric_response +* list_alarm_response +* list_metric_response +* delete_alarm_response +* delete_metric_response +* update_alarm_response +* update_metric_response +* acknowledge_alarm_response +* read_metric_data_response + + .. note:: + + There is an additional response key to send notifications to the SO + when an alarm has been triggered: + * notify_alarm + +Sending Request Messages +------------------------ For each of the request message that can be sent there is a json schema defined in the models directory of the MON repo: -: `` +: `` To send a valid message to the MON module for use by one of the plugins, your message must match the json schema for that request type.