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

[Log Explorer] Add specialized locators #158382

Closed
weltenwort opened this issue May 24, 2023 · 10 comments
Closed

[Log Explorer] Add specialized locators #158382

weltenwort opened this issue May 24, 2023 · 10 comments
Assignees
Labels
Feature:LogsExplorer Logs Explorer feature Team:Infra Monitoring UI - DEPRECATED DEPRECATED - Label for the Infra Monitoring UI team. Use Team:obs-ux-infra_services

Comments

@weltenwort
Copy link
Member

weltenwort commented May 24, 2023

📓 Summary

The Discover locators will already include a key to choose the customization profile. In order to support passing data specific to the log explorer profile in a type-safe way, though, we could implement custom locators that wrap the Discover locator.

✔️ Acceptance criteria

  • There is a locator that accepts the same arguments as the Discover App locator except that...
    • the properties savedSearchId, dataViewId, indexPatternId, dataViewSpec, Profile are removed
    • properties to specify the integration name and the data stream name are added
    • properties to indicate the origin of the navigation are added if it takes places as part of a workflow
  • The origin value is a union of objects with...
    • an id to describe the workflow and/or step that initiated the navigation. This is the tag of the union.
    • any properties appropriate for the given id, might be none at all.
  • Valid origin ids (for now) are:
    • new-integration without additional properties: for use at the end of the of an on-boarding workflow
    • new-route with properties for the source integration name and source data stream name: for use at the end of a re-routing workflow
  • The targeted profile is always the log explorer profile.
  • Wire up the usage of the new locator to the Explore Logs Button at the end of the onboarding flow.

💡 Implementation hints

For inspiration/illustration purposes:

type DiscoverAppLogProfileLocatorOrigin =
  | {
    id: 'new-integration';
  }
  | {
    id: 'new-route';
    sourceIntegrationName: string;
    sourceDatastreamName: string;
  }
@botelastic botelastic bot added the needs-team Issues missing a team label label May 24, 2023
@weltenwort weltenwort added the Team:Infra Monitoring UI - DEPRECATED DEPRECATED - Label for the Infra Monitoring UI team. Use Team:obs-ux-infra_services label May 24, 2023
@elasticmachine
Copy link
Contributor

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

@yngrdyn
Copy link
Contributor

yngrdyn commented Jun 12, 2023

The integration id could be enough @weltenwort?
@gbamparop, @ogupte do you foresee which params we would need to pass to the locator?

@weltenwort
Copy link
Member Author

weltenwort commented Jun 12, 2023

An integration could have multiple data streams of type logs. Would the on-boarding workflow be able to also provide the data stream name or does the log explorer profile need to choose one (randomly)?

@gbamparop
Copy link
Contributor

@gbamparop, @ogupte do you foresee which params we would need to pass to the locator?

When the onboarding succeeds and we have identified that logs are being ingested (issue), there will be a success message in Discover. This seems to need an additional parameter.

@weltenwort
Copy link
Member Author

there will be a success message in Discover

@gbamparop indeed, I was thinking that it could derive the correct message from the origin id that is passed. Does that make sense?

@gbamparop
Copy link
Contributor

gbamparop commented Jun 12, 2023

@gbamparop indeed, I was thinking that it could derive the correct message from the origin id that is passed. Does that make sense?

Is the idea to have a new prop as per below?

any properties appropriate for the given id, might be none at all.

There's also the feedback link in Discover.

image

@weltenwort
Copy link
Member Author

If the feedback link would change dynamically based on the specific on-boarding workflow we might need to pass a specific property. But if the feedback link is always the same the log explorer can show it whenever the user comes here with a new-integration origin.

@gbamparop
Copy link
Contributor

If the feedback link would change dynamically based on the specific on-boarding workflow we might need to pass a specific property. But if the feedback link is always the same the log explorer can show it whenever the user comes here with a new-integration origin.

@grabowskit will we have more than one feedback forms?

@weltenwort weltenwort self-assigned this Jun 21, 2023
@weltenwort weltenwort changed the title Add specialized locators for the log explorer [Log Explorer] Add specialized locators Jun 23, 2023
@weltenwort weltenwort removed their assignment Jun 29, 2023
@mohamedhamed-ahmed mohamedhamed-ahmed self-assigned this Jul 27, 2023
@mohamedhamed-ahmed
Copy link
Contributor

mohamedhamed-ahmed commented Aug 3, 2023

@weltenwort As agreed we will keep the implementation of the DiscoverAppLogProfileLocatorOrigin interface for later as it is not going to be used at the moment. I also update the description as agreed.

@weltenwort
Copy link
Member Author

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

Successfully merging a pull request may close this issue.

5 participants