ffdc/docs/plugin.md

1 ### Plugin  subsection
3 Plugin feature for the log collector is to load a user python functions at
11 ### Understanding Plugin
13 The plugin works like any stand-alone piece of python script or library
16 The main components in plugin infrastructure are:
18 - plugin directory
19 - plugin directive in YAML
20 - plugin parser in the collector engine
22 ### Plugin Directory
38 ### Plugin Template Example
43 # Sample for documentation plugin
63 In YAML plugin, you will need to pass self object as part of the arguments.
77 This is to avoid passing object self in plugin args YAML when calling the class
81 You can add your own plugin modules to extend further.
83 Test your plugin:
91 Plugin function without return statement.
94     - plugin:
98             - "Hello plugin"
101 Plugin function with return statement.
104     - plugin:
117     - plugin:
132 The rule remains same as other functions, however for a class object plugin
143     - plugin:
148             - "Hello Plugin call"
151 ### Plugin execution output for sample
154         [PLUGIN-START]
155         Call func: plugin.foo_func.print_vars("Hello plugin")
156         Hello plugin
158         [PLUGIN-END]
160         [PLUGIN-START]
161         Call func: plugin.foo_func.return_vars()
163         [PLUGIN-END]
166 ### Plugin FILES Directive
170 If in the YAML with Plugin module called and corresponding file order
172 plugin response if there is any will be written to named file, if
179 Else, plugin response will be skipped and not written to any file.
186 ### Plugin ERROR Directive
188 Error directive on plugin supported
190 - exit_on_error : If there was an error in a plugin stacked, the subsequent
191   plugin would not be executed if this is declared.
193   then the plugin block will continue to execute.
198     - plugin:
207 the plugin during execution and not the error response returned from the plugin
210 To go further, there is another directive for plugin to check if the plugin
222     - plugin:
223     - plugin:
224       - plugin_name: plugin.ssh_execution
235 The above example states that, the plugin function is expecting a return data of
236 type string. If the plugin function does not return data or the returned data is
240 This directive helps in validating plugin return data to handle different plugin
242 plugin execution to do further processing correctly.