Note: This bug is displayed in read-only format because the product is no longer active in Red Hat Bugzilla.

Bug 2189678

Summary:	Clarify AMQ Interconnect topic configuration in STF guide (additional)
Product:	Service Telemetry Framework	Reporter:	Alex Yefimov <ayefimov>
Component:	Documentation	Assignee:	Leif Madsen <lmadsen>
Status:	CLOSED ERRATA	QA Contact:	Alex Yefimov <ayefimov>
Severity:	low	Docs Contact:	mgeary <mgeary>
Priority:	low
Version:	1.5	CC:	augol, ayefimov, lmadsen, mmagr, mrunge
Target Milestone:	z2	Keywords:	Documentation, Triaged, ZStream
Target Release:	1.5 (STF)
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:		Doc Type:	No Doc Update
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2023-06-22 19:06:01 UTC	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:
Bug Depends On:
Bug Blocks:	2196865

Description Alex Yefimov 2023-04-25 21:07:02 UTC

Description of problem:


In section 4.1.3.3 I see the following statements:

"Set <name>.topic to define the topic for <event-type> events. The format of this value is"

and

"Set <name> to define the topic for <event-type> events. The format of this value is"

Do both the above mean the same thing? If they are saying the same thing, then IMHO it may be best to use the same sentence structure for clarity sake. If they do not mean the same thing, then perhaps more information would help in understanding the differences between the two.

Comment 1 Alex Yefimov 2023-04-25 21:07:52 UTC

Doc URL => https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.2/html/service_telemetry_framework_1.5/assembly-installing-the-core-components-of-stf_assembly

Comment 2 Leif Madsen 2023-05-17 15:59:11 UTC

Related to 2187301 as well

Comment 3 Leif Madsen 2023-06-05 19:13:14 UTC

I think this issue is referring to collectd vs ceilometer. The reference is that Ceilometer has a sub-parameter called `topic` which is what is being referred to here.

CeilometerQdrMetricsConfig.topic means:

    CeilometerQdrMetricsConfig
      topic: <value>

But in the case of collectd, the value is a parameter itself, so we don't refer to `[...].topic`.

    CollectdAmqpInstances:
      <topic>

This is a fairly common occurrence throughout the documentation, and it feels weird to adjust this specifically in this section, but I've gone ahead and tried to add the additional verbiage.

Comment 10 errata-xmlrpc 2023-06-22 19:06:01 UTC

Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory (Release for Service Telemetry Framework 1.5.2), and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHEA-2023:3785