Error handling messages for Plugins
If a plugin monitor is not successfully registered, the error message, along with the error details, can be viewed from the Site24x7 web client in the Help Assistant tab under Plugins.
Here is a list of some common error messages, their causes, and the solutions:
Common error messages for all plugins:
Error Message | Reason | Solution |
---|---|---|
Register with higher version / Higher version of plugin available |
The plugin is registered with an existing plugin template, i.e., a similar plugin was registered from another server, which has a higher version. |
Check the highest version of a similar plugin that is already registered and update the same version or higher version in this plugin as well. |
Connection error |
Connection could not be established. Either the given credentials are wrong or the URL is not reachable. |
Execute the plugin manually with the login credentials and check if it returns a valid JSON output. Also, check the URL in a browser to see if it's working fine. Then, restart the server monitoring agent. |
Execution error / Plugin Script Output is not in json format. |
Plugin execution unsuccessful due to invalid JSON output. |
Check the script and ensure that the script returns a valid JSON output. You can execute the script manually, copy the output, and then validate the JSON output using this free JSON formatter. |
**node not present |
Cannot connect to the specified node |
Check whether the mentioned node is present |
<Module not installed> |
The required dependency module is not installed. |
Go through the Prerequisites section of the setup steps and install the relevant dependency module. Then, restart the server monitoring agent. |
Plugin file type not supported |
Only the following formats are supported for writing a plugin:
|
Ensure your script supports the mentioned formats |
Plugin file not found / No such file or directory |
Folder is empty or the plugin file name does not match with the folder name. |
Ensure the plugin file name and the folder name are the same. Also, move the plugin folder containing the corresponding plugin file to the Site24x7 plugin directory. |
Plugin execution timed out |
The plugin script runs beyond the maximum time set before throwing an exception. |
Increase the Script Execution Timeout value. |
Syntax error: end of file unexpected |
The plugin script has mismatched code structure or incorrect formatting. |
The system executes the code line by line, so the syntax needs to be correct, with proper use of quotes (“”), brackets (), and other formatting. |
No plugin versions available in DB |
The mandatory plugin_version key is missing. |
Update the plugin script with the plugin_version number, which is a mandatory field. { |
<plugin name> Permission denied |
The plugin script did not get executed because the plugin does not have required permissions. |
1. Use the ls -l command to check the permissions of the plugin script. |
Error message not configured |
The error message is not configured. |
Within the plugin script, capture the exception as an error for instances when it's unable to collect metrics. |
**specific to Elasticsearch plugin
HTTP Error Messages:
Error Message | Reason | Solution |
---|---|---|
HTTP error |
HTTP connection error |
Please check your configurations and restart the server agent |
HTTP Error 404 |
|
Please give the correct url in the plugin file |
HTTP Error 401 |
(Authentication Error)
|
Please give the correct authentication parameters in the plugin file |
HTTP Error 403 |
(Authorization Error)
|
Please make sure the plugin script is authorized to interact with the stats URL |
HTTP Error 302 |
The requested resource resides temporarily under a different URI |
Check the configuration and remove the redirection |
<urlopen error [Errno -2] Name or service not known> |
The status URL you have added in the plugin file is invalid or not known |
Please check the stats url given in the plugin file for any mistakes. |
Related Articles:
- Possible reasons why my Linux plugin has not been added to my Site24x7 account
- Possible reasons why my Windows plugin is not added to my account
- Site24x7 plugins
- How plugin monitoring works
- How to debug a plugin monitor?
- Plugin Template Configuration
- Write custom plugins: Windows | Linux
- Add a threshold profile for plugins
- Add a server monitor
- Server monitoring architecture
- Server performance metrics