Bug 2140652 - [DOCS] [STF 1.4] Stf config examples misleading
Summary: [DOCS] [STF 1.4] Stf config examples misleading
Keywords:
Status: NEW
Alias: None
Product: Red Hat OpenStack
Classification: Red Hat
Component: documentation
Version: 16.2 (Train)
Hardware: Unspecified
OS: Unspecified
unspecified
low
Target Milestone: ---
: ---
Assignee: RHOS Documentation Team
QA Contact: RHOS Documentation Team
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2022-11-07 14:05 UTC by Luca Davidde
Modified: 2022-11-29 21:01 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed:
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Issue Tracker OSP-19925 0 None None None 2022-11-07 14:34:28 UTC

Description Luca Davidde 2022-11-07 14:05:39 UTC
Description of problem:
Hello, 
got a customer that followed the docs for configuring stf 1.4 [1]
and probably the docs are a little bit misleading in:

3 Define the topic for Ceilometer events. The format of this value is anycast/ceilometer/cloud1-event.sample.
4 Define the topic for Ceilometer metrics. The format of this value is`anycast/ceilometer/cloud1-metering.sample`.

He used ".sample" as well, but is wrong as the metrics and events don't work adding it.
So it would be better to change it into the docs by removing the ".sample" in the examples.

[1]https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.2/html/service_telemetry_framework_1.4/assembly-completing-the-stf-configuration_assembly

Version-Release number of selected component (if applicable):


How reproducible:


Steps to Reproduce:
1.
2.
3.

Actual results:
docs for configuring stf are a little misleading.

Expected results:
more clear docs.

Additional info:


Note You need to log in before you can comment on or make changes to this bug.