[Alerting] document requirements for developing new action types #69164
Conversation
pmuellr
added
Feature:Alerting
v8.0.0
release_note:skip
|
Ready for review. The originating issue #67864 mentions some items that I didn't add, as I wasn't sure what to add for them:
I wasn't sure if "usability by a generic alert" was a sort of general "make it easy to use" point. Eg, don't make your config/secrets/params so complex that creating/editing these actions ends up being more complicated than it needs to. Perhaps mentioning to move as many things to config and keeping params smaller, to make reusing a connector easier (less things to fill in). Some of this stuff seems kinda basic, but perhaps worth mentioning ... For integrations with the connectors list, I'm not aware of anything special an action has to do here, beyond setting licensing stuff. |
|
Pinging @elastic/kibana-alerting-services (Team:Alerting Services) |
x-pack/plugins/actions/README.md
Outdated
|
|
||
| ## user interface | ||
|
|
||
| In order to make this action usable in the Kibana UI, you will need to provide all the UI editing aspects of the action. The existing action type user interfaces are defined in [`x-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types`](../triggers_actions_ui/public/application/components/builtin_action_types). |
There was a problem hiding this comment.
Probably it makes sense to add the proper link to the UI docs which describe how to create new action type. https://github.com/elastic/kibana/tree/master/x-pack/plugins/triggers_actions_ui#create-and-register-new-action-type-ui
x-pack/plugins/actions/README.md
Outdated
|
|
||
| ## plugin location | ||
|
|
||
| Currently actions that are licensed as "basic" **MUST** be implemented in the actions plugin, other actions can be implemented in any other plugin that pre-reqs the actions plugin. |
There was a problem hiding this comment.
It might be worth a mention that if the action type isn't specific to their plugin (ex: blacklist IPs in SIEM, create a monitor in uptime, etc) that it should live within the actions plugin.
The last thing we'd want, for example, is the snapshot_restore plugin defining an IFTTT action type that users can't use when disabling the snapshot_restore plugin.
|
|
||
| # Developing New Action Types | ||
|
|
||
| When creating a new action type, your plugin will eventually call `server.plugins.actions.setup.registerType()` to register the type with the actions plugin, but there are some additional things to think about about and implement. |
There was a problem hiding this comment.
It might be worth mentioning something along the lines of getting early structure / design feedback to avoid surprises in the PR.
resolves elastic#67864 Adding this to the actions README.md, it should be published as asciidocs at GA.
pmuellr
force-pushed
the
actions/readme-dev-requirements
branch
from
5418266
to
64dde1c
Compare
…stic#69164) * [Alerting] document requirements for developing new action types resolves elastic#67864 Adding this to the actions README.md, it should be published as asciidocs at GA.
* master: (32 commits) [Ingest Pipelines] Load from json (elastic#70297) [Rum Dashbaord] Rum selected service view (elastic#70579) [Uptime] Prevent duplicate requests on load for index status (elastic#70585) [ML] Changing shared module setup function parameters (elastic#70589) [Ingest Manager] Add ability to sort to agent configs and package configs (elastic#70676) [Alerting] document requirements for developing new action types (elastic#69164) Fixed adding an extra space character on selecting alert variable in action text fields (elastic#70028) [Maps] show vector tile labels on top (elastic#69444) chore(NA): upgrade to lodash@4 (elastic#69868) Add Snapshot Restore README with quick-testing steps. (elastic#70494) [EPM] Use higher priority than default templates (elastic#70640) [Maps] Fix cannot select Solid fill-color when removing fields (elastic#70621) [kbn/optimizer] only build specified themes (elastic#70389) Fix saved query modal overlay (elastic#68826) Update component templates list to render empty prompt inside of content container. Show detail panel when deep-linked, even if there are no component templates. (elastic#70633) [Security Solution] Renames the `Investigate in Resolver` Timeline action (elastic#70634) fix 400 error on initial signals search (elastic#70618) [Maps] fix unable to edit heatmap metric (elastic#70606) Update network idle timeout (elastic#70629) [APM] Disable flaky useFetcher test (elastic#70638) ...
* master: (199 commits) [Telemetry] Add documentation about Application Usage (elastic#70624) [Ingest Manager] Improve agent unenrollment with unenroll action (elastic#70031) Handle timeouts on creating templates (elastic#70635) [Lens] Add ability to set colors for y-axis series (elastic#70311) [Uptime] Use elastic charts donut (elastic#70364) [Ingest Manager] Update registry URL to point to snapshot registry (elastic#70687) [Composable template] Create / Edit wizard (elastic#70220) [APM] Optimize services overview (elastic#69648) [Ingest Pipelines] Load from json (elastic#70297) [Rum Dashbaord] Rum selected service view (elastic#70579) [Uptime] Prevent duplicate requests on load for index status (elastic#70585) [ML] Changing shared module setup function parameters (elastic#70589) [Ingest Manager] Add ability to sort to agent configs and package configs (elastic#70676) [Alerting] document requirements for developing new action types (elastic#69164) Fixed adding an extra space character on selecting alert variable in action text fields (elastic#70028) [Maps] show vector tile labels on top (elastic#69444) chore(NA): upgrade to lodash@4 (elastic#69868) Add Snapshot Restore README with quick-testing steps. (elastic#70494) [EPM] Use higher priority than default templates (elastic#70640) [Maps] Fix cannot select Solid fill-color when removing fields (elastic#70621) ...
resolves #67864
Adding this to the actions README.md, it should be published as asciidocs at GA.
Checklist
Delete any items that are not applicable to this PR.