Bug 2173856 - Update documentation and dashboards to have events disabled by default
Summary: Update documentation and dashboards to have events disabled by default
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Service Telemetry Framework
Classification: Red Hat
Component: dashboarding
Version: 1.5
Hardware: Unspecified
OS: Unspecified
low
low
Target Milestone: z1
: 1.5 (STF)
Assignee: Leif Madsen
QA Contact: Alex Yefimov
mgeary
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2023-02-28 07:27 UTC by jiehuang
Modified: 2023-06-08 00:41 UTC (History)
4 users (show)

Fixed In Version:
Doc Type: Release Note
Doc Text:
Cause: The events datasource in Grafana is not available when events storage is not enabled. The default is for events storage to be disabled. Consequence: The virtual machine dashboard would throw warnings about a missing datasource due to it not being available by default due to usage by annotations. Workaround (if any): Disable the annotations on the virtual machine dashboard using the available switch. Result: Annotations are now disabled by default on the virtual machine dashboard to match the default deployment options in STF.
Clone Of:
Environment:
Last Closed: 2023-06-08 00:40:24 UTC
Target Upstream Version:
Embargoed:

Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Github infrawatch dashboards pull 53 0 None Merged Set VM dashboard annontation view off by default 2023-03-07 21:19:16 UTC
Github infrawatch documentation pull 451 0 None Merged Reference event enablement for virtual machine view 2023-03-07 21:20:03 UTC
Red Hat Issue Tracker STF-1265 0 None None None 2023-03-01 14:37:18 UTC

Description jiehuang 2023-02-28 07:27:26 UTC 
Description of problem:
My Customer missed enabling elasticsearch on the object[1], which is a very important place for stf monitor OpenStack instance. 

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


How reproducible:
N/A

Steps to Reproduce:
1.
2.
3.

Actual results:


Expected results:
Within a Note for that.[1]

Additional info:
[1]
https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.2/html-single/service_telemetry_framework_1.5/index#primary-parameters-of-the-servicetelemetry-object_assembly-installing-the-core-components-of-stf
Comment 1 Leif Madsen 2023-03-01 14:31:35 UTC 
Are you asking for the defaults to be changed from enabled: false to enabled: true so that Elasticsearch is enabled automatically by default?
Comment 8 Leif Madsen 2023-03-03 15:07:58 UTC 
Moving this to RELEASE_PENDING for the next STF 1.5 release after making changes calling out events storage usage in the documentation for the particular dashboard in question along with setting annotations off by default going forward.
Comment 12 Leif Madsen 2023-06-07 13:09:32 UTC 
Moving back to MODIFIED simply for release tracking and attachment purposes.
Comment 14 Leif Madsen 2023-06-08 00:40:24 UTC 
This shipped in STF 1.5.1 but was missed. Closing.
Note You need to log in before you can comment on or make changes to this bug.