openstack/vitrage
Code Issues Proposed changes
7d71e97239
vitrage/doc/source/index.rst
Q.hongtao 15f0b333ac Update doc: Adjust index layout 
Now template-loading-v2 and templates-loading are shown in the homepage index.
V2 sshould be hidden by default, it can be only viewed  when viewing v2 link.

Change-Id: I0884c9e6b61e4c87bd264933eb8b6ca36202f66f
2020-05-18 09:00:02 +08:00

3.3 KiB
Raw Blame History

Welcome to Vitrage documentation!

Vitrage is the OpenStack RCA (Root Cause Analysis) service for organizing, analyzing and expanding OpenStack alarms & events, yielding insights regarding the root cause of problems and deducing their existence before they are directly detected.

High Level Functionality

  • Physical-to-Virtual entities mapping
  • Deduced alarms and states (i.e., raising an alarm or modifying a state based on analysis of the system, instead of direct monitoring)
  • Root Cause Analysis (RCA) for alarms/events
  • Horizon plugin for the above features

High Level Architecture

image

Vitrage Data Sources are responsible for importing information from different sources, regarding the state of the system. This includes information regarding resources (physical, virtual, and applications) and alarms. The information is then processed into the Vitrage Graph. Currently Vitrage supports OpenStack datasources like Nova, Cinder, Neutron, Heat and Aodh, as well as external monitors like Nagios, Zabbix and collectd.

Vitrage Graph holds the information collected by the Data Sources, as well as their inter-relations. Additionally, it implements a collection of basic graph algorithms that are used by the Vitrage Evaluator (e.g., sub-matching, BFS, DFS etc).

Vitrage Evaluator coordinates the analysis of (changes to) the Vitrage Graph and processes the results of this analysis. It is responsible for executing different kind of template-based actions in Vitrage, such as to add an RCA (Root Cause Analysis) relationship between alarms, raise a deduced alarm or set a deduced state.

Vitrage Notifiers can be used to notify external systems of Vitrage alarms and states. The following notifiers are currently supported: Nova (update the states of the host and instances), Mistral (execute workflows), SNMP and HTTP webhooks.

Installation Guide

install/index

Developer Guide

contributor/index contributor/vitrage-template-format-v2 contributor/templates-loading-v2 contributor/not_operator_support_v2

contributor/contributing contributor/vitrage-first_steps contributor/vitrage-api contributor/vitrage-templates contributor/devstack-installation contributor/configuration

CLI Guide

cli/index

Design Documents

contributor/vitrage-graph-design contributor/scenario-evaluator contributor/vitrage-use-cases contributor/add-new-datasource contributor/not_operator_support contributor/templates-loading contributor/vitrage-ha-and-history-vision contributor/datasource-snmp-parsing-support contributor/entity_equivalence_use_cases