Difference between revisions of "PROC07 Adding new probes to ARGO"
(32 intermediate revisions by 2 users not shown) | |||
Line 2: | Line 2: | ||
{{Template:Doc_menubar}} | {{Template:Doc_menubar}} | ||
[[Category:Operations Procedures]] | [[Category:Operations Procedures]] | ||
[[Category:Deprecated]] | |||
{| style="border:1px solid black; background-color:lightgrey; color: black; padding:5px; font-size:140%; width: 90%; margin: auto;" | |||
| style="padding-right: 15px; padding-left: 15px;" | | |||
|[[File:Alert.png]] This page is Deprecated; the content has been moved to https://confluence.egi.eu/display/EGIPP/PROC07+Adding+new+probes+to+ARGO | |||
|} | |||
{{TOC_right}} | {{TOC_right}} | ||
{{Ops_procedures | {{Ops_procedures | ||
|Doc_title = Adding new probes to | |Doc_title = Adding new probes to ARGO | ||
|Doc_link = [[PROC07|https://wiki.egi.eu/wiki/PROC07]] | |Doc_link = [[PROC07|https://wiki.egi.eu/wiki/PROC07]] | ||
|Version = | |Version = 2021-01-27 | ||
|Policy_acronym = OMB | |Policy_acronym = OMB | ||
|Policy_name = Operations Management Board | |Policy_name = Operations Management Board | ||
|Contact_group = operations@egi.eu | |Contact_group = operations@egi.eu | ||
|Doc_status = Approved | |Doc_status = Approved | ||
|Approval_date = | |Approval_date = 2020-02-20 | ||
|Procedure_statement = This document specifies the procedure for adding new probes to the ARGO | |Procedure_statement = This document specifies the procedure for adding new probes to the ARGO Monitoring service | ||
|Owner = Alessandro Paolini | |Owner = Alessandro Paolini | ||
}} | }} | ||
Line 20: | Line 25: | ||
= Overview = | = Overview = | ||
The purpose of this document is to clearly describe the procedure for adding new [[ARGO#ARGO_tests|Nagios probes]] to the ARGO | The purpose of this document is to clearly describe the procedure for adding new [[ARGO#ARGO_tests|Nagios probes]] to the ARGO release. | ||
= Definitions = | = Definitions = | ||
Line 31: | Line 36: | ||
*'''Metric''': Metric instances are tuples of flavour, metric name and optionally FQAN. Metric is a synonym for tests used in the development documentation. In operations document "test" is the reference term to be used. | *'''Metric''': Metric instances are tuples of flavour, metric name and optionally FQAN. Metric is a synonym for tests used in the development documentation. In operations document "test" is the reference term to be used. | ||
*'''Probe''': a code which implements single or multiple tests. | *'''Probe''': a code which implements single or multiple tests. | ||
= Guidelines for monitoring probes = | |||
The following document describes the policy to develop, package and integrate new probes into the ARGO Monitoring Engine: | |||
* http://argoeu.github.io/monitoring-probes/v1/guidelines_for_monitoring_probes/ | |||
= Scope = | = Scope = | ||
This procedure only applies to probes which are run under OPS VO and whose scope is ''global''. The implication of this is that any change requested through this procedure has an impact on all EGI Operations Centres in EGI. | This procedure only applies to probes which are run under OPS VO and whose scope is ''global''. The implication of this is: that any change requested through this procedure has an impact on all EGI Operations Centres in EGI. | ||
This procedure does not apply to SAM internal probes which perform monitoring of individual components on the ARGO | This procedure does not apply to SAM internal probes which perform monitoring of individual components on the ARGO instance (e.g. process monitoring, ActiveMQ connections, etc.). | ||
= Entities involved in the procedure = | = Entities involved in the procedure = | ||
Line 41: | Line 50: | ||
* '''Applicant'''. The Applicant submits a request for adding a new probe. Anyone in the operations community - Resource Centre administrators, Operations Centre staff, Resource Infrastructure Operations Managers - is allowed to submit such a request. The Applicant is responsible for the development and maintenance of the proposed Nagios probe. The Nagios probe use case needs to be well documented. | * '''Applicant'''. The Applicant submits a request for adding a new probe. Anyone in the operations community - Resource Centre administrators, Operations Centre staff, Resource Infrastructure Operations Managers - is allowed to submit such a request. The Applicant is responsible for the development and maintenance of the proposed Nagios probe. The Nagios probe use case needs to be well documented. | ||
* '''COO'''. COO is OMB meeting chair, responsible of processing the request and of accepting/refusing it with the consensus of the Resource Infrastructure Providers. | * '''COO'''. COO is OMB meeting chair, responsible of processing the request and of accepting/refusing it with the consensus of the Resource Infrastructure Providers. | ||
* '''ARGO | * '''ARGO Product Team'''. The ARGO Product Team is responsible of scheduling, integrating and releasing the accepted probes. | ||
= Steps= | = Steps = | ||
{| class="wikitable" | {| class="wikitable" | ||
! Step | |- | ||
! Action on | ! Step | ||
! Action on | |||
! Action | ! Action | ||
|- | |- | ||
| 1 | | 1 | ||
| Applicant | | Applicant | ||
| A request is submitted through a EGI GGUS ticket (https:/ggus.eu) by assigning to Operations SU. | | A request is submitted through a EGI GGUS ticket (https:/ggus.eu) by assigning to Operations SU. <pre>Subject: Request for adding new probe XXX to ARGO-SAM | ||
<pre> | |||
Subject: Request for adding new probe XXX to ARGO-SAM | |||
We would like to request adding new probe XXX to ARGO-SAM release | We would like to request adding new probe XXX to ARGO-SAM release | ||
Line 67: | Line 75: | ||
</pre> | </pre> | ||
|- | |- | ||
| 2 | | 2 | ||
| COO | | COO / Operations | ||
| Reviews the requirement submitted, and schedules a presentation of the new probe at the next possible OMB meeting. | | | ||
Reviews the requirement submitted, sends an email to NGI Managers to make them aware of the request, and: | |||
*if it is a completely new probe for monitoring a new technology, also schedules a presentation of the new probe at the next possible OMB meeting, with the Applicant as speaker. | |||
*if it is a new version of an existing probe, go to step 5.<br> | |||
|- | |- | ||
| 3 | | 3 | ||
| Applicant | | Applicant | ||
| Presents the new probe. | | Presents the new probe. | ||
|- | |- | ||
| 4 | | 4 | ||
| OMB | | OMB | ||
| OMB decides if the new probe will be included in | | OMB decides if the new probe will be included in ARGO. The next steps are performed only if the probe is accepted. | ||
|- | |- | ||
| 5 | | 5 | ||
| | | COO / Operations | ||
| | | Reassigns the ticket to "Monitoring (ARGO)" in order to deploy the probe on the test instance | ||
|- | |- | ||
| 6 | | 6 | ||
| | | ARGO Product Team | ||
| | | | ||
|- | |||
| 7 | Deploys the new probe on the test instance and reports back to Operations any issues and the outcomes of the test | ||
| ARGO | |||
| | |- | ||
| 7 | |||
| ARGO Product Team | |||
| | |||
Agree with Operations when deploying the new probe on the production instance, with its inclusion in the [https://poem.egi.eu/ui/metricprofiles/ARGO_MON ARGO_MON] profile. | |||
|- | |- | ||
| 8 | | 8 | ||
| | | ARGO Product Team / Operations | ||
| Closes the initial GGUS ticket | | Closes the initial GGUS ticket after the release of the probes | ||
|} | |} | ||
Line 130: | Line 148: | ||
| Alessandro Paolini | | Alessandro Paolini | ||
| 2019-12-17 | | 2019-12-17 | ||
| | | updated the procedure to reflect the fact that there is a testing instance of ARGO suitable to test the integration of either new probes or simply new version of existing probes, before the deployment in production; replaced the old name "SAM" with "ARGO" | ||
|- | |||
| | |||
| Alessandro Paolini | |||
| 2021-01-27 | |||
| added the section about the guidelines for the monitoring probes | |||
|} | |} |
Revision as of 14:56, 4 August 2021
Main | EGI.eu operations services | Support | Documentation | Tools | Activities | Performance | Technology | Catch-all Services | Resource Allocation | Security |
Documentation menu: | Home • | Manuals • | Procedures • | Training • | Other • | Contact ► | For: | VO managers • | Administrators |
This page is Deprecated; the content has been moved to https://confluence.egi.eu/display/EGIPP/PROC07+Adding+new+probes+to+ARGO |
Title | Adding new probes to ARGO |
Document link | https://wiki.egi.eu/wiki/PROC07 |
Last modified | 2021-01-27 |
Policy Group Acronym | OMB |
Policy Group Name | Operations Management Board |
Contact Group | operations@egi.eu |
Document Status | Approved |
Approved Date | 2020-02-20 |
Procedure Statement | This document specifies the procedure for adding new probes to the ARGO Monitoring service |
Owner | Alessandro Paolini |
Overview
The purpose of this document is to clearly describe the procedure for adding new Nagios probes to the ARGO release.
Definitions
Please refer to the EGI Glossary for the definitions of the terms used in this procedure.
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", “MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.
The key words Metric, Probe are defined in the following way:
- Metric: Metric instances are tuples of flavour, metric name and optionally FQAN. Metric is a synonym for tests used in the development documentation. In operations document "test" is the reference term to be used.
- Probe: a code which implements single or multiple tests.
Guidelines for monitoring probes
The following document describes the policy to develop, package and integrate new probes into the ARGO Monitoring Engine:
Scope
This procedure only applies to probes which are run under OPS VO and whose scope is global. The implication of this is: that any change requested through this procedure has an impact on all EGI Operations Centres in EGI.
This procedure does not apply to SAM internal probes which perform monitoring of individual components on the ARGO instance (e.g. process monitoring, ActiveMQ connections, etc.).
Entities involved in the procedure
- Applicant. The Applicant submits a request for adding a new probe. Anyone in the operations community - Resource Centre administrators, Operations Centre staff, Resource Infrastructure Operations Managers - is allowed to submit such a request. The Applicant is responsible for the development and maintenance of the proposed Nagios probe. The Nagios probe use case needs to be well documented.
- COO. COO is OMB meeting chair, responsible of processing the request and of accepting/refusing it with the consensus of the Resource Infrastructure Providers.
- ARGO Product Team. The ARGO Product Team is responsible of scheduling, integrating and releasing the accepted probes.
Steps
Step | Action on | Action |
---|---|---|
1 | Applicant | A request is submitted through a EGI GGUS ticket (https:/ggus.eu) by assigning to Operations SU. Subject: Request for adding new probe XXX to ARGO-SAM We would like to request adding new probe XXX to ARGO-SAM release Prerequisite data: * name of the Nagios probe: * name of service on which the test runs: * link to documentation page: * motivation (which part of the infrastructure will be improved with the new probe or description of users' problems which will be avoided in future - provide list of GGUS tickets is possible) |
2 | COO / Operations |
Reviews the requirement submitted, sends an email to NGI Managers to make them aware of the request, and:
|
3 | Applicant | Presents the new probe. |
4 | OMB | OMB decides if the new probe will be included in ARGO. The next steps are performed only if the probe is accepted. |
5 | COO / Operations | Reassigns the ticket to "Monitoring (ARGO)" in order to deploy the probe on the test instance |
6 | ARGO Product Team |
Deploys the new probe on the test instance and reports back to Operations any issues and the outcomes of the test |
7 | ARGO Product Team |
Agree with Operations when deploying the new probe on the production instance, with its inclusion in the ARGO_MON profile. |
8 | ARGO Product Team / Operations | Closes the initial GGUS ticket after the release of the probes |
Revision History
Version | Authors | Date | Comments |
---|---|---|---|
M. Krakowian | 2014-08-19 | Changed contact group -> Operations support | |
C. Aiftimiei | 2014-09-18 | Removed broken link "detailed description" on Step 6 | |
Alessandro Paolini | 2016-06-08 | Changed contact group -> Operations | |
Alessandro Paolini | 2017-06-01 | Changed the name SAM to ARGO-SAM | |
Alessandro Paolini | 2018-06-19 | Definitions: Metric and Probed as defined in the deprecated terminology page (link removed). Overview: updated the link to ARGO/SAM wiki page | |
Alessandro Paolini | 2019-12-17 | updated the procedure to reflect the fact that there is a testing instance of ARGO suitable to test the integration of either new probes or simply new version of existing probes, before the deployment in production; replaced the old name "SAM" with "ARGO" | |
Alessandro Paolini | 2021-01-27 | added the section about the guidelines for the monitoring probes |