doc/OpenStack/gnocchi_plugin_guide.rst

   1 ..
   2        # Copyright 2017 Intel Research and Development Ireland Limited
   3        # *************************************************************
   4        # This file is part of OSM Monitoring module
   5        # All Rights Reserved to Intel Corporation
   6        #
   7        # Licensed under the Apache License, Version 2.0 (the "License"); you
   8        # may not use this file except in compliance with the License. You may
   9        # obtain a copy of the License at
  10        #
  11        #         http://www.apache.org/licenses/LICENSE-2.0
  12        #
  13        # Unless required by applicable law or agreed to in writing, software
  14        # distributed under the License is distributed on an "AS IS" BASIS,
  15        # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
  16        # implied. See the License for the specific language governing
  17        # permissions and limitations under the License.
  18        #
  19        # For those usages not covered by the Apache License, Version 2.0 please
  20        # contact: helena.mcgough@intel.com or adrian.hoban@intel.com
  21
  22 Gnocchi Plugin Guide for OSM MON
  23 ********************************
  24 The Gnocchi plugin for the MON module allows an OSM user to utilise metric and
  25 resource functionality from their OpenStack deployment.
  26
  27 This plugin allows you to create, list, delete and read metric data.
  28
  29     .. note::
  30
  31
  32      An update metric request can also be performed but Gnocchi does not
  33      support this functionality, your request will just be logged.
  34
  35 Supported Metrics
  36 -----------------
  37 Currently this plugin only supports the following metrics:
  38
  39 * AVERAGE_MEMORY_UTILIZATION
  40 * DISK_READ_OPS
  41 * DISK_WRITE_OPS
  42 * DISK_READ_BYTES
  43 * DISK_WRITE_BYTES
  44 * PACKETS_DROPPED
  45 * PACKETS_RECEIVED
  46 * PACKETS_SENT
  47 * CPU_UTILIZATION
  48
  49 Configuring a Metric
  50 --------------------
  51 Any of the above OpenStack metrics can be configured based on the following
  52 configuration options:
  53
  54 * Resource_uuid: Specifies the resource that your metric will be configured for.
  55 * Metric_name: Specify one of the above metrics for your desired resource.
  56 * Metric_unit: the unit that you wish your metric to be monitored in.
  57
  58     .. note::
  59
  60
  61      Your metric can only be specified once for a particular resource.
  62
  63 Deleting a Metric
  64 -----------------
  65 To delete a metric all that is required is to specify the metric_uuid of the
  66 metric you wish to delete.
  67
  68 Listing Metrics
  69 ---------------
  70 A full list of OSM generated metrics can be created by perform a list request
  71 without defining any list parameters.
  72
  73 Specific lists can also be created based on two different input parameters:
  74
  75 * Metric_name
  76 * Resource_uuid
  77
  78 These parameters will generate a list of metrics that have the metric_name
  79 and/or the resource_uuid defined. These parameters can be defined seperately or
  80 in combination.
  81
  82 Reading Metric Data
  83 -------------------
  84 To define what metric data you want to read from the Gnocchi database a no. of
  85 parameters have to be defined:
  86
  87 * Metric_uuid: To define which metric's data you would like to read.
  88 * Collection_unit: Defines the unit of time that you want to read the metric
  89   data over.
  90
  91     .. note::
  92
  93
  94      The units that you can define include: HR, DAY, WEEK, MONTH, YEAR.
  95
  96 * Collection_period: defines the integer value of the collection period.
  97   E.g. 1 DAY.
  98
  99 This type of request results in a list of data values and a corresponding list
 100 of timestamps.