Skip to content

[Logs+] End onboarding wizard in default discover#163218

Merged
mohamedhamed-ahmed merged 12 commits intoelastic:mainfrom
mohamedhamed-ahmed:163080-onboarding-wizard-ends-in-default-discover
Aug 7, 2023
Merged

[Logs+] End onboarding wizard in default discover#163218
mohamedhamed-ahmed merged 12 commits intoelastic:mainfrom
mohamedhamed-ahmed:163080-onboarding-wizard-ends-in-default-discover

Conversation

@mohamedhamed-ahmed
Copy link
Contributor

@mohamedhamed-ahmed mohamedhamed-ahmed commented Aug 4, 2023

closes #163080

📝 Summary

This PR navigates to default discover at the end of the onboarding flow for both custom and system workflows.
It also adds logs-* as the default dataview along with a preset filter for the intended dataset during the onboarding flow.

✅ Testing

  1. Navigate to the onboarding flow /app/observabilityOnboarding/
  2. Choose either System logs or Stream log files
  3. Go through the onboarding wizard
  4. Click the Explore logs button at the end
  5. Observe the DataView and Preset Filter after being navigated to Discover

🎥 Demo

Screen.Recording.2023-08-04.at.17.33.13.mov

@ghost
Copy link

ghost commented Aug 4, 2023

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

  • /oblt-deploy : Deploy a Kibana instance using the Observability test environments.
  • /oblt-deploy-serverless : Deploy a serverless Kibana instance using the Observability test environments.
  • run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

@mohamedhamed-ahmed mohamedhamed-ahmed added v8.10.0 Team:APM - DEPRECATED Use Team:obs-ux-infra_services. Team:Infra Monitoring UI - DEPRECATED DEPRECATED - Label for the Infra Monitoring UI team. Use Team:obs-ux-infra_services release_note:skip Skip the PR/issue when compiling release notes backport:skip This PR does not require backporting labels Aug 4, 2023
@mohamedhamed-ahmed mohamedhamed-ahmed marked this pull request as ready for review August 5, 2023 05:47
@mohamedhamed-ahmed mohamedhamed-ahmed requested a review from a team August 5, 2023 05:47
@elasticmachine
Copy link
Contributor

Pinging @elastic/apm-ui (Team:APM)

@elasticmachine
Copy link
Contributor

Pinging @elastic/infra-monitoring-ui (Team:Infra Monitoring UI)

@yngrdyn
Copy link
Contributor

yngrdyn commented Aug 7, 2023

For system logs, the datasets are system.auth and system.syslog. Maybe you'll need to get the latest version in master.

Screenshot 2023-08-07 at 11 12 08

I need to work on installing the system integration, wouldn't make more sense then to land in the integration view when finishing the system logs onboarding?

@mohamedhamed-ahmed
Copy link
Contributor Author

mohamedhamed-ahmed commented Aug 7, 2023

For system logs, the datasets are system.auth and system.syslog. Maybe you'll need to get the latest version in master.

Doesn't matter in the scope of the PR as I actually read whatever dataset is created there, but what you are saying is absolutely correct as when I got latest it changes the name of the selected dataset 👍 Thanks for pointing out that this changed already 😊 was really confusing during testing

I need to work on installing the system integration, wouldn't make more sense then to land in the integration view when finishing the system logs onboarding?

integration view is part of the log-explorer profile, and as for the scope of 8.10 we agreed on making the navigation always point to the default discover view and not the log-explorer profile one.
After 8.10 we are planning to continue working on this ticket which will then apply the changes you suggested, and will point to the integration view.
@weltenwort please correct me if I missed something here.

One more question, to make sure I got it correct does this mean we have 2 datasets in case of system logs that we need to filter on with an or condition, but always a single dataset in case of the custom logs?

@gbamparop
Copy link
Contributor

Is it navigating to default discover for serverless projects too?

@yngrdyn
Copy link
Contributor

yngrdyn commented Aug 7, 2023

One more question, to make sure I got it correct does this mean we have 2 datasets in case of system logs that we need to filter on with an or condition, but always a single dataset in case of the custom logs?

yes, since for the system logs we are the ones defining the dataset we have those two (as we already have when using fleet), for custom logs is the user who defines the dataset so they will end up having just one even when they configure multiple paths.

@mohamedhamed-ahmed
Copy link
Contributor Author

Is it navigating to default discover for serverless projects too?

yes its always pointing to default discover in 8.10

Copy link
Contributor

@yngrdyn yngrdyn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🧙🏼‍♂️

@kibana-ci
Copy link

💚 Build Succeeded

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id before after diff
observabilityOnboarding 74 109 +35

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id before after diff
observabilityOnboarding 107.1KB 277.9KB +170.8KB

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id before after diff
observabilityOnboarding 4.6KB 4.6KB +54.0B

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

