Changes between Version 32 and Version 33 of OperationalMonitoring/DatastorePolling


Ignore:
Timestamp:
08/29/14 10:49:30 (5 years ago)
Author:
lnevers@bbn.com
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • OperationalMonitoring/DatastorePolling

    v32 v33  
    66== API Basics ==
    77
    8 This page describes the API to be used to poll Local datastores for monitoring data.   The API will be developed with a polling mechanism first.  Overview:
     8This page describes the API used to poll Local datastores for monitoring data.   The API will be developed with a polling mechanism first.  Overview:
    99
    1010 * Polls are done from the collector to the Local datastore via a REST API which returns JSON text.
    1111
    12  * First, the Collector polls a Local datastore at '/info/' of the local store url to get information about what the datastore has.  This is done through multiple polls, outlined below. 
     12 * First, the Collector polls a Local datastore at '/info/' of the local store URL to get information about what the datastore has.  This is done through multiple polls, outlined below. 
    1313
    1414 * Second, the collector polls for time-series data at '/data/' to get event-based or measurement data.  The query contains a set of event types, a set of object IDs, and timestamp filters, outlined below.
     
    1616== Info Queries ==
    1717
    18 The collector retrieves from a config local datastore (to be developed and is hardcoded for now), a set of urls of local datastores that are associated with one or more aggregate managers (AMs).  This allows the collector to poll local datastores for information about the data associated with each local datastore and AM at <datastore_url>/info/aggregate/<aggregate_id>.  The information returned is a list of properties about the aggregate as well as a list of nodes, slivers, and VLANs.   Here is  [wiki:OperationalMonitoring/DataSchema#Dataaboutanaggregate a detailed example of an aggregate info query].
     18The collector retrieves from a config local datastore a set of URLs of local datastores that are associated with one or more aggregate managers (AMs).  This allows the collector to poll local datastores for information about the data associated with each local datastore and AM at <datastore_url>/info/aggregate/<aggregate_id>.  The information returned is a list of properties about the aggregate as well as a list of nodes, slivers, and VLANs.   Here is  [wiki:OperationalMonitoring/DataSchema20#Aggregatecallandresponse a detailed example of an aggregate info query].
    1919
    20 The collector will then query for information about particular objects one at a time (i.e., a node).  The query returns a list of properties about the object as well as a list of associated objects (i.e., a node's interfaces).  In this example, a node info query will be at <datastore_url>/info/node/<node_id>.  Here is a [wiki:OperationalMonitoring/DataSchema#Dataaboutanode a detailed example of a node info query].  The collector would repeat for other nodes it received in the list in the aggregate info query.
     20The collector will then query for information about particular objects one at a time (i.e., a node).  The query returns a list of properties about the object as well as a list of associated objects (i.e., a node's interfaces).  In this example, a node info query will be at <datastore_url>/info/node/<node_id>.  Here is a [wiki:OperationalMonitoring/DataSchema20#Nodecallandresponse a detailed example of a node info query].  The collector would repeat for other nodes it received in the list in the aggregate info query.
    2121
    2222Depending on what the collector is supporting above it in the form of different monitoring applications, it may continue querying the local datastore about objects or resources it has data about.  They are of similar form.  Here are links to examples:
    2323
    24  * [wiki:OperationalMonitoring/DataSchema#Dataaboutaninterface An example interface query]
    25  * [wiki:OperationalMonitoring/DataSchema#DataaboutaGENIsliver An example sliver query]
     24 * [wiki:OperationalMonitoring/DataSchema20#Interfacecallandresponse An example interface query]
     25 * [wiki:OperationalMonitoring/DataSchema20#Slivercallandresponse An example sliver query]
    2626
    27 If the collector is tracking sliver and slice info, the collector may also be directed to a slice authority local datastore, which is a different datastore than one containing shared host nodes.  Here is a [wiki:OperationalMonitoring/DataSchema#Dataaboutasliceauthority detailed example slice query], and here is a [wiki:OperationalMonitoring/DataSchema#DataaboutaGENIuser detailed example of a user query].  Both of these queries are of similar form with <datastore_url>/info/slice/<slice_id> and <datastore_url>/info/user/<user_id> respectively.
     27If the collector is tracking sliver and slice info, the collector may also be directed to a slice authority local datastore, which is a different datastore than one containing shared host nodes.  Here is a [wiki:OperationalMonitoring/DataSchema20#Sliceauthoritycallandresponse detailed example slice query], and here is a [wiki:OperationalMonitoring/DataSchema20#Usercallandresponse detailed example of a user query].  Both of these queries are of similar form with <datastore_url>/info/slice/<slice_id> and <datastore_url>/info/user/<user_id> respectively.
    2828
    2929The API does not support querying multiple objects in a single info query.  For example, <datastore_url>/info/node/ will not return all the nodes' info at that local datastore.
     
    5353}}}
    5454
    55 The response to this REST data query is a list of data items.  Here are [wiki:OperationalMonitoring/DataSchema#Measurementsusedfortheusecases a few example responses of a single data item]. Here is an example of [wiki:OperationalMonitoring/DataSchema#BulkDataQueries a bulk query response]
     55The response to this REST data query is a list of data items.  Here are [wiki:OperationalMonitoring/DataSchema20#Time-seriesmeasurementscallandresponse a few example responses] of a single and multiple data items.
    5656
    5757== Security ==
     
    6969
    7070Here is link to an email archive with slightly more detail of this [http://lists.geni.net/pipermail/monitoring/2014-April/000212.html security proposal].
    71