NetAlertX/front/plugins/website_monitoring/config.json

{
    "code_name": "website_monitor",
    "settings_short_prefix": "WEBMON",
    "display_name" : "Website monitor",
    "font_awesome_icon_classses": "fa-solid fa-globe",
    "description": {
        "en_us" : "This plugin is to monitor status changes of different services or websites."
    },
    "database_column_aliases":{
        "Plugins_Events":{
            "Index":{
                "en_us" : "Index"
            },
            "Object_PrimaryID":{
                "en_us" : "Monitored URL"
            },
            "DateTime":{
                "en_us" : "Checked on"
            },
            "Watched_Value1":{
                "en_us" : "Status code"
            },
            "Watched_Value2":{
                "en_us" : "Latency"
            }
        }
    },
    "settings":[
        {
            "type": "ENABLE",
            "default_value":"False",
            "options": [],
            "name" : {
                "en_us" : "Enable plugin"
            },
            "description": 
                {
                    "en_us" : "Enable a regular scan of your services. You need to enable this setting for anything to be executed regarding this plugin."
                }
            
        },
        {
            "type": "RUN",
            "default_value":"none",
            "options": ["none","once","schedule"],
            "name" : {
                "en_us" : "Schedule"
            },
            "description": 
                {
                    "en_us" : "Enable a regular scan of your services. If you select <code>schedule</code> the scheduling settings from below are applied. If you select <code>once</code> the scan is run only once on start of the application (container) for the time specified in <a href=\"#WEBMON_TIMEOUT\"><code>WEBMON_TIMEOUT</code> setting</a>."
                }
            
        },
        {
            "type": "FORCE_REPORT",
            "default_value": false,
            "options": [],
            "name" : {
                "en_us" : "Schedule"
            },
            "description": 
                {
                    "en_us" : "Enable a regular scan of your services. If you select <code>schedule</code> the scheduling settings from below are applied. If you select <code>once</code> the scan is run only once on start of the application (container) for the time specified in <a href=\"#WEBMON_TIMEOUT\"><code>WEBMON_TIMEOUT</code> setting</a>."
                }
            
        },
        {
            "type": "RUN_SCHD",
            "default_value":"0 2 * * *",
            "options": [],
            "name" : {
                "en_us" : "Schedule"
            },
            "description": 
                {
                    "en_us" : "Only enabled if you select <code>schedule</code> in the <a href=\"#WEBMON_RUN\"><code>WEBMON_RUN</code> setting</a>. Make sure you enter the schedule in the correct cron-like format (e.g. validate at <a href=\"https://crontab.guru/\" target=\"_blank\">crontab.guru</a>). For example entering <code>0 4 * * *</code> will run the scan after 4 am in the <a onclick=\"toggleAllSettings()\" href=\"#TIMEZONE\"><code>TIMEZONE</code> you set above</a>. Will be run NEXT time the time passes."
                }
            
        },
        {
            "type": "API_SQL",
            "default_value":"SELECT * FROM plugin_website_monitor",
            "options": [],
            "name" : {
                "en_us" : "API endpoint"
            },
            "description": 
                {
                    "en_us" : "You can specify a custom SQL query which will generate a JSON file and then expose it via the <a href=\"/api/plugin_website_monitor.json\" target=\"_blank\"><code>plugin_website_monitor.json</code> file endpoint</a>."
                }
            
        },
        {
            "type": "RUN_TIMEOUT",
            "default_value":5,
            "options": [],
            "name" : {
                "en_us" : "Run timeout"
            },
            "description": 
                {
                    "en_us" : "Maximum time in seconds to wait for a Website monitor check to finish for any url."
                }
            
        },
        {
            "type": "NOTIFY_ON",
            "default_value":["Watched_Value1"],
            "options": ["Watched_Value1","Watched_Value2","Watched_Value3","Watched_Value4"],
            "name" : {
                "en_us" : "Notify on"
            },
            "description": 
                {
                    "en_us" : "Send a notification if selected values change. Use <code>CTRL + Click</code> to select/deselect. <ul> <li><code>Watched_Value1</code> is response status code (e.g.: 200, 404)</li><li><code>Watched_Value2</code> is Latency (not recommended)</li><li><code>Watched_Value3</code> unused </li><li><code>Watched_Value4</code> unused </li></ul>"
                }            
        },
        {
            "type": "ARGS",
            "default_value":"",
            "options": [],
            "name" : {
                "en_us" : "Run timeout"
            },
            "description": 
                {
                    "en_us" : "Change the <a href=\"https://linux.die.net/man/1/dig\" target=\"_blank\">dig utility</a> arguments if you have issues resolving your Internet IP. Arguments are added at the end of the following command: <code>dig +short </code>."
                }            
        }

    ]
}