diff --git a/ceilometer/event/converter.py b/ceilometer/event/converter.py index d83f985df4..30e8754340 100644 --- a/ceilometer/event/converter.py +++ b/ceilometer/event/converter.py @@ -27,14 +27,17 @@ from ceilometer.i18n import _ OPTS = [ cfg.StrOpt('definitions_cfg_file', default="event_definitions.yaml", + deprecated_for_removal=True, help="Configuration file for event definitions." ), cfg.BoolOpt('drop_unmatched_notifications', default=False, + deprecated_for_removal=True, help='Drop notifications if no event definition matches. ' '(Otherwise, we convert them with just the default traits)'), cfg.MultiStrOpt('store_raw', default=[], + deprecated_for_removal=True, help='Store the raw notification for select priority ' 'levels (info and/or error). By default, raw details are ' 'not captured.') diff --git a/ceilometer/pipeline/base.py b/ceilometer/pipeline/base.py index 0a84052dc0..3acd94e19c 100644 --- a/ceilometer/pipeline/base.py +++ b/ceilometer/pipeline/base.py @@ -31,6 +31,7 @@ OPTS = [ ), cfg.StrOpt('event_pipeline_cfg_file', default="event_pipeline.yaml", + deprecated_for_removal=True, help="Configuration file for event pipeline definition." ), ] diff --git a/doc/source/admin/telemetry-events.rst b/doc/source/admin/telemetry-events.rst index 657378c240..ea1575ce50 100644 --- a/doc/source/admin/telemetry-events.rst +++ b/doc/source/admin/telemetry-events.rst @@ -6,6 +6,9 @@ In addition to meters, the Telemetry service collects events triggered within an OpenStack environment. This section provides a brief summary of the events format in the Telemetry service. +.. warning:: + Events support is deprecated. + While a sample represents a single, numeric datapoint within a 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 diff --git a/doc/source/contributor/events.rst b/doc/source/contributor/events.rst index 726d205fd8..882a4e65da 100644 --- a/doc/source/contributor/events.rst +++ b/doc/source/contributor/events.rst @@ -23,12 +23,18 @@ Events vs. Samples ~~~~~~~~~~~~~~~~~~ In addition to Meters, and related Sample data, Ceilometer can also process -Events. 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. +Events. + + +.. warning:: + Events support is deprecated. + + +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 object in an OpenStack system, such as the resize of an instance, or creation diff --git a/releasenotes/notes/deprecate-events-6561f4059fa25c02.yaml b/releasenotes/notes/deprecate-events-6561f4059fa25c02.yaml new file mode 100644 index 0000000000..e78ccea2d0 --- /dev/null +++ b/releasenotes/notes/deprecate-events-6561f4059fa25c02.yaml @@ -0,0 +1,5 @@ +--- +deprecations: + - | + The Ceilometer event subsystem and pipeline is now deprecated and will be + removed in a future release.