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

[Observability Onboarding] Generalize bash-snippet-onboarding #179544

Closed
flash1293 opened this issue Mar 27, 2024 · 1 comment
Closed

[Observability Onboarding] Generalize bash-snippet-onboarding #179544

flash1293 opened this issue Mar 27, 2024 · 1 comment
Labels
Feature: Observability Onboarding Team:obs-ux-logs Observability Logs User Experience Team

Comments

@flash1293
Copy link
Contributor

The existing quickstart flows for logs (system logs and custom logs) work the following way:

Image

To enable similar flows for other integrations, the existing logic in the onboarding plugin needs to be generalized to allow for different flows that follow the same pattern:

  • Install integration
  • Generate API key
  • Provide a downloadable config (either defined locally in the plugin or queried from the fleet plugin)
  • Check whether data got indexed

Ideally this logic is a simple allowlist for existing integrations plus minimal additional information:

  • Overrides for parts of the config from the fleet plugin (if necessary)
  • How to check for incoming data
  • Where to redirect the user in case data is available (which dashboard etc.)

Custom logs might stay special here as it's not installing an existing integration but is using a special API to create an integration on demand.

Besides the server side refactoring, the client side components around system and custom log flows should be generalized in the same way.

@flash1293
Copy link
Contributor Author

Closing as not planned for now

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature: Observability Onboarding Team:obs-ux-logs Observability Logs User Experience Team
Projects
None yet
Development

No branches or pull requests

1 participant