summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorZuul <zuul@review.opendev.org>2019-11-01 04:19:26 +0000
committerGerrit Code Review <review@openstack.org>2019-11-01 04:19:26 +0000
commitf372d9ae8e8a2766439a6b54d8822bb380c15a05 (patch)
tree4686cf000575baf80470df820226070fc3eed02f /doc
parent7bb2f85645498bc05cb60a81a9174da0d72ae2f9 (diff)
parent126350c0ae609c5d35d54556883da2476e81e30e (diff)
downloadceilometer-f372d9ae8e8a2766439a6b54d8822bb380c15a05.tar.gz
Merge "publisher: Contribute the Monasca publisher"
Diffstat (limited to 'doc')
-rw-r--r--doc/source/admin/telemetry-data-pipelines.rst43
-rw-r--r--doc/source/contributor/architecture.rst7
2 files changed, 47 insertions, 3 deletions
diff --git a/doc/source/admin/telemetry-data-pipelines.rst b/doc/source/admin/telemetry-data-pipelines.rst
index 30366d04..48547ff6 100644
--- a/doc/source/admin/telemetry-data-pipelines.rst
+++ b/doc/source/admin/telemetry-data-pipelines.rst
@@ -213,6 +213,49 @@ The following customization options are available:
default topic defined by ``metering_topic`` and ``event_topic`` options.
This option can be used to support multiple consumers.
+monasca
+```````
+
+The monasca publisher can be used to send measurements to the Monasca API,
+where it will be stored with other metrics gathered by Monasca Agent. Data
+is accessible through the Monasca API and be transformed like other Monasca
+metrics.
+
+The pipeline sink is specified with a ``publishers:`` element of the form
+``- monasca://https://<your vip>/metrics/v2.0``
+
+Monasca API connection information is configured in the ceilometer.conf
+file in a [monasca] section::
+
+ [monasca]
+ auth_section = monasca_auth
+ enable_api_pagination = True
+ client_retry_interval = 60
+ client_max_retries = 5
+ monasca_mappings = <absolute path to monasca_field_definitions.yaml>
+
+ [monasca_auth]
+ auth_url = https://<vip to keystone instance>/identity
+ auth_type = password
+ username = <a Keystone user>
+ password = <password for user>
+ project_name = <project name, such as admin>
+ project_domain_id = <project domain ID, such as default>
+ user_domain_id = <user domain ID, such as default>
+ verify = <path to CA bundle in PEM format>
+ region_name = <region name, such as RegionOne>
+
+
+..note::
+ The username specified should be for a Keystone user that has the
+ ``monasca_agent`` or ``monasca_user`` role enabled. For management purposes,
+ this may be the ceilometer user if the appropriate role is granted.
+
+For more detail and history of this publisher, see the
+`Ceilosca Wiki <https://wiki.openstack.org/wiki/Ceilosca>`__ and
+`monasca-ceilometer README
+<https://github.com/openstack/monasca-ceilometer>`__.
+
udp
```
diff --git a/doc/source/contributor/architecture.rst b/doc/source/contributor/architecture.rst
index 8fc75109..f4d3b194 100644
--- a/doc/source/contributor/architecture.rst
+++ b/doc/source/contributor/architecture.rst
@@ -164,7 +164,7 @@ Publishing the data
This figure shows how a sample can be published to multiple destinations.
-Currently, processed data can be published using 8 different transports:
+Currently, processed data can be published using different transport options:
1. gnocchi, which publishes samples/events to Gnocchi API;
2. notifier, a notification based publisher which pushes samples to a message
@@ -174,8 +174,9 @@ Currently, processed data can be published using 8 different transports:
5. file, which publishes samples to a file with specified name and location;
6. zaqar, a multi-tenant cloud messaging and notification service for web and
mobile developers;
-7. https, which is http over SSL and targets a REST interface.
-8. prometheus, which publishes samples to Prometheus Pushgateway
+7. https, which is http over SSL and targets a REST interface;
+8. prometheus, which publishes samples to Prometheus Pushgateway;
+9. monasca, which publishes samples to the Monasca API.
Storing/Accessing the data