Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Logs UI][Test plan] Log stream page #92382

Closed
39 tasks done
afgomez opened this issue Feb 23, 2021 · 6 comments
Closed
39 tasks done

[Logs UI][Test plan] Log stream page #92382

afgomez opened this issue Feb 23, 2021 · 6 comments
Assignees
Labels
Feature:Logs UI Logs UI feature Team:Infra Monitoring UI - DEPRECATED DEPRECATED - Label for the Infra Monitoring UI team. Use Team:obs-ux-infra_services test-plan

Comments

@afgomez
Copy link
Contributor

afgomez commented Feb 23, 2021

Summary

This test plan intends to cover the integration between the UI and the APIs in the log stream page. They cover all the different ways the users could use the tool.

Prerequisites

  • Download the BC of elasticsearch, kibana, and filebeat.
  • Start only kibana and elasticsearch.

Test cases

With no valid or non existing indices

When the user goes to the logs app:

  • It loads a setup page
  • The CTA to change source goes to the settings page
  • The CTA to setup instructions goes to the "Add Data" page

With an existing but empty index

  • From the kibana dev tools, add an index that matches the filebeat-* pattern.
PUT /filebeat-test-empty

When the user goes to the logs app

  • It shows the UI with an empty stream and a "Check for new data" button
  • The "Check for new data" button calls the API (check in the network tool in your browser)

With data

  • Enable the system module in filebeat
  • Start filebeat to load data.

Stream view

When the app loads:

  • The log stream has logs up until the current time.
  • The datepicker shows "Last 1 day".
  • The minimap shows a histogram of log lines up to the current time.
  • The URL changes its position:(time) to the current timestamp.

When the user scrolls in any direction

  • The URL updates its position to the timestamp and tiebreaker of the visibly centered log line.
  • The minimap highlighted area updates (this is hard to see if you have a lot of log lines).

When the user scrolls to the very top:

  • if there are more entries, the UI fetches them
  • If there are no more entries, the UI gives feedback to the user

When the user scrolls to the very bottom:

  • If there are more entries, the UI fetches them.
  • If there are no more entries, the UI shows a "stream live" button.

Datepicker

When the user picks a new range that doesn't contain the current range (i.e. from 1 day ago to 1 hour ago)

  • The log stream resets
  • The minimap shows the new range

When the user picks a new range that contains the current range (i.e. from 1 hour to 2 hours)

  • The log stream doesn't reset.
  • The minimap shows the new range.

Minimap

When the user clicks on the minimap

  • The minimap cursor goes to the selected date/time
  • The log stream shows logs in that date/time

Filter

When the user types an arbitrary word.

  • The autocompletion suggests field names that start with the typed characters.
  • The backend searches in all message fields
  • The log stream contains only messages with the word
  • The log summary shows the histogram of messages with the word

When the user uses a KQL filter (i.e. event.dataset: nginx.access)

  • After typing a keyword field name followed by :, the autocompletion suggests terms from that field.
  • The backend applies the filter.
  • The log stream contains only messages from the filter.
  • The log summary shows the histogram of messages with the filter

When the user clicks on the minimap while a filter is active.

  • The filter stays.

When the user selects a new time in the date picker.

  • The filter stays.

Highlights

When the user adds a highlight term

  • The UI shows all messages
  • The UI highlights the word in the messages
  • The minimap shows the position of the highlights

When the user clicks on "previous" highlight.

  • The log stream jumps to the previous occurence of the highlights.
  • The cursor of the minimap moves.

When the user clicks on "next" highlight.

  • The log stream jumps to the next occurence of the highlights.
  • The cursor of the minimap moves.

When the user clicks on the minimap on a highlight marker

  • The log stream jumps to a highlighted message within that date/time
@afgomez afgomez added Feature:Logs UI Logs UI feature Team:Infra Monitoring UI - DEPRECATED DEPRECATED - Label for the Infra Monitoring UI team. Use Team:obs-ux-infra_services test-plan labels Feb 23, 2021
@elasticmachine
Copy link
Contributor

Pinging @elastic/logs-metrics-ui (Team:logs-metrics-ui)

@neptunian neptunian self-assigned this Mar 1, 2021
@neptunian
Copy link
Contributor

Tested locally on BC2 of Kibana, Filebeat, and ES

  • For "The CTA to setup instructions goes to the help page", is that the same as the "Add Data" page? That is where the link takes me.

Screen Shot 2021-03-01 at 3 41 11 PM

  • If i select a range with no data, and then select a new time with data, the minimap updates but the log stream does not unless I click for new data. Should it update on its own?

Screen Shot 2021-03-01 at 4 14 06 PM

  • I don't seem to get any suggestions when typing in the filter

Screen Shot 2021-03-01 at 4 20 21 PM

  • I don't seem to be getting any autocompletion terms

Screen Shot 2021-03-01 at 4 23 40 PM

@afgomez
Copy link
Contributor Author

afgomez commented Mar 2, 2021

For "The CTA to setup instructions goes to the help page", is that the same as the "Add Data" page? That is where the link takes me.

This is correct.

For the rest of the issues, I'm busy with Fleet stuff today but I'll try to look into it

@Kerry350
Copy link
Contributor

Kerry350 commented Mar 2, 2021

@afgomez

If i select a range with no data, and then select a new time with data, the minimap updates but the log stream does not unless I click for new data.

This one is related to #92215 (comment). It's the issue with the async searches not firing. I'm working on a fix, so please ignore that one.

@neptunian
Copy link
Contributor

I tested on BC3 and auto completion seems to be working fine now

@simianhacker
Copy link
Member

Looks like the data stream is working now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature:Logs UI Logs UI feature Team:Infra Monitoring UI - DEPRECATED DEPRECATED - Label for the Infra Monitoring UI team. Use Team:obs-ux-infra_services test-plan
Projects
None yet
Development

No branches or pull requests

5 participants