Monitoring Tools Interface Specification (draft)

This is only a draft. Please don't assume that any of the URLs presented below are the final ones!

SAM data exports

SAM provides several pointers to retrieve information from the DB through the Oracle XDK web service. These pointers (or URLs) are described below, where we assume:
<baseURI> := http://<sam_host>/<path>

History of selected service metrics

Description:

This interface is used to retrieve the history (timestamp and status) of service metrics executed in a particular service during a period of time and calculated for one or more VOs.

Request URL:

<baseURI>/metric_history.xsql?service_name=castorsrm.cern.ch&calculatedFor_vo_name=OPS&serviceMetric_name=SE-lcg-cp&startTime=2007-02-28T00:00:00Z&endTime=2007-02-28T00:04:00Z
Description of the parameters:
  • service_name - Selected value for service.name.
  • calculatedFor_vo_name - vo name for which history of service metrics should be calculated. This param may appear more than once.
  • serviceMetric_name - service metric name to display in history. This param may appear more than once.
  • startTime - starting time in W3C date and time format (YYYY-MM-DDThh:mm:ssZ)
  • endTime - ending time in W3C date and time format (YYYY-MM-DDThh:mm:ssZ)

Response URL:

<?xml version="1.0"?>
<ROOT>
  <SERVICES>
    <SERVICE name="castorsrm.cern.ch" type="SE">
      <VO name="OPS" role="calculatedFor">
        <CURRENT_STATUS>ok</CURRENT_STATUS>
        <TEST name="SE-lcg-cp">
          <TIMESTAMP>2007-02-28T00:51:01Z</TIMESTAMP>
          <STATUS>ok</STATUS>
        </TEST>
        <TEST name="SE-lcg-cp">
          <TIMESTAMP>2007-02-28T01:53:14Z</TIMESTAMP>
          <STATUS>ok</STATUS>
        </TEST>
        <TEST name="SE-lcg-cp">
          <TIMESTAMP>2007-02-28T02:52:48Z</TIMESTAMP>
          <STATUS>ok</STATUS>
        </TEST>
        <TEST name="SE-lcg-cp">
          <TIMESTAMP>2007-02-28T03:57:33Z</TIMESTAMP>
          <STATUS>ok</STATUS>
        </TEST>
      </VO>
    </SERVICE>
  </SERVICES>
</ROOT>

Current status of a service displaying all critical tests for a VO

Description: This interface is used to retrieve the current status of one or more services together with the critical tests defined for a particular VO.

* Request URL:*

<baseURI>/current_status.xsql?service_name=castorsrm.cern.ch&criticalFor_vo_name=OPS&calculatedFor_vo_name=Atlas&showStatus
Description of the parameters:
  • service_name - the services for which current status has to be calculated. This param may appear more than once.
  • criticalFor_vo_name - vo name for which tests service metrics are critical. This param may appear more than once.
  • calculatedFor_vo_name - vo name for which service metric status will be displayed. This param may appear more than once.
  • showStatus - optional parameter. If present, the result will include the current status of each service type per vo.

Response URL:

<?xml version="1.0"?>
<ROOT>
  <SERVICES>
    <SERVICE name="castorsrm.cern.ch" type="SE">
      <VO name="Atlas" role="calculatedFor">
        <STATUS>ok</STATUS>
        <TEST name="SE-lcg-cp">
          <TIMESTAMP>2007-02-28T00:51:01Z</TIMESTAMP>
          <STATUS>ok</STATUS>
        </TEST>
        <TEST name="SE-lcg-cr">
          <TIMESTAMP>2007-02-28T01:53:14Z</TIMESTAMP>
          <STATUS>ok</STATUS>
        </TEST>
        <TEST name="SE-lcg-del">
          <TIMESTAMP>2007-02-28T02:52:48Z</TIMESTAMP>
          <STATUS>ok</STATUS>
        </TEST>
        <TEST name="SRM-advisory-delete">
          <TIMESTAMP>2007-02-28T03:57:33Z</TIMESTAMP>
          <STATUS>ok</STATUS>
        </TEST>
        <TEST name="SRM-get">
          <TIMESTAMP>2007-02-28T03:57:33Z</TIMESTAMP>
          <STATUS>ok</STATUS>
        </TEST>
        <TEST name="SRM-put">
          <TIMESTAMP>2007-02-28T03:57:33Z</TIMESTAMP>
          <STATUS>ok</STATUS>
        </TEST>
      </VO>
    </SERVICE>
  </SERVICES>
</ROOT>

Current status of all tests executed by certain VO

Description: This interface is used to retrieve the current status of all tests executed by a particular VO for one or more services.

* Request URL:*

<baseURI>/current_status.xsql?service_name=castorsrm.cern.ch&executedBy_vo_name=OPS
Description of the parameters:
  • service_name - the services for which current status has to be calculated and test results displayed. This param may appear more than once.
  • executedBy_vo_name - vo name that executed the tests. This param may appear more than once.