@mohamedhamed-ahmed mohamedhamed-ahmed merged commit a42df25 into elastic:main Aug 7, 2023
bryce-b pushed a commit to bryce-b/kibana that referenced this pull request Aug 9, 2023
closes [elastic#163080](elastic#163080)


## 📝  Summary

This PR navigates to default discover at the end of the onboarding flow
for both custom and system workflows.
It also adds `logs-*` as the default dataview along with a preset filter
for the intended dataset during the onboarding flow.

## ✅  Testing

1. Navigate to the onboarding flow `/app/observabilityOnboarding/`
2. Choose either System logs or Stream log files
3. Go through the onboarding wizard
4. Click the Explore logs button at the end
5. Observe the DataView and Preset Filter after being navigated to
Discover

## 🎥 Demo


https://github.com/elastic/kibana/assets/11225826/5eff74e4-c12a-46e7-968a-6efa34a6a7a9

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
mohamedhamed-ahmed added a commit that referenced this pull request Sep 20, 2023
closes #164995
closes #165618
closes #166596

## 📝  Summary

### Observability Log Explorer Locators:

This PR adds 2 new customized locators to the Observability log explorer
profile. At the moment we implemented:

       1- Single dataset selector locator
       2- All dataset selector locator

With more locators to come in the future depending on the use cases.

### Log Explorer Locators:

We also added a log explorer locator that navigates to discover, this
can be used in case the **Observability Log Explorer** plugin is
disabled.

### Logs Onboarding:

The PR also replaces the temp navigation to the default discover we
implemented for[ 8.10
here](#163218) with the above new
Observability Log Explorer locators.

### APM:

After [disabling infra plugin in serverless
projects](#165289), APM links to
infra locators in serverless have been replaced to use the above
locators.

### Observability Landing Page:

The landing page now redirects to the Log Explorer if `logs-*-*` has
data in it, otherwise the flow continues as before.

### Necessary Refactoring:

To avoid the circular dependency between `ObservabilityLogExplorer` &
`ObservabilityOnboarding` after each one using the other's locator and
importing the necessary types, I moved the type definition for all
locators in the `deeplinks` package.

## ✅  Testing

- Onboarding Wizard in Serverless and Stateful

    1. Navigate to the onboarding flow `/app/observabilityOnboarding/`
    2. Choose either System logs or Stream log files
    3. Go through the onboarding wizard
    4. Click the Explore logs button at the end
5. You should be redirected to observability log explorer with the
integration and dataset preselected.

- APM links in Serverless

1. Navigate to APM and click on the logs links as shown in the Demos
below
2. All links should navigate to Observability Log Explorer with the
queries set in the search bar.

## 🎥 Demos

- APM Serverless


https://github.com/elastic/kibana/assets/11225826/7161364e-333f-4ac4-87d5-7f1ffec699b3


- APM Stateful


https://github.com/elastic/kibana/assets/11225826/058c9587-b766-4d4f-a73d-50fd381be4bb


- Onboarding Serverless



https://github.com/elastic/kibana/assets/11225826/ee1cab42-f91c-4558-aa5f-4fa7e8963427

- Onboarding Stateful



https://github.com/elastic/kibana/assets/11225826/a376a12b-499b-4488-a75a-d06e81f8e21d

- Observability Landing Page 



https://github.com/elastic/kibana/assets/11225826/c1c084ca-b1b1-4c4b-a4e6-ae8e157dcf57

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: Marco Antonio Ghiani <marcoantonio.ghiani@elastic.co>
Co-authored-by: Marco Antonio Ghiani <marcoantonio.ghiani01@gmail.com>
gergoabraham pushed a commit to gergoabraham/kibana that referenced this pull request Sep 21, 2023
closes elastic#164995
closes elastic#165618
closes elastic#166596

## 📝  Summary

### Observability Log Explorer Locators:

This PR adds 2 new customized locators to the Observability log explorer
profile. At the moment we implemented:

       1- Single dataset selector locator
       2- All dataset selector locator

With more locators to come in the future depending on the use cases.

### Log Explorer Locators:

We also added a log explorer locator that navigates to discover, this
can be used in case the **Observability Log Explorer** plugin is
disabled.

### Logs Onboarding:

The PR also replaces the temp navigation to the default discover we
implemented for[ 8.10
here](elastic#163218) with the above new
Observability Log Explorer locators.

### APM:

After [disabling infra plugin in serverless
projects](elastic#165289), APM links to
infra locators in serverless have been replaced to use the above
locators.

### Observability Landing Page:

The landing page now redirects to the Log Explorer if `logs-*-*` has
data in it, otherwise the flow continues as before.

### Necessary Refactoring:

To avoid the circular dependency between `ObservabilityLogExplorer` &
`ObservabilityOnboarding` after each one using the other's locator and
importing the necessary types, I moved the type definition for all
locators in the `deeplinks` package.

## ✅  Testing

- Onboarding Wizard in Serverless and Stateful

    1. Navigate to the onboarding flow `/app/observabilityOnboarding/`
    2. Choose either System logs or Stream log files
    3. Go through the onboarding wizard
    4. Click the Explore logs button at the end
5. You should be redirected to observability log explorer with the
integration and dataset preselected.

- APM links in Serverless

1. Navigate to APM and click on the logs links as shown in the Demos
below
2. All links should navigate to Observability Log Explorer with the
queries set in the search bar.

## 🎥 Demos

- APM Serverless


https://github.com/elastic/kibana/assets/11225826/7161364e-333f-4ac4-87d5-7f1ffec699b3


- APM Stateful


https://github.com/elastic/kibana/assets/11225826/058c9587-b766-4d4f-a73d-50fd381be4bb


- Onboarding Serverless



https://github.com/elastic/kibana/assets/11225826/ee1cab42-f91c-4558-aa5f-4fa7e8963427

- Onboarding Stateful



https://github.com/elastic/kibana/assets/11225826/a376a12b-499b-4488-a75a-d06e81f8e21d

- Observability Landing Page 



https://github.com/elastic/kibana/assets/11225826/c1c084ca-b1b1-4c4b-a4e6-ae8e157dcf57

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: Marco Antonio Ghiani <marcoantonio.ghiani@elastic.co>
Co-authored-by: Marco Antonio Ghiani <marcoantonio.ghiani01@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport:skip This PR does not require backporting release_note:skip Skip the PR/issue when compiling release notes Team:APM - DEPRECATED Use Team:obs-ux-infra_services. Team:Infra Monitoring UI - DEPRECATED DEPRECATED - Label for the Infra Monitoring UI team. Use Team:obs-ux-infra_services v8.10.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Logs+] End simplified on-boarding wizard in default Discover

6 participants