Bug 2187298
| Summary: | [DDF] Clarify pipeline publisher configuration in documentation | ||
|---|---|---|---|
| Product: | Service Telemetry Framework | Reporter: | Direct Docs Feedback <ddf-bot> |
| Component: | Documentation | Assignee: | mgeary <mgeary> |
| Status: | CLOSED ERRATA | QA Contact: | Alex Yefimov <ayefimov> |
| Severity: | low | Docs Contact: | mgeary <mgeary> |
| Priority: | low | ||
| Version: | 1.5 | CC: | ayefimov, lmadsen, lnatapov |
| Target Milestone: | z2 | Keywords: | Documentation, Triaged, ZStream |
| Target Release: | 1.5 (STF) | ||
| Hardware: | All | ||
| OS: | All | ||
| 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: | --- |
| Regression: | --- | Mount Type: | --- |
| Documentation: | --- | CRM: | |
| Verified Versions: | Category: | --- | |
| oVirt Team: | --- | RHEL 7.3 requirements from Atomic Host: | |
| Cloudforms Team: | --- | Target Upstream Version: | |
| Embargoed: | |||
|
Description
Direct Docs Feedback
2023-04-17 11:59:25 UTC
Proposed changes:
Create a configuration file called enable-stf.yaml in the /home/stack directory.
parameter_defaults:
# only send to STF, not other publishers.
# [red] Setting EventPipelinePublishers and PipelinePublishers to empty lists results in no event or metric data passing
# to RHOSP telemetry components, such as Gnocchi or Panko[red]
EventPipelinePublishers: []
PipelinePublishers: []
....
....
....
# [red] If you need to send data to additional pipelines, the Ceilometer polling interval of 30 seconds, as specified in ExtraConfig
# below, might overwhelm the RHOSP telemetry components, and you must increase the interval to a larger value, such as 300.
# Increasing the value to a longer polling interval results in less telemetry resolution in STF. [red]
ExtraConfig:
ceilometer::agent::polling::polling_interval: 30
ceilometer::agent::polling::polling_meters:
[IMPORTANT]
----
Setting EventPipelinePublishers and PipelinePublishers to empty lists results in no event or metric data passing to RHOSP telemetry components, such as Gnocchi or Panko.
If you need to send data to additional pipelines, the Ceilometer polling interval of 30 seconds, as specified in ExtraConfig, might overwhelm the RHOSP telemetry components, and you must increase the interval to a larger value, such as 300. Increasing the value to a longer polling interval results in less telemetry resolution in STF.
[source,bash,options="nowrap"]
ExtraConfig:
ceilometer::agent::polling::polling_interval: 300
[/source]
----
This message is in place:
[IMPORTANT]
====
Setting `EventPipelinePublishers` and `PipelinePublishers` to empty lists results in no event or metric data passing to {OpenStackShort} telemetry components, such as Gnocchi or Panko. If you need to send data to additional pipelines, the Ceilometer polling interval of `30` seconds, that you specify in `ExtraConfig`, might overwhelm the {OpenStackShort} telemetry components. You must increase the interval to a larger value, such as `300`, which results in less telemetry resolution in {ProjectShort}.
====
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 |