Bug 1869840 - [Docs][ELK] Update ELK integration KCS with correct links for RHV 4.4 installations
Summary: [Docs][ELK] Update ELK integration KCS with correct links for RHV 4.4 install...
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Enterprise Virtualization Manager
Classification: Red Hat
Component: Documentation
Version: 4.4.1
Hardware: Unspecified
OS: Unspecified
medium
medium
Target Milestone: ovirt-4.4.2
: ---
Assignee: Eli Marcus
QA Contact: Guilherme Santos
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2020-08-18 18:40 UTC by Marina Kalinin
Modified: 2023-09-18 00:22 UTC (History)
6 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2020-09-25 08:44:18 UTC
oVirt Team: Metrics
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Bugzilla 1871897 0 unspecified CLOSED Cannot create indexes on ELK instance by following step #5 on KCS https://access.redhat.com/articles/4921101 2023-12-15 18:59:22 UTC

Internal Links: 1698870 1871897 1881634

Description Marina Kalinin 2020-08-18 18:40:44 UTC
The solution for ELK integration:
https://access.redhat.com/articles/4921101

Step 7 references RHV 4.3 metrics store documentation.

We need to identify the correct steps for RHV 4.4 deployments, since metrics store is not being installed there, and update the documentation to match 4.4 as well.


If QE can confirm that RHV 4.3 steps are applicable to RHV 4.4 as well, we can leave it as is and simply add a note clarifying this fact.

Comment 1 Eli Marcus 2020-08-19 13:14:14 UTC
(In reply to Marina Kalinin from comment #0)
> The solution for ELK integration:
> https://access.redhat.com/articles/4921101
> 
> Step 7 references RHV 4.3 metrics store documentation.
> 
> We need to identify the correct steps for RHV 4.4 deployments, since metrics
> store is not being installed there, and update the documentation to match
> 4.4 as well.
> 
> 
> If QE can confirm that RHV 4.3 steps are applicable to RHV 4.4 as well, we
> can leave it as is and simply add a note clarifying this fact.

I think it might be best to add the entire "Using Dashboards" section to the article as a note/appendix section at the end of the article- 
but we need to know how to explain the Kibana setup - what is the default Kibana login URL? What is the default user name and password? 


 Importing Dashboard Examples
Note: The dashboard examples are only available after completing the procedure for Deploying collectd and rsyslog.

   1. Copy the /etc/ovirt-engine-metrics/dashboards-examples directory from the Manager virtual machine to your local machine.
   2. Log in to the Kibana console using the URL (https://kibana.example.com) that you recorded during the Metrics Store installation process. 
    Use the default admin user, and the password you defined during the installation.
   3. Open Kibana and click the Management tab.
   4. Click the Saved Objects tab.
   5. Click Import and import Searches from your local copy of /etc/ovirt-engine-metrics/dashboards-examples.

   6. Click Import and import Visualizations.
    Note: If you see an error message while importing the visualizations, check your hosts to ensure that collectd and rsyslog are running without errors.

   7. Click Import and import Dashboards.
    Note: If you are logged in as the admin user, you may see a message regarding missing index patterns while importing the visualizations. Select the project.* index pattern instead.

   8. Select an index pattern that begins with project.* in the Index Patterns pane and click the Refresh field list refresh button.

   9. Repeat for each index pattern that begins with project.*.

    The imported dashboards are now stored in the system. 

Loading Saved Dashboards

Once you have created and saved a dashboard, or imported Red Hat’s sample dashboards, you can display them in the Dashboard tab:

1. Click the Dashboards tab to display a list of saved dashboards.
2. Click a saved dashboard to load it.

Comment 2 Eli Marcus 2020-09-14 16:04:14 UTC
- Updated KCS with new instructions for the ELK index templates,
- Inserted entire Using Dashboard section from the Metrics Store User Guide in the KCS article 
- updated link for deploying rsyslog and collectd to point to chapter in RHV 4.4 Admin Guide (which is not yet re-published)

Comment 3 Eli Marcus 2020-09-17 13:40:15 UTC
Hi Marina, Peter, and Shirly, 
please check the updated KCS article -  https://access.redhat.com/articles/4921101 

here are the changes I made: 
- Updated KCS with new instructions for the ELK index templates,
- Inserted entire Using Dashboard section from the Metrics Store User Guide in the KCS article 
- updated link for deploying rsyslog and collectd to point to chapter in RHV 4.4 Admin Guide (which is not yet re-published)

Comment 4 Eli Marcus 2020-09-17 13:46:42 UTC
adding needinfo flag for Shirly and Guilherme

Comment 5 Guilherme Santos 2020-09-23 10:53:52 UTC
I'm verifying this considering the metrics (collectd/rsyslog) side. I'm mentioning that taking into consideration the comment regarding Index Alias, Lifecycle Policy, and enable ILM - as we only support RHV/rsyslog/collectd.
If people think that this part should be considered (maybe as a note or something), this can be reopen.

Comment 8 Red Hat Bugzilla 2023-09-18 00:22:01 UTC
The needinfo request[s] on this closed bug have been removed as they have been unresolved for 120 days


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