Changes between Version 6 and Version 7 of OperationalMonitoring/DataSchema20


Ignore:
Timestamp:
08/27/14 13:24:07 (5 years ago)
Author:
dwiggins@bbn.com
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • OperationalMonitoring/DataSchema20

    v6 v7  
    11[[PageOutline]]
    22
    3 == REST Data Schema ==
    4 All of these inherit from the [http://unis.incntre.iu.edu/schema/20120709/networkresource UNIS network resource schema] with the exception of the opsconfig schema.
    5 
    6  * [http://www.gpolab.bbn.com/monitoring/schema/20140828/opsconfig opsconfig]: operational configuration metadata, including locations of and information about other datastores [http://www.gpolab.bbn.com/monitoring/schema/20140828/opsconfig.schema.jwc opsconfig with comments]
    7  * [http://www.gpolab.bbn.com/monitoring/schema/20140828/aggregate aggregate]: data about an aggregate (including lists of resources and slivers at that aggregate, and where to look for measurements about the aggregate) [http://www.gpolab.bbn.com/monitoring/schema/20140828/aggregate aggregate with comments]
    8  * [http://www.gpolab.bbn.com/monitoring/schema/20140828/node node]: data about a node [http://www.gpolab.bbn.com/monitoring/schema/20140828/node node with comments]
    9  * [http://www.gpolab.bbn.com/monitoring/schema/20140828/interface interface]: data about a network interface
    10  * [http://www.gpolab.bbn.com/monitoring/schema/20140828/interfacevlan interfacevlan]: data about a tagged VLAN subinterface of a network interface
    11  * [http://www.gpolab.bbn.com/monitoring/schema/20140828/sliver sliver]: data about a sliver at an aggregate
    12  * [http://www.gpolab.bbn.com/monitoring/schema/20140828/authority authority]: data about a GENI authority
    13  * [http://www.gpolab.bbn.com/monitoring/schema/20140828/slice slice]: data about a slice at an authority
    14  * [http://www.gpolab.bbn.com/monitoring/schema/20140828/user user]: data about a GENI user at an authority
    15  * [http://www.gpolab.bbn.com/monitoring/schema/20140828/experiment experiment]: data about an operational monitoring experiment for monitoring the dataplane.
    16  * [http://www.gpolab.bbn.com/monitoring/schema/20140828/data data]: data about time-series measurements.  Schema based in part on [http://unis.incntre.iu.edu/schema/20120709/metadata]
     3== JSON Schemas for Replies to REST API calls ==
     4All of these schemas inherit from the [http://unis.incntre.iu.edu/schema/20120709/networkresource UNIS network resource schema] with the exception of the opsconfig schema.
     5
     6 * [http://www.gpolab.bbn.com/monitoring/schema/20140828/opsconfig opsconfig]: operational configuration metadata, including locations of and information about other datastores [http://www.gpolab.bbn.com/monitoring/schema/20140828/opsconfig.schema.jwc opsconfig schema with comments]
     7 * [http://www.gpolab.bbn.com/monitoring/schema/20140828/aggregate aggregate]: data about an aggregate (including lists of resources and slivers at that aggregate, and where to look for measurements about the aggregate) [http://www.gpolab.bbn.com/monitoring/schema/20140828/aggregate.schema.jwc aggregate schema with comments]
     8 * [http://www.gpolab.bbn.com/monitoring/schema/20140828/node node]: data about a node [http://www.gpolab.bbn.com/monitoring/schema/20140828/node.schema.jwc node schema with comments]
     9 * [http://www.gpolab.bbn.com/monitoring/schema/20140828/interface interface]: data about a network interface [http://www.gpolab.bbn.com/monitoring/schema/20140828/interface.schema.jwc interface schema with comments]
     10 * [http://www.gpolab.bbn.com/monitoring/schema/20140828/interfacevlan interfacevlan]: data about a tagged VLAN subinterface of a network interface [http://www.gpolab.bbn.com/monitoring/schema/20140828/interfacevlan.schema.jwc interfacevlan schema with comments]
     11 * [http://www.gpolab.bbn.com/monitoring/schema/20140828/sliver sliver]: data about a sliver at an aggregate [http://www.gpolab.bbn.com/monitoring/schema/20140828/sliver.schema.jwc sliver schema with comments]
     12 * [http://www.gpolab.bbn.com/monitoring/schema/20140828/authority authority]: data about a GENI authority [http://www.gpolab.bbn.com/monitoring/schema/20140828/authority.schema.jwc authority schema with comments]
     13 * [http://www.gpolab.bbn.com/monitoring/schema/20140828/slice slice]: data about a slice at an authority [http://www.gpolab.bbn.com/monitoring/schema/20140828/slice.schema.jwc slice schema with comments]
     14 * [http://www.gpolab.bbn.com/monitoring/schema/20140828/user user]: data about a GENI user at an authority [http://www.gpolab.bbn.com/monitoring/schema/20140828/user.schema.jwc user schema with comments]
     15 * [http://www.gpolab.bbn.com/monitoring/schema/20140828/experiment experiment]: data about an operational monitoring experiment for monitoring the dataplane [http://www.gpolab.bbn.com/monitoring/schema/20140828/experiment.schema.jwc experiment schema with comments]
     16 * [http://www.gpolab.bbn.com/monitoring/schema/20140828/data data]: data about time-series measurements.  Schema based in part on [http://unis.incntre.iu.edu/schema/20120709/metadata] [http://www.gpolab.bbn.com/monitoring/schema/20140828/data.schema.jwc data schema with comments]
    1717 * For now, we would use the `ops_monitoring` namespace for operations monitoring, meaning:
    1818   * When we add monitoring-relevant optional properties to objects, we'll put them in an `ops_monitoring` dictionary
     
    3131==== Data about operational monitoring configuration ====
    3232
    33 Operational monitoring configuration data tells collectors where to find local datastores, and includes relevant metadata (like URNs and metadata about datastore or aggregate types) that collectors can use to decide which datastores to query.  It is described using [http://www.gpolab.bbn.com/monitoring/schema/20140501/opsconfig# the opsconfig schema].  Examples:
     33Operational monitoring configuration data tells collectors where to find local datastores, and includes relevant metadata (like URNs and metadata about datastore or aggregate types) that collectors can use to decide which datastores to query.  It is described using [http://www.gpolab.bbn.com/monitoring/schema/20140828/opsconfig# the opsconfig schema].  Examples:
    3434 * geni-prod: a hypothetical config datastore listing production aggregates and authorities:
    3535{{{
    3636{
    37   "$schema": "http://www.gpolab.bbn.com/monitoring/schema/20140501/opsconfig#",
     37  "$schema": "http://www.gpolab.bbn.com/monitoring/schema/20140828/opsconfig#",
    3838  "id": "geni-prod",
    3939  "selfRef": "https://datastore.geni.net/opsconfigs/geni-prod",
     
    5757==== Data about an aggregate ====
    5858
    59 Aggregates are indexed by GENI-agreed short name and described using [http://www.gpolab.bbn.com/monitoring/schema/20140501/aggregate# the aggregate schema].  Examples:
     59Aggregates are indexed by GENI-agreed short name and described using [http://www.gpolab.bbn.com/monitoring/schema/20140828/aggregate# the aggregate schema].  Examples:
    6060
    6161Hypothetical REST call for GPO-IG:
     
    6666{{{
    6767{
    68   "$schema": "http://www.gpolab.bbn.com/monitoring/schema/20140501/aggregate#",
     68  "$schema": "http://www.gpolab.bbn.com/monitoring/schema/20140828/aggregate#",
    6969  "id": "gpo-ig",
    7070  "selfRef": "https://datastore.instageni.gpolab.bbn.com/info/aggregate/gpo-ig",
     
    9797==== Data about a node ====
    9898
    99 Nodes have an ID which is a URL-sanitized version of their URN and are described using [http://unis.incntre.iu.edu/schema/20140501/node# the node schema].  Examples:
     99Nodes have an ID which is a URL-sanitized version of their URN and are described using [http://unis.incntre.iu.edu/schema/20140828/node# the node schema].  Examples:
    100100 Hypothetical REST call for GPO-IG PC1:
    101101{{{
     
    105105{{{
    106106{
    107   "$schema": "http://unis.incntre.iu.edu/schema/20140501/node#",
     107  "$schema": "http://unis.incntre.iu.edu/schema/20140828/node#",
    108108  "id": "instageni.gpolab.bbn.com_node_pc1",
    109109  "ts": 1391192705275101,
     
    135135==== Data about a link ====
    136136
    137 Links have an ID which is a URL-sanitized version of their URN and are described using [http://www.gpolab.bbn.com/monitoring/schema/20140501/link# the link schema].  Examples:
     137Links have an ID which is a URL-sanitized version of their URN and are described using [http://www.gpolab.bbn.com/monitoring/schema/20140828/link# the link schema].  Examples:
    138138 Hypothetical REST call for GRNOC link salt_port_1750:
    139139{{{
     
    143143{{{
    144144{
    145   "$schema": "http://www.gpolab.bbn.com/monitoring/schema/20140501/link#",
     145  "$schema": "http://www.gpolab.bbn.com/monitoring/schema/20140828/link#",
    146146  "id": "datastore.grnoc.iu.edu_link_001",
    147147  "ts": 1391192705275101,
     
    204204{{{
    205205{
    206   "$schema": "http://www.gpolab.bbn.com/monitoring/schema/20140501/port#",
     206  "$schema": "http://www.gpolab.bbn.com/monitoring/schema/20140828/port#",
    207207  "selfRef": "https://datastore.instageni.gpolab.bbn.com/info/interface/instageni.gpolab.bbn.com_interface_pc1:eth0",
    208208  "urn": "urn:publicid:IDN+instageni.gpolab.bbn.com+interface+pc1:eth0",
     
    227227{{{
    228228{
    229   "$schema": "http://www.gpolab.bbn.com/monitoring/schema/20140501/port#",
     229  "$schema": "http://www.gpolab.bbn.com/monitoring/schema/20140828/port#",
    230230  "selfRef": "https://datastore.instageni.gpolab.bbn.com/info/interface/instageni.gpolab.bbn.com_interface_pc1:eth1",
    231231  "urn": "urn:publicid:IDN+instageni.gpolab.bbn.com+interface+pc1:eth1",
     
    244244==== Data about a slice authority ====
    245245
    246 GENI slice authorities are indexed by domain name and described using [http://www.gpolab.bbn.com/monitoring/schema/20140501/authority# the authority schema].  Examples:
     246GENI slice authorities are indexed by domain name and described using [http://www.gpolab.bbn.com/monitoring/schema/20140828/authority# the authority schema].  Examples:
    247247
    248248
     
    254254{{{
    255255{
    256   "$schema": "http://www.gpolab.bbn.com/monitoring/schema/20140501/authority#",
     256  "$schema": "http://www.gpolab.bbn.com/monitoring/schema/20140828/authority#",
    257257  "id": "ch.geni.net",
    258258  "selfRef": "https://datastore.ch.geni.net/info/authority/ch.geni.net",
     
    286286{{{
    287287{
    288   "$schema": "http://www.gpolab.bbn.com/monitoring/schema/20140501/port-vlan#",
     288  "$schema": "http://www.gpolab.bbn.com/monitoring/schema/20140828/port-vlan#",
    289289  "selfRef": "https://datastore.instageni.gpolab.bbn.com/interfacevlan/instageni.gpolab.bbn.com_interface_pc1:eth1:1750",
    290290  "urn": "urn:publicid:IDN+instageni.gpolab.bbn.com+interface+pc1:eth1:1750",
     
    302302==== Data about a GENI user ====
    303303
    304 GENI users have an ID based on the username and are described using [http://www.gpolab.bbn.com/monitoring/schema/20140501/user# the GENI user schema].  Examples:
     304GENI users have an ID based on the username and are described using [http://www.gpolab.bbn.com/monitoring/schema/20140828/user# the GENI user schema].  Examples:
    305305
    306306 Hypothetical REST call for user tupty at ch.geni.net:
     
    311311{{{
    312312{
    313   "$schema": "http://www.gpolab.bbn.com/monitoring/schema/20140501/user#",
     313  "$schema": "http://www.gpolab.bbn.com/monitoring/schema/20140828/user#",
    314314  "id": "tupty",
    315315  "selfRef": "https://datastore.ch.geni.net/info/user/tupty",
     
    327327==== Data about a GENI slice ====
    328328
    329 GENI slices have an ID based on the URN and are described using [http://www.gpolab.bbn.com/monitoring/schema/20140501/slice# the GENI slice schema].  Examples:
     329GENI slices have an ID based on the URN and are described using [http://www.gpolab.bbn.com/monitoring/schema/20140828/slice# the GENI slice schema].  Examples:
    330330Hypothetical REST call for tuptyexclusive slice:
    331331{{{
     
    335335{{{
    336336{
    337   "$schema": "http://www.gpolab.bbn.com/monitoring/schema/20140501/slice#",
     337  "$schema": "http://www.gpolab.bbn.com/monitoring/schema/20140828/slice#",
    338338  "id": "ch.geni.net_gpo-infra_slice_tuptyexclusive",
    339339  "selfRef": "https://datastore.ch.geni.net/info/slice/ch.geni.net_gpo-infra_slice_tuptyexclusive",
     
    359359==== Data about a GENI sliver ====
    360360
    361 GENI sliver have an ID based on the URN and are described using [http://www.gpolab.bbn.com/monitoring/schema/20140501/sliver# the GENI sliver schema].  Examples:
     361GENI sliver have an ID based on the URN and are described using [http://www.gpolab.bbn.com/monitoring/schema/20140828/sliver# the GENI sliver schema].  Examples:
    362362 Hypothetical REST call for tuptyexclusive instageni sliver:
    363363{{{
     
    367367{{{
    368368{
    369   "$schema": "http://www.gpolab.bbn.com/monitoring/schema/20140501/sliver#",
     369  "$schema": "http://www.gpolab.bbn.com/monitoring/schema/20140828/sliver#",
    370370  "id": "instageni.gpolab.bbn.com_sliver_26947",
    371371  "selfRef": "https://datastore.instageni.gpolab.bbn.com/info/sliver/instageni.gpolab.bbn.com_sliver_26947",
     
    403403{{{
    404404{
    405    "$schema": "http://www.gpolab.bbn.com/monitoring/schema/20140501/externalcheck#",
     405   "$schema": "http://www.gpolab.bbn.com/monitoring/schema/20140828/externalcheck#",
    406406   "id": "gpo",
    407407   "selfRef": "https://externalcheckstore.gpolab.bbn.com/info/externalcheck/gpo",
     
    427427==== Data about a monitoring experiment ====
    428428
    429 Operational monitoring measures the dataplane with a set of simple tests between aggregates described using [http://www.gpolab.bbn.com/monitoring/schema/20140501/experiment# the operational monitoring experiment schema].  Examples:
     429Operational monitoring measures the dataplane with a set of simple tests between aggregates described using [http://www.gpolab.bbn.com/monitoring/schema/20140828/experiment# the operational monitoring experiment schema].  Examples:
    430430 Hypothetical REST call for missouri-ig to gpo-ig experiment:
    431431{{{
     
    435435{{{
    436436{
    437   "$schema": "http://www.gpolab.bbn.com/monitoring/schema/20140501/experiment#",
     437  "$schema": "http://www.gpolab.bbn.com/monitoring/schema/20140828/experiment#",
    438438  "id": "missouri-ig_to_gpo-ig",
    439439  "selfRef": "https://datastore.externalchecks.geni.net/info/experiment/missouri-ig_to_gpo-ig",
     
    463463{{{
    464464{
    465   "$schema": "http://www.gpolab.bbn.com/monitoring/schema/20140501/data#",
     465  "$schema": "http://www.gpolab.bbn.com/monitoring/schema/20140828/data#",
    466466  "id": "cpu_util:instageni.gpolab.bbn.com_node_pc1",
    467467  "subject": "https://datastore.instageni.gpolab.bbn.com/info/node/instageni.gpolab.bbn.com_node_pc1",
     
    487487{{{
    488488{
    489   "$schema": "http://www.gpolab.bbn.com/monitoring/schema/20140501/data#",
     489  "$schema": "http://www.gpolab.bbn.com/monitoring/schema/20140828/data#",
    490490  "id": "swap_free:instageni.gpolab.bbn.com_node_pc1",
    491491  "subject": "https://datastore.instageni.gpolab.bbn.com/info/node/instageni.gpolab.bbn.com_node_pc1",
     
    510510{{{
    511511{
    512   "$schema": "http://www.gpolab.bbn.com/monitoring/schema/20140501/data#",
     512  "$schema": "http://www.gpolab.bbn.com/monitoring/schema/20140828/data#",
    513513  "id": "mem_active_kb:instageni.gpolab.bbn.com_node_pc1",
    514514  "subject": "https://datastore.instageni.gpolab.bbn.com/info/node/instageni.gpolab.bbn.com_node_pc1",
     
    533533{{{
    534534{
    535   "$schema": "http://www.gpolab.bbn.com/monitoring/schema/20140501/data#",
     535  "$schema": "http://www.gpolab.bbn.com/monitoring/schema/20140828/data#",
    536536  "id": "rx_bps:instageni.gpolab.bbn.com_interface_pc1:eth0",
    537537  "subject": "https://datastore.instageni.gpolab.bbn.com/info/ports/instageni.gpolab.bbn.com_interface_pc1:eth0",
     
    556556{{{
    557557{
    558   "$schema": "http://www.gpolab.bbn.com/monitoring/schema/20140501/data#",
     558  "$schema": "http://www.gpolab.bbn.com/monitoring/schema/20140828/data#",
    559559  "id": "is_available:instageni.gpolab.bbn.com_node_pc1",
    560560  "subject": "https://datastore.instageni.gpolab.bbn.com/info/node/instageni.gpolab.bbn.com_node_pc1",
     
    585585[
    586586 {
    587    "$schema": "http://www.gpolab.bbn.com/monitoring/schema/20140501/data#",
     587   "$schema": "http://www.gpolab.bbn.com/monitoring/schema/20140828/data#",
    588588    "id": "cpu_util:instageni.gpolab.bbn.com_node_pc1",
    589589    "subject": "https://datastore.instageni.gpolab.bbn.com/info/node/instageni.gpolab.bbn.com_node_pc1",
     
    602602,
    603603 {
    604    "$schema": "http://www.gpolab.bbn.com/monitoring/schema/20140501/data#",
     604   "$schema": "http://www.gpolab.bbn.com/monitoring/schema/20140828/data#",
    605605   "id": "cpu_util:instageni.gpolab.bbn.com_node_pc2",
    606606   "subject": "https://datastore.instageni.gpolab.bbn.com/info/node/instageni.gpolab.bbn.com_node_pc2",
     
    619619,
    620620 {
    621   "$schema": "http://www.gpolab.bbn.com/monitoring/schema/20140501/data#",
     621  "$schema": "http://www.gpolab.bbn.com/monitoring/schema/20140828/data#",
    622622  "id": "mem_active_kb:instageni.gpolab.bbn.com_node_pc1",
    623623  "subject": "https://datastore.instageni.gpolab.bbn.com/info/node/instageni.gpolab.bbn.com_node_pc1",
     
    636636,
    637637 {
    638   "$schema": "http://www.gpolab.bbn.com/monitoring/schema/20140501/data#",
     638  "$schema": "http://www.gpolab.bbn.com/monitoring/schema/20140828/data#",
    639639  "id": "mem_active_kb:instageni.gpolab.bbn.com_node_pc2",
    640640  "subject": "https://datastore.instageni.gpolab.bbn.com/info/node/instageni.gpolab.bbn.com_node_pc2",