summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Merge "Update the installation guide for RHEL8/CentOS8"Zuul2022-12-203-7/+7
|\
| * Update the installation guide for RHEL8/CentOS8Taketani Ryo2022-10-283-7/+7
| | | | | | | | | | | | | | | | The openstack Ussuri and Victoria versions no longer support the RHEL7/CentOS7 and python2 environment packages. Correct the problems in the latest installation document for RDO. Change-Id: Ie03815f25d3a9ec99506a9dc14810a6800d3c42c
* | Merge "Add extra metadata fields skip"Zuul2022-10-111-0/+13
|\ \
| * | Add extra metadata fields skipPedro Henrique2022-09-131-0/+13
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* | | Merge "Add support to host command dynamic pollster definitions"Zuul2022-10-111-46/+105
|\ \ \ | |/ /
| * | Add support to host command dynamic pollster definitionsPedro Henrique2022-09-131-46/+105
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Problem description =================== Today we have some hardcoded pollsters that are gathering data from running virtual machines through libvirt or different programs running in the compute nodes. However, the Dynamic pollster definition does not support this kind of operations to gather data, it only supports HTTP Rest requests to collect data. Therefore, it is not possible to use the dynamic pollster definition to create a YML based pollster that runs and collects data from Libvirt in the compute nodes. Proposal ======== To allow host commands/scripts in the Dynamic pollsters, we propose to add a new pollster definition using the `os.subprocess` lib to run host commands to collect Host/VMs data and store them in the configured backend. This will provide more flexibility and make the Dynamic pollsters able to be used in Ceilometer compute instances as well. Change-Id: I50b8dc341ce457780416b41d138e35f5a0d083b6 Depends-On: https://review.opendev.org/c/openstack/ceilometer/+/850253
* | | Merge "Add response handlers to support different response types"Zuul2022-10-111-1/+112
|\ \ \ | |/ /
| * | Add response handlers to support different response typesPedro Henrique2022-09-011-1/+112
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Problem description =================== The dynamic pollsters only support APIs that produce JSON responses. Therefore the dynamic pollsters do not support APIs where the response is an XML or not Restful compliant APIs with HTTP 200 within a plain text message on errors. Proposal ======== To allow the dynamic pollsters to support other APIs response formats, we propose to add a response handling that supports multiple response types. It must be configurable in the dynamic pollsters YAML. The default continues to be JSON. Change-Id: I4886cefe06eccac2dc24adbc2fad2166bcbfdd2c
* | | Add support to namespaces on dynamic pollstersPedro Henrique2022-09-161-0/+5
| |/ |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Problem description =================== The hardcoded pollsters are defined by namespaces, so they are instantied based on the namespaces provided to the 'AgentManager'. The dynamic pollsters, on the other hand, are always instantied, independent of the provided namespaces. Proposal ======== To allow operators to define in which namespaces the dynamic pollster will be deployed, we propose to add a new configuration 'namespaces' in the dynamic pollsters yaml configuration. This configuration will support a single entry or a list of the namespaces that the pollster must be instantiated. Change-Id: I39ba0c3dd312a0601e02f8cfcab7a44e585a8a7f
* | Merge "Remove unicode prefixes"Zuul2022-08-221-11/+11
|\ \
| * | Remove unicode prefixesTakashi Kajinami2022-08-071-11/+11
| |/ | | | | | | | | | | | | A unicode prefix is meaningless in Python 3. Because now ceilometer supports only Python 3, we can remove the prefix. Change-Id: I7bc91be21df646d8bbc7793eec28a93179a3eefa
* | Merge "Remove GenericHardwareDeclarativePollster"Zuul2022-08-123-117/+4
|\ \ | |/ |/|
| * Remove GenericHardwareDeclarativePollsterTakashi Kajinami2022-07-013-117/+4
| | | | | | | | | | | | | | | | | | ... and discovery/inspector plugins depending on the pollster. These were implemented to gather metrics via SNMP daemon in TripleO-managed deployment but these are no longer valid since Telemetry services and Nova were removed from undercloud. Change-Id: If9a6b695ba799c766314a88328ea8a779407acc0
* | Remove support for neutron-lbaasTakashi Kajinami2022-06-081-93/+0
|/ | | | | | | | | | ... because it is of no use since neutron-lbaas was retired and was replaced by Octavia. This feature was officially deprecated during Yoga cycle[1] so we are ready to remove it. [1] 8917c73964eb764c3c4beb65d3713b36938181dd Change-Id: Ic145c23cc0b0372ef78f4a45ffb084bec24936c3
* OpenStack Dynamic pollsters metadata enrichment with other OpenStack API's dataRafael Weingärtner2022-01-201-0/+145
| | | | | | | | | | | | | | | | | | | | | | | Sometimes we want/need to add/gather extra metadata for the samples being handled by Ceilometer Dynamic pollsters, such as the project name, domain id, domain name, and other metadata that are not always accessible via the OpenStack component where the sample is gathered. For instance, when gathering the status of virtual machines (VMs) from Nova, we only have the tenant_id, which must be used as the project_id. However, for billing and later invoicing one might need/want the project name, domain id, and other metadata that are available in Keystone (and maybe some others that are scattered over other components). To achieve that, one can use the OpenStack metadata enrichment option. This feature is only available to OpenStack pollsters, and can only gather extra metadata from OpenStack APIs. This patch introduces a new option in the OpenStack Dynamic pollsters, that enable operators to enrich sample's metadata with information that can be captured in other OpenStack APIs such as Keystone, Nova, Neutron, and many others. Change-Id: I079bf26cf26fcbcf678dba10469516a1dcb52c0d
* Add the describe of uWSGI to run Gnocchi APIHan Guangyu2021-09-174-3/+53
| | | | | | | | | | | | | | Gnocchi API coundn't be use if we don't install and configure uwsgi or other HTTP daemon. And gnocchi install guide didn't describe those. Add the describe of installing uWSGI and the brief relationship between uWSGI and Gnocchi API. And tell the reader that they can also use Apache httpd and mod_wsgi, or any other HTTP daemon to run Gnocchi API. Closes-Bug: #1750933 Change-Id: Iba8c1fe7a64569de4ca366251c495731a8d7a779
* Moving IRC network reference to OFTCGhanshyam Mann2021-07-071-1/+1
| | | | Change-Id: I44fa70d4f572e013a88762cdff45ab6c5375d2a7
* Remove references to Ocata and NewtonMatthias Runge2021-06-181-12/+0
| | | | | | from the docs. Change-Id: Ic017be5aeb605dd7b5b2723b111337a8611e43bd
* Merge "Introduce `timeout` in dynamic pollsters sub-system"Zuul2021-06-141-0/+8
|\
| * Introduce `timeout` in dynamic pollsters sub-systemRafael Weingärtner2021-05-071-0/+8
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This patch introduces a new option for the dynamic pollsters' sub-system to define the request timeout for requests executed by the dynamic pollsters. The default timeout value will be 30 seconds. If it (the timeout option) is set to `None`, this means that the request never times out on the client-side. Therefore, one might have problems if the server never closes the connection. The pollsters are executed serially, one after the other; if the request hangs, all pollsters (including the non-dynamic ones) will stop executing. This option is being introduced after a failure that we had when using the dynamic pollsters; one of the APIs did not respond, and the server did not close the connection of the request, which made Ceilometer dynamic pollsters stop gathering data. To avoid such a situation, we recommend the community review and merge this patch. Change-Id: I4735f20d75d329ccafc797fe285d9fef579f593e
* | Remove dependency to pankoMatthias Runge2021-05-182-9/+0
|/ | | | | | Panko is being deprecated and removed from OpenStack. Change-Id: I6948a965cba5e3bdba84edbbb49af279fd0310e5
* Statement about complex object handling in the Dynamic pollster documentationRafael Weingärtner2020-09-041-12/+19
| | | | Change-Id: Iae1b317db25a8c3b6e9f8400c572cc653367d4c9
* Enable processing metadata with nested objectsRafael Weingärtner2020-07-221-1/+3
| | | | | Depends-On: https://review.opendev.org/#/c/709807/ Change-Id: Id108a7cd7bf356156b68324c3d033037a84869fc
* Add support to the use of headers in the dynamic pollstersRafael Weingärtner2020-07-221-0/+10
| | | | | Depends-On: https://review.opendev.org/#/c/709807/ Change-Id: I3ec151b8807d0dd3e529bb449d22fa68c8c810ee
* Allow operations on Ceilometer dynamic pollster to reference the sample itselfRafael Weingärtner2020-07-211-2/+7
| | | | | | | | | | | | | This issue is to allow operators to create expressions that can reference the sample itself. Currently, the expression is allowed only for fields in the sample, and not the sample itself. We discovered this requirement when developing pollsters for Cinder; the attribute `volume_image_metadata` is not returned in the API response when it does not exist, therefore, we need a method to check if it exist before trying to retrieve it. Change-Id: I5d3eb04534afaeb556ddab4ef603a205745883b8
* Merge "Enable OpenStack pollster to configure Ids(project, user, and resource)"Zuul2020-07-221-14/+16
|\
| * Enable OpenStack pollster to configure Ids(project, user, and resource)Rafael Weingärtner2020-05-291-14/+16
| | | | | | | | | | | | | | | | | | This pull request enables OpenStack pollsters to configure Ids(project, user, and resource) as the non-openstack pollster. This is useful as some of the OpenStack APIs use other keys to represent values such as project_id and user_id. Change-Id: Id5ae1720ad714675722bc857a142d7bd667fe7ed
* | Merge "Added missing Ceilometer configuration step for controller in docs."Zuul2020-07-212-1/+17
|\ \
| * | Added missing Ceilometer configuration step for controller in docs.prankul2020-06-192-1/+17
| | | | | | | | | | | | | | | | | | | | | Co-Authored-By: Rafael Weingärtner <rafael@apache.org> Change-Id: I7f614624ab732be4919298ce23de192555a7fb18 Reference: https://docs.openstack.org/ceilometer/latest/install/install-base-ubuntu.html Closes-bug: #1802918
* | | Merge "Remove glance-registry from docs"Zuul2020-07-213-9/+5
|\ \ \
| * | | Remove glance-registry from docsgugug2020-07-073-9/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | glance-registry service was deprecated in Queens release and has been removed in Victoria [1]. [1] https://review.opendev.org/#/c/738671/ Change-Id: Ib33a3f49647d86fae826f416825a85433730b391
* | | | Fix dynamic pollster samples indentation in the documentationRafael Weingärtner2020-07-031-52/+49
|/ / / | | | | | | | | | Change-Id: I2c07bf43d1a230c0a6bf48755d91d41c64abc9ea
* | | Merge "Drop undefined doc config path"Zuul2020-07-031-1/+1
|\ \ \
| * | | Drop undefined doc config pathHervé Beraud2020-06-091-1/+1
| | |/ | |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | html_static_path doesn't exist and the following warning is present in logs: ``` WARNING: html_static_path entry '_static' does not exist ``` These changes drop this config. Change-Id: I5ca35d1658c8734dd74d1c4dd16a8516f16c39b6
* | | Fix PDF buildAndreas Jaeger2020-06-221-4/+6
|/ / | | | | | | | | | | | | Do not include ceilometer.conf.sample since PDF building fails with the large file. This fix PDF building of openstack-tox-docs job. Change-Id: Idaf811f71bab0b49de5b68a6a69a7872cb481ffb
* | Merge "Add support to linked samples responses"Zuul2020-05-291-4/+136
|\ \
| * | Add support to linked samples responsespedro2020-02-251-4/+136
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Some APIs split their responses into pages and each response has a link to the next one. To allow operators to deal with this kind of APIs, we propose to extend the Dynamic pollsters to navigate through the API responses and join all responses into a single one. To enable it, the operator will need to configure the parameter `next_sample_url_attribute` with a mapper to the response's next page attribute. Change-Id: Ida0a73d2964f192e6c63a6b7e8003ef2b52bd710
* | | Switch to newer openstackdocstheme and reno versionsAndreas Jaeger2020-05-212-12/+9
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using these versions will allow especially: * Linking from HTML to PDF document * Allow parallel building of documents * Fix some rendering problems Update Sphinx version as well. Set openstackdocs_pdf_link to link to PDF file. Note that the link to the published document only works on docs.openstack.org where the PDF file is placed in the top-level html directory. The site-preview places the PDF in a pdf directory. Disable openstackdocs_auto_name to use 'project' variable as name. Change pygments_style to 'native' since old theme version always used 'native' and the theme now respects the setting and using 'sphinx' can lead to some strange rendering. openstackdocstheme renames some variables, so follow the renames before the next release removes them. A couple of variables are also not needed anymore, remove them. See also http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html Change-Id: Ieaaff8278e93f85bd711a340f9621ae18841e720
* | | Cleanup py27 supportzhurong2020-04-111-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Make a few cleanups: - Remove python 2.7 stanza from setup.py - Add requires on python >= 3.6 to setup.cfg so that pypi and pip know about the requirement - Remove obsolete sections from setup.cfg: * Wheel is not needed for python 3 only repo * Some other sections are obsolete - Update classifiers - Update requirements, no need for python_version anymore Change-Id: I93294c42a967ca19b9b04ead9cd636b52f1cc038
* | | Fix docs build errorzhurong2020-04-112-5/+5
|/ / | | | | | | Change-Id: I25558ff48b6236773f765aad8d1fc150f7011aef
* | Multi metric dynamic pollsters (handling attribute values with list of objects)rwe2020-02-201-0/+207
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The initial idea for this feature comes from the `categories` fields that we can find in the `summary` object of the RadosGW API. Each user has a `categories` attribute in the response; in the `categories` list, we can find the object that presents ain a granular fashion the consumption of different RadosGW API operations such as GET, PUT, POST, and may others. In that context, and having in mind that we have APIs with similar data structures, we developed an extension for the dynamic pollster that enables multi-metric processing for a single pollster. It works as follows. The pollster name will contain a placeholder for the variable that identifies the "submetric". E.g. `dynamic.radosgw.api.request.{category}`. The placeholder `{category}` indicates the object attribute that is in the list of objects that we use to load the sub metric name. Then, we must use a special notation in the `value_attribute` configuration to indicate that we are dealing with a list of objects. This is achieved via `[]` (brackets); for instance, in the `dynamic.radosgw.api.request.{category}`, we can use `[categories].ops` as the `value_attribute`. This indicates that the value we retrieve is a list of objects, and when the dynamic pollster processes it, we want it (the pollster) to load the `ops` value for the sub metrics being generated Depends-On: https://review.opendev.org/#/c/694519/ Change-Id: I6ed4632f209ac51a07687476ca316212659d72bb Signed-off-by: Rafael Weingärtner <rafael@apache.org>
* | Merge "Remove mention of meter_dispatchers"Zuul2020-02-101-2/+1
|\ \
| * | Remove mention of meter_dispatchersPierre Riteau2020-01-221-2/+1
| | | | | | | | | | | | | | | | | | This option was removed during the Queens cycle. Change-Id: Iea324cb3da91057ce3efd45068753bf1da72f39d
* | | Update links to Gnocchi websitePierre Riteau2020-01-247-7/+7
|/ / | | | | | | Change-Id: I58c1d2076fc8aa612811a10ce2a52db7a708a57d
* | Merge "[ussuri][goal] Drop python 2.7 support and testing"Zuul2019-12-091-1/+0
|\ \
| * | [ussuri][goal] Drop python 2.7 support and testingGhanshyam Mann2019-11-261-1/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | OpenStack is dropping the py2.7 support in ussuri cycle. ceilometer is ready with python 3 and ok to drop the python 2.7 support. Complete discussion & schedule can be found in - http://lists.openstack.org/pipermail/openstack-discuss/2019-October/010142.html - https://etherpad.openstack.org/p/drop-python2-support Ussuri Communtiy-wide goal: https://governance.openstack.org/tc/goals/selected/ussuri/drop-py27.html Depends-On: https://review.opendev.org/#/c/693631/ Change-Id: Ie8523712ea2ebe828fe01a649b6add90e813608b
* | | Dynamic pollsters: enable operation on attributesRafael Weingärtner2019-11-261-3/+50
|/ / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This PR enables the use of python operation to transform the attributes that are extracted in the JSON response that the Dynamic pollster handle. By enabling operators to define transformations on the fly, we can provide even more flexibility for the dynamic pollsters' system. One example of use case is the RadosGW that uses <project_id$project_id> as the username. With this implementation, one can create configurations in the dynamic pollster to clean that variable. It is as simple as defining `resource_id_attribute: "user | value.split('$')[0].strip()"` The operations are separated by `|` symbol. The first element of the expression is the key to be retrieved from the JSON object. The other elements are operations that can be applied to the `value` variable. The value variable is the variable we use to hold the data. Depends-On: https://review.opendev.org/#/c/693088/ Change-Id: I9ee209410491b3f04259e1a5c62ac20461070ae1 Signed-off-by: Rafael Weingärtner <rafael@apache.org>
* | Dynamic pollster system to support non-OpenStack APIsRafael Weingärtner2019-11-181-4/+90
| | | | | | | | | | | | | | | | The goal of this PR is to add the support for non-OpenStack APIs into Ceilometer. An example of such API is the RadosGW usage API. Change-Id: If5e1c9bce9e2709746338e043b20d328d8fb4504
* | Merge "Add Monasca to supported measurement back ends"Zuul2019-11-021-0/+1
|\ \
| * | Add Monasca to supported measurement back endsWitek Bedyk2019-11-011-0/+1
| | | | | | | | | | | | Change-Id: I6fad56620bff10255339e767be950b921c5860fd
View Lorry Controller Status