[Logs+] Extract custom integration creation resources in to a package #163788
Assignees
Labels
Feature:Logs Onboarding
Logs Onboarding feature
Team:Infra Monitoring UI - DEPRECATED
DEPRECATED - Label for the Infra Monitoring UI team. Use Team:obs-ux-infra_services
Comments
Kerry350
added
Feature:Logs UI
|
Pinging @elastic/infra-monitoring-ui (Team:Infra Monitoring UI) |
Kerry350
added a commit
that referenced
this issue
Sep 12, 2023
## Summary This closes #163788. ## High level overview - Adds a new `kbn-custom-integrations` package. - This package adds a new top level custom integrations state machine, which manages a child create custom integration state machine. In the future we will have additional modes (such as adding a dataset to an existing integration, and various "uplift" flows). - Adds connected (to the machine) components that consumers can use to facilitate custom integration workflows. - Adds a `kbn-xstate-utils` package (as these utils were in 2 plugins and now 1 package). - Replaces the integration creation inside of the onboarding wizard flow with this package. - At the moment this is locked down to `logs`, and one dataset, but it can be easily extended in the future to support all types and multiple datasets. The state machine is ready, it just needs exposed in the UI. - Some thought has gone in to how this will work with multiple "modes", and the foundations are there (imagining that certain types will be unions etc), however it's worth not getting too bogged down in those specific implementation details as I'd rather base that evolution on the real world usage when we have it. The Configure integration section should more or less work the same as before.  ## Testing - When utilising the onboarding flow for custom logs at `/app/observabilityOnboarding/customLogs` can you: - Create a custom integration? (It's worth verifying the network requests, and the assets are installed). - If you navigate forward, then back, make a change to the integration fields, and navigate forward again is the previously created integration deleted? - Is the success callout with the integration name shown on the next wizard panel? - Do field validations work? - Are errors displayed when you try to create an integration with a name that already exists? - Can you retry when there is a server error? (you can block network requests to the custom integrations API to test this) ## Screenshots     ## State machine diagram (The top level management machine is super basic, so this is just the create machine)  ## Followups - Tests (the current onboarding UI implementation doesn't have tests so whilst it's not ideal technically this coverage stays the same) - Storybook - Replace other plugins' usage with xstate-utils (not urgent) --------- Co-authored-by: kibanamachine <[email protected]> Co-authored-by: Yngrid Coello <[email protected]>
gbamparop
added
Feature:Logs Onboarding
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Summary
With #163219 we introduced the creation of a basic integration to the onboarding flow. Currently, this is the only touchpoint with the custom integrations API.
This issue is to extract those resources, e.g. hooks, types etc, in to a package. We can also introduce some standalone state management with this extraction. The end result is that there should be a package that any solution within Kibana can easily use and drop in to facilitate any sort of "create an integration" flow.
ACs
node scripts/generate package.The text was updated successfully, but these errors were encountered: