Deprecate event subsystem

This subsystem has never been finished and is not maintained.
Deprecate it for future removal.

Change-Id: I934696b8fc066adc2d9085c64dffb3759fa4489c
This commit is contained in:
Julien Danjou 2018-09-18 11:11:44 +02:00
parent 42f6f68eb9
commit 8a0245a5b3
5 changed files with 24 additions and 6 deletions

View File

@ -27,14 +27,17 @@ from ceilometer.i18n import _
OPTS = [ OPTS = [
cfg.StrOpt('definitions_cfg_file', cfg.StrOpt('definitions_cfg_file',
default="event_definitions.yaml", default="event_definitions.yaml",
deprecated_for_removal=True,
help="Configuration file for event definitions." help="Configuration file for event definitions."
), ),
cfg.BoolOpt('drop_unmatched_notifications', cfg.BoolOpt('drop_unmatched_notifications',
default=False, default=False,
deprecated_for_removal=True,
help='Drop notifications if no event definition matches. ' help='Drop notifications if no event definition matches. '
'(Otherwise, we convert them with just the default traits)'), '(Otherwise, we convert them with just the default traits)'),
cfg.MultiStrOpt('store_raw', cfg.MultiStrOpt('store_raw',
default=[], default=[],
deprecated_for_removal=True,
help='Store the raw notification for select priority ' help='Store the raw notification for select priority '
'levels (info and/or error). By default, raw details are ' 'levels (info and/or error). By default, raw details are '
'not captured.') 'not captured.')

View File

@ -31,6 +31,7 @@ OPTS = [
), ),
cfg.StrOpt('event_pipeline_cfg_file', cfg.StrOpt('event_pipeline_cfg_file',
default="event_pipeline.yaml", default="event_pipeline.yaml",
deprecated_for_removal=True,
help="Configuration file for event pipeline definition." help="Configuration file for event pipeline definition."
), ),
] ]

View File

@ -6,6 +6,9 @@ In addition to meters, the Telemetry service collects events triggered
within an OpenStack environment. This section provides a brief summary within an OpenStack environment. This section provides a brief summary
of the events format in the Telemetry service. of the events format in the Telemetry service.
.. warning::
Events support is deprecated.
While a sample represents a single, numeric datapoint within a While a sample represents a single, numeric datapoint within a
time-series, an event is a broader concept that represents the state of time-series, an event is a broader concept that represents the state of
a resource at a point in time. The state may be described using various a resource at a point in time. The state may be described using various

View File

@ -23,12 +23,18 @@ Events vs. Samples
~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~
In addition to Meters, and related Sample data, Ceilometer can also process In addition to Meters, and related Sample data, Ceilometer can also process
Events. While a Sample represents a single numeric datapoint, driving a Meter Events.
that represents the changes in that value over time, an Event represents the
state of an object in an OpenStack service (such as an Instance in Nova, or
an Image in Glance) at a point in time when something of interest has occurred. .. warning::
This can include non-numeric data, such as an instance's flavor, or network Events support is deprecated.
address.
While a Sample represents a single numeric datapoint, driving a Meter that
represents the changes in that value over time, an Event represents the state
of an object in an OpenStack service (such as an Instance in Nova, or an Image
in Glance) at a point in time when something of interest has occurred. This can
include non-numeric data, such as an instance's flavor, or network address.
In general, Events let you know when something has changed about an In general, Events let you know when something has changed about an
object in an OpenStack system, such as the resize of an instance, or creation object in an OpenStack system, such as the resize of an instance, or creation

View File

@ -0,0 +1,5 @@
---
deprecations:
- |
The Ceilometer event subsystem and pipeline is now deprecated and will be
removed in a future release.