Response URL:

<?xml version="1.0"?>
<ROOT>
  <SERVICES>
    <SERVICE name="castorsrm.cern.ch" type="SE">
      <VO name="OPS" role="executedBy">
        <TEST name="SE-lcg-cp">
          <TIMESTAMP>2007-02-28T00:51:01Z</TIMESTAMP>
          <STATUS>ok</STATUS>
        </TEST>
        <TEST name="SE-lcg-cr">
          <TIMESTAMP>2007-02-28T01:53:14Z</TIMESTAMP>
          <STATUS>ok</STATUS>
        </TEST>
        <TEST name="SE-lcg-del">
          <TIMESTAMP>2007-02-28T02:52:48Z</TIMESTAMP>
          <STATUS>ok</STATUS>
        </TEST>
        <TEST name="SRM-advisory-delete">
          <TIMESTAMP>2007-02-28T03:57:33Z</TIMESTAMP>
          <STATUS>ok</STATUS>
        </TEST>
        <TEST name="SRM-get">
          <TIMESTAMP>2007-02-28T03:57:33Z</TIMESTAMP>
          <STATUS>ok</STATUS>
        </TEST>
        <TEST name="SRM-put">
          <TIMESTAMP>2007-02-28T03:57:33Z</TIMESTAMP>
          <STATUS>ok</STATUS>
        </TEST>
      </VO>
    </SERVICE>
  </SERVICES>
</ROOT>

GridView visualisation components

In the specification of GridView components we assume the following definition:

<baseURI> := http://<gridviewhost>/<path>

Of course baseURI is specific to the installation of GridView and the path is left up to GridView developers.

Site and service availability plots

  • availability of a single site for given VO:
    <baseURI>?Site_name=<sitename>&VO_name=<voname>&SiteMetric_name=<availmetricname>& \
            startTime=<start>&endTime=<end>
    
    notes:
    • suggested values for availmetricname:
      • avail:hourly-site-avail - each bar represents availability during 1 hour
      • avail:daily-site-avail - each bar represents availability during 1 day
      • avail:weekly-site-avail - each bar represents availability during 1 week
    • additional service specific paramaters can be provided
  • availability of a service type for given site and VO:
    <baseURI>?Site_name=<sitename>&Service_type=<type>&VO_name=<voname>& \
            SiteMetric_name=<availmetricname>&startTime=<start>&endTime=<end>
    
    notes:
    • suggested values for availmetricname:
      • avail:hourly-siteservice-avail - each bar represents availability during 1 hour
      • avail:daily-siteservice-avail - each bar represents availability during 1 day
      • avail:weekly-siteservice-avail - each bar represents availability during 1 week
    • additional service specific paramaters can be provided
  • availability of a single service instance for given VO:
    <baseURI>?Service_name=<servicename>&Service_type=<type>&VO_name=<voname>& \
             SiteMetric_name=<availmetricname>&startTime=<start>&endTime=<end>
    
    notes:
    • suggested values for availmetricname:
      • avail:hourly-service-avail - each bar represents availability during 1 hour
      • avail:daily-service-avail - each bar represents availability during 1 day
      • avail:weekly-service-avail - each bar represents availability during 1 week
    • additional service specific paramaters can be provided

SAM tests history bars

Should display a single or multiple horizontal bars showing the history of test results for given service instance (name,type) and selected VO.

General request URI (barURI):

<barURI> := <baseURI>?Service_name=<servicename>&Service_type=<type>&startTime=<start>&endTime=<end>

Variants:

  • compact history bar of a single test:
    <barURI>&display=compact&ServiceMetric_name=test:<testname>&calculatedFor_VO_name=<voname>
    
    Notes:
    • test: prefix in the metric name is a subject for further standardization (it can change)
    • testname should be a valid SAM test name, for example CE-sft-job
  • history bars of all critical tests for given VO:
    <barURI>&display=full&criticalFor_VO_name=<voname>&showAvailability=true|false
    
    Notes:
    • showAvailability is a service specific parameter which decides whether to show or not to show the overall service availability history bar for given VO (on top of other bars). It should be an optional parameter (if not present, true should be assumed as the default)
  • history bars of all tests executed by given VO:
    <barURI>&display=full&calculatedFor_VO_name=<voname>
    

Edit | Attach | Watch | Print version | History: r7 < r6 < r5 < r4 < r3 | Backlinks | Raw View | WYSIWYG | More topic actions
Topic revision: r7 - 2007-03-26 - DavidCollados
 
    • Cern Search Icon Cern Search
    • TWiki Search Icon TWiki Search
    • Google Search Icon Google Search

    LCG All webs login

This site is powered by the TWiki collaboration platform Powered by PerlCopyright & 2008-2019 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback