Bug 2140652

Summary: [DOCS] [STF 1.4] Stf config examples misleading
Product: Red Hat OpenStack Reporter: Luca Davidde <ldavidde>
Component: documentationAssignee: RHOS Documentation Team <rhos-docs>
Status: NEW --- QA Contact: RHOS Documentation Team <rhos-docs>
Severity: low Docs Contact:
Priority: unspecified    
Version: 16.2 (Train)CC: augol, mmagr, mrunge
Target Milestone: ---   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

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: