doc/OpenStack/openstack_plugins.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 OpenStack Plugin Guide
  23 **********************
  24 The OSM MON module provides support for two different OpenStack plugins that
  25 provide monitoring functionality. The Gnocchi plugin implements metric
  26 functionality, whilst the Aodh plugin supports alarming functionality.
  27
  28 Gnocchi
  29 -------
  30 Gnocchi is a timeseries, metrics and resources database, which allows you to
  31 store and access the information and history of resources and their metrics.
  32
  33 For more information on Gnocchi please refer to the source code/documentation:
  34
  35     ::
  36
  37         https://github.com/gnocchixyz/gnocchi
  38
  39 For plugin specific instructions and configuration options please refer to the
  40 following guide:
  41 : `<doc/OpenStack/gnocchi_plugin_guide.rst>`
  42
  43 Aodh
  44 ----
  45 Aodh is OpenStack's alarming project, it enables alarms to be created based on
  46 Gnocchi metrics. Rules can be defined for these metrics to create these alarms.
  47
  48 For more information on this project please refer to the source
  49 code/documentation:
  50
  51     ::
  52
  53         https://github.com/openstack/aodh
  54
  55 For plugin specific instructions and configuration options please refer to the
  56 following guide:
  57 : `<doc/OpenStack/aodh_plugin_guide.rst>`