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

[Feature Anywhere] Ensure full plugin integration with OSD #490

Closed
8 tasks done
ohltyler opened this issue May 23, 2023 · 1 comment
Closed
8 tasks done

[Feature Anywhere] Ensure full plugin integration with OSD #490

ohltyler opened this issue May 23, 2023 · 1 comment
Labels

Comments

@ohltyler
Copy link
Member

ohltyler commented May 23, 2023

To fully utilize the framework provided in OSD for collecting and visualizing plugin data correctly, we need to ensure the plugin does the following:

To ensure integration with auto-deletion:

  • in the expression function to fetch results, determine whether a resource is deleted or just not visible due to backend roles
  • if deleted, propagating the error by using RESOURCE_DELETED VisLayerErrorType (ref)

To ensure integration with saved objects:

  • Double check that all saved objs created are using the latest ISavedAugmentVis interface - see here for the latest based off of the feature branch.
  • Create the objs using the createAugmentVisSavedObject fn for automatic handling of UI settings (feature turned off, limit reached, etc.)

To ensure integration with chart tooltips:

  • Ensure your produced VisLayers in the expression function include a pluginEventType (recently added via this PR)

To ensure integration with alerting:

  • Add a notification with a an option to set up an alerting monitor after creating a detector, make sure this button is only shown if the alerting plugin is present.

Miscellaneous / best practices:

  • the originPlugin field in the saved obj should be your plugin name. It does not have any strict standard but it should be consistent across your plugin. This value is used to aggregate results by plugin type, and is visible in the stats API
  • the pluginResource.type field in the saved obj should be a human-readable value, e.g., Anomaly Detectors. This is the value visible on the view events page and custom tooltips. This also doesn't follow a strict standard, but should be consistent. This value is used to aggregate results by plugin resource type, and is visible in the stats API.
@amitgalitz
Copy link
Member

All these tasks were completed in multiple different commits that were squashed into main branch here: #539

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants