You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
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:
To ensure integration with saved objects:
ISavedAugmentVis
interface - see here for the latest based off of the feature branch.To ensure integration with chart tooltips:
VisLayer
s in the expression function include apluginEventType
(recently added via this PR)To ensure integration with alerting:
Miscellaneous / best practices:
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 APIpluginResource.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.The text was updated successfully, but these errors were encountered: