openstack
/
ceilometer
Code Issues Proposed changes

Fix dynamic pollster samples indentation in the documentation 

Change-Id: I2c07bf43d1a230c0a6bf48755d91d41c64abc9ea
This commit is contained in:
Rafael Weingärtner 2020-07-03 19:08:53 -03:00
parent 8ef38cd0bb
commit 49e9744f8d
1 changed files with 49 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

101
doc/source/admin/telemetry-dynamic-pollster.rst
View File

@ -218,22 +218,22 @@ desires):
--- ---
- name: "dynamic.network.services.vpn.connection" - name: "dynamic.network.services.vpn.connection"
sample_type: "gauge" sample_type: "gauge"
unit: "ipsec_site_connection" unit: "ipsec_site_connection"
value_attribute: "status" value_attribute: "status"
endpoint_type: "network" endpoint_type: "network"
url_path: "v2.0/vpn/ipsec-site-connections" url_path: "v2.0/vpn/ipsec-site-connections"
metadata_fields: metadata_fields:
- "name" - "name"
- "vpnservice_id" - "vpnservice_id"
- "description" - "description"
- "status" - "status"
- "peer_address" - "peer_address"
value_mapping: value_mapping:
ACTIVE: "1" ACTIVE: "1"
metadata_mapping: metadata_mapping:
name: "display_name" name: "display_name"
default_value: 0 default_value: 0
The dynamic pollsters system configuration (for non-OpenStack APIs) The dynamic pollsters system configuration (for non-OpenStack APIs)
------------------------------------------------------------------- -------------------------------------------------------------------
@ -288,18 +288,17 @@ for `radosgw.api.request` metric to the dynamic pollster model:
--- ---
- name: "dynamic.radosgw.api.request" - name: "dynamic.radosgw.api.request"
sample_type: "gauge" sample_type: "gauge"
unit: "request" unit: "request"
value_attribute: "total.ops" value_attribute: "total.ops"
url_path: "http://rgw.service.stage.i.ewcs.ch/admin/usage" url_path: "http://rgw.service.stage.i.ewcs.ch/admin/usage"
module: "awsauth" module: "awsauth"
authentication_object: "S3Auth" authentication_object: "S3Auth"
authentication_parameters: "<access_key>, <secret_key>, authentication_parameters: "<access_key>,<secret_key>,<rados_gateway_server>"
<rados_gateway_server>" user_id_attribute: "user"
user_id_attribute: "user" project_id_attribute: "user"
project_id_attribute: "user" resource_id_attribute: "user"
resource_id_attribute: "user" response_entries_key: "summary"
response_entries_key: "summary"
We can take that example a bit further, and instead of gathering the `total We can take that example a bit further, and instead of gathering the `total
.ops` variable, which counts for all the requests (even the unsuccessful .ops` variable, which counts for all the requests (even the unsuccessful
@ -310,18 +309,17 @@ ones), we can use the `successful_ops`.
--- ---
- name: "dynamic.radosgw.api.request.successful_ops" - name: "dynamic.radosgw.api.request.successful_ops"
sample_type: "gauge" sample_type: "gauge"
unit: "request" unit: "request"
value_attribute: "total.successful_ops" value_attribute: "total.successful_ops"
url_path: "http://rgw.service.stage.i.ewcs.ch/admin/usage" url_path: "http://rgw.service.stage.i.ewcs.ch/admin/usage"
module: "awsauth" module: "awsauth"
authentication_object: "S3Auth" authentication_object: "S3Auth"
authentication_parameters: "<access_key>, <secret_key>, authentication_parameters: "<access_key>, <secret_key>,<rados_gateway_server>"
<rados_gateway_server>" user_id_attribute: "user"
user_id_attribute: "user" project_id_attribute: "user"
project_id_attribute: "user" resource_id_attribute: "user"
resource_id_attribute: "user" response_entries_key: "summary"
response_entries_key: "summary"
Operations on extracted attributes Operations on extracted attributes
---------------------------------- ----------------------------------
@ -351,18 +349,17 @@ String.
--- ---
- name: "dynamic.radosgw.api.request.successful_ops" - name: "dynamic.radosgw.api.request.successful_ops"
sample_type: "gauge" sample_type: "gauge"
unit: "request" unit: "request"
value_attribute: "total.successful_ops" value_attribute: "total.successful_ops"
url_path: "http://rgw.service.stage.i.ewcs.ch/admin/usage" url_path: "http://rgw.service.stage.i.ewcs.ch/admin/usage"
module: "awsauth" module: "awsauth"
authentication_object: "S3Auth" authentication_object: "S3Auth"
authentication_parameters: "<access_key>, <secret_key>, authentication_parameters: "<access_key>,<secret_key>,<rados_gateway_server>"
<rados_gateway_server>" user_id_attribute: "user | value.split ('$') | value[0]"
user_id_attribute: "user | value.split ('$') | value[0]" project_id_attribute: "user | value.split ('$') | value[0]"
project_id_attribute: "user | value.split ('$') | value[0]" resource_id_attribute: "user | value.split ('$') | value[0]"
resource_id_attribute: "user | value.split ('$') | value[0]" response_entries_key: "summary"
response_entries_key: "summary"
The Dynamic pollster configuration options that support this feature are the The Dynamic pollster configuration options that support this feature are the
following: following: