diff options
| author | Pedro Henrique <phpm13@gmail.com> | 2022-09-01 10:03:29 -0300 |
|---|---|---|
| committer | Pedro Henrique <phpm13@gmail.com> | 2022-09-13 15:05:59 -0300 |
| commit | bff9879e3489bec94241afc0cdfc8472211f7aff (patch) | |
| tree | d876b808020c9534c3ce2131b7fd514420ee9353 /doc | |
| parent | cb448a1dbc48ddd28d9fd0f6b6e44deafd636f52 (diff) | |
| download | ceilometer-bff9879e3489bec94241afc0cdfc8472211f7aff.tar.gz | |
Add extra metadata fields skip
Problem description
===================
Some OpenStack APIs do not always return exactly the
same metadata for all resources. As an example, we
have the server API, which might not return the
'OS-EXT-SRV-ATTR:host' attribute; it depends on the
virtual machine status.
Therefore, if the operator configures to retrieve
the value of the 'OS-EXT-SRV-ATTR:host' attribute in
the response, when the VM is in the 'RUNNING' state,
it will work properly; however, if it is in 'ERROR'
or other state, it will throw a 'key not found'
error when we are collecting the metadata.
Proposal
========
To allow operators to skip the extra_metadata_fields
gathering based on the collected sample attributes. We
propose to add a new 'extra_metadata_fields_skip' in
the dynamic pollster YAML definition where operators
can define some rules to skip gathering extra_metadata
for some samples based on their attributes.
Change-Id: I40176328e1863283890870098418c0944a75bad9
Depends-On: https://review.opendev.org/c/openstack/ceilometer/+/852021
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/admin/telemetry-dynamic-pollster.rst | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/source/admin/telemetry-dynamic-pollster.rst b/doc/source/admin/telemetry-dynamic-pollster.rst index 9ac51f5f..90254f3b 100644 --- a/doc/source/admin/telemetry-dynamic-pollster.rst +++ b/doc/source/admin/telemetry-dynamic-pollster.rst @@ -978,6 +978,13 @@ project name, domain ID, and domain name. "locked": "dynamic_locked" "tags | ','.join(value)": "dynamic_tags" extra_metadata_fields_cache_seconds: 3600 + extra_metadata_fields_skip: + - value: '1' + metadata: + dynamic_flavor_vcpus: 4 + - value: '1' + metadata: + dynamic_flavor_vcpus: 2 extra_metadata_fields: - name: "project_name" endpoint_type: "identity" @@ -1060,4 +1067,10 @@ The metadata enrichment feature has the following options: dynamic pollster configuration is not set in the `extra_metadata_fields`, will be used the parent pollster configuration, except the `name`. +* ``extra_metadata_fields_skip``: optional parameter. This option is a list + of objects or a single one, where each one of its elements is a set of + key/value pairs. When defined, if any set of key/value pairs is a subset + of the collected sample, then the extra_metadata_fields gathering of this + sample will be skipped. + |