ffdc/docs/plugin.md

13 The plugin works like any stand-alone piece of python script or library
18 - plugin directory
19 - plugin directive in YAML
20 - plugin parser in the collector engine
25 engine loads these plugins during runtime and on demand from the YAML else they
40 Stand-alone functions: plugins/foo_func.py
94     - plugin:
95         - plugin_name: plugins.foo_func
96         - plugin_function: print_vars
97         - plugin_args:
98             - "Hello plugin"
104     - plugin:
105         - plugin_name: plugins.foo_func
106         - plugin_function: return_value = func_return_vars
107         - plugin_args:
117     - plugin:
118         - plugin_name: plugins.foo_func
119         - plugin_function: print_vars
120         - plugin_args:
121             - return_value
127      - plugin_function:  return_value1,return_value2 = print_vars
136         - plugin_name: plugins.<file_name>.<class_object>
137         - plugin_function: <class_method>
143     - plugin:
144         - plugin_name: plugins.plugin_class.plugin_class
145         - plugin_function: plugin_print_msg
146         - plugin_args:
147             - self
148             - "Hello Plugin call"
154         [PLUGIN-START]
158         [PLUGIN-END]
160         [PLUGIN-START]
163         [PLUGIN-END]
176         -'name_file.txt'
183         - None
188 Error directive on plugin supported
190 - exit_on_error : If there was an error in a plugin stacked, the subsequent
192 - continue_on_error : If there was an error and user declare this directive,
198     - plugin:
199         - plugin_name: plugins.foo_func
200         - plugin_function: print_vars
201         - plugin_args:
202             - return_value
203         - plugin_error: exit_on_error
216     - plugin_expects_return: <data type>
222     - plugin:
223       - plugin_name: plugin.ssh_execution
224       - plugin_function: ssh_execute_cmd
225       - plugin_args:
226         - ${hostname}
227         - ${username}
228         - ${password}
229         - cat /etc/os-release
230         - 3
231       - plugin_expects_return: str
240 blocks stacked together which are depending on the success of the previous