Page History

#================================================================================
# webui-module-service-weather
#================================================================================
# Modules that can load this module:
# - WebUI
# This module display service-weather in WebUI
#================================================================================

define module {

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ──────────────────────────────────────────────────────────    MODULE IDENTITY    ────────────────────────────────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ─── Module name [ Must be unique ]                                                                                              [ MANDATORY ] ───
    # ───                                                                                                                                           ───
    module_name                                         webui-module-service-weather-example

    # ─── Module type [ Do not edit ]                                                                                                 [ MANDATORY ] ───
    # ───                                                                                                                                           ───
    module_type                                         webui_module_service_weather

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ──────────────────────────────────────────────────────    EXTERNAL LINKS OPTIONS    ─────────────────────────────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ─── This option allows you to change the path for external links.                                                                             ───
    # ───       Use it for security reasons, to have external url with a different path than the                                                    ───
    # ───       default installation                                                                                                                ───
    # ───       ⚠ Change this parameter will change all your external links.                                                                        ───
    # ─── sample url : http://localhost:7767/service-weather/external/abcd01/xyz009                                                                 ───
    # ─── where :                                                                                                                                   ───
    # ───     "http://" is the value of the link protocol                                                                                           ───
    # ───     "localhost:7767" is the value of the base url                                                                                         ───
    # ───     "external" is the value of this parameter                                                                                             ───
    # ───     "abcd01" is the service weather uuid                                                                                                  ───
    # ───     "xyz009" is the external link configuration uuid                                                                                      ───
    # ─── The following characters are prohibited : ",',/ and space.                                                                                ───
    #                                                                                                                                               ───
    #           Default : external                                                                                                                  ───
    #                                                                                                                                               ───
    # broker__module_webui__module_service_weather__default_external_link__external_part_url external

    # ─── This option allows you to change the path for external links.                                                                             ───
    # ───       Use it for security reasons, to have external url with a different path than the                                                    ───
    # ───       default installation                                                                                                                ───
    # ───       ⚠ Change this parameter will change all your external links.                                                                        ───
    # ─── sample url : http://localhost:7767/service-weather/external/abcd01/xyz009                                                                 ───
    # ─── where :                                                                                                                                   ───
    # ───     "http://" is the value of the link protocol                                                                                           ───
    # ───     "localhost:7767" is the value of this parameter                                                                                       ───
    # ───     "external" is the value of the external_part_url                                                                                      ───
    # ───     "abcd01" is the service weather uuid                                                                                                  ───
    # ───     "xyz009" is the external link configuration uuid                                                                                      ───
    # ─── The following characters are prohibited : ",', and space.                                                                                 ───
    #                                                                                                                                               ───
    #           Default : Your broker base url                                                                                                      ───
    #                                                                                                                                               ───
    # broker__module_webui__module_service_weather__default_external_link__base_url 

    # ─── This option allows you to change the link protocol for your external links                                                                ───
    # ───       This can be useful if you want your links to be on a reverse proxy that doesn't use same protocol as the WebUI                      ───
    # ───       default installation                                                                                                                ───
    # ───       Change this parameter will change all your external links.                                                                          ───
    #                                                                                                                                               ───
    #           Default : protocol_from_webui => It will be equal to the use_ssl of the WebUI.                                                      ───
    #                                            If use_ssl is True, it will be HTTPS, else it will be HTTP                                         ───
    #           ...     : http                                                                                                                      ───
    #           ...     : https                                                                                                                     ───
    #                                                                                                                                               ───
    # broker__module_webui__module_service_weather__default_external_link__link_protocol protocol_from_webui

    # ─── This option allows you to change if the authentication is needed for an external link.                                                    ───
    #                                                                                                                                               ───
    #           Default : 1 ( authentication is needed )                                                                                            ───
    #           ...     : 0 ( authentication is not needed )                                                                                        ───
    #                                                                                                                                               ───
    # broker__module_webui__module_service_weather__default_external_link__authentication_needed 1

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ──────────────────────────────────────────────────────────────────────────────────────────────────────────────    WEATHER PERFORMANCEHISTORY OPTIONS    ────────────────────────────────────────────────────────────────────────────────────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ─── Maximal This option allows you to set the maximum number of widgetschanges saved in database for oneeach weather pageview.                                      ───
    # ───       /!\ If you decrease the value, the extra history will be deleted on daemon startup.                              ───
    # ─── Use this to limit your users and prevent them from making a weather page───
 that takes  # ───       /!\ Minimum value is 10.                                         ───
    # ─── all server resources.                                                           ───
    #                                                      ───
    # ───                                                                                    ───
    #           Default : 100                                      ───
    # broker__module_webui__module_service_weather__default_max_widget_number 100

    # ───────────────────────  CACHE  ─────────────────────────────────────────────────────────────────────────────────────────────────────────────── #

    # ─── The refresh interval in seconds between each cache data calculation.                                                  ───
    #                ───
    # ─── Increase this period if the cache takes too many resources on server.                                                                     ───
    # ─── Minimum value is 60 seconds.                               ───
    # broker__module_webui__module_service_weather__weather_history__nb_changes_kept 100

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ───────────────────────────────────────────────────    INTERFACE VIEWS TRASH OPTIONS    ─────────────────────────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ────────────────  All Views Parameters  ─────────────────────────────────────────────────────────────────────────────────────────────────────── #

    # ─── This option allows you to set the maximum number of days that views are kept in the trash.        ───
    #                                    ───
    # ───       /!\ After this delay, the views are permanently DELETED.                                                                                       ───
    # ───       /!\ If you Defaultdecrease :the 60value, (the secondstoo )old views can be DELETED on daemon startup.                                                  ───
    # ───       /!\ Minimum value is 7 days.                                  ───
    #                                                                  ───
    #                                                                         ───
    # broker__module_webui__module_service_weather__cache__refresh_interval 60

    # ─── Define the limited time allowed to refresh the cache before raising a warning.                                              ───
    #          ───
 Default :  # ─── Thisuse_default_for_all => It will be usedequal byto the shinken-broker-module-weather-service checks to change its state'views_trash__delay_before_deletion__default_for_all' of the WebUI         ───
    #           ...     : A number of days (for example 30)               ───
    #                                                                      ───
    #                                                                     ───
    #           Default : 30 ( seconds )                                                      ───
    # broker__module_webui__module_service_weather__views_trash__delay_before_deletion__service_weather use_default_for_all

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ────────────────────────────────────────────────────────    PERFORMANCE OPTIONS    ──────────────────────────────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ─── Maximal number of widgets for one weather page.      ───
    #                                                                                 ───
    # ─── Use this to limit your users and prevent them from making a weather page that takes                                          ───
    # broker__module_webui__module_service_weather__cache__time_taken_for_compute_warning 30

    # ─── Define the───
 limited time allowed to# refresh─── theall cacheserver beforeresources. raising an error.                                                             ───
    # ─── This will be used by the shinken-broker-module-weather-service checks to change its state                                    ───
    # ───        ───
    #                                                                                                                               ───
    # broker__module_webui__module_service_weather__default_max_widget_number 100

    # ───────────────────────  CACHE  ─────────────────────────────────────────────────────────────────────────────────────────────────────────────── ───#

    # ─── The refresh interval in seconds between each cache data Defaultcalculation. : 40 ( seconds )                                                                 ───
    # ─── Increase this period if the cache takes too many resources on server.                          ───
        #                                   ───
    # ─── Minimum value is 60 seconds.                                                                                                  ───
    # broker__module_webui__module_service_weather__cache__time_taken_for_compute_critical 40

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ #───
    # │ ─────────────────────────────────────────────────────────    INTERNAL OPTIONS    ────────────────────────────────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ─── INTERNAL : DO NOT EDIT FOLLOWING PARAMETERS WITHOUT YOUR DEDICATED SUPPORT                                                                ───

    # ─── The time to wait before starting to refresh the cache                             ───
    #           Default : 60 ( seconds )                                    ───
    # ─── At start of the Broker, some element data are not directly available                                                       ───
    #           ───
    # ─── Increase this time if the module has "missing element" on every element at start                                                          ───
    # ─── This will give more time to the Scheduler to give all element data to the Broker and the module                               ───
    # broker__module_webui__module_service_weather__cache__refresh_interval 60

    #  ───
 Define the limited #time allowed to refresh the cache before raising a warning.                                                            ───
    # ─── This will be used by the shinken-broker-module-weather-service checks to change its state                                                 ───
    #               ───
    #           Default : 30 ( seconds )                                                                                                            ───
    #           Default : 30 ( seconds )                                                                                                            ───
    #               ───
       # broker__module_webui__module_service_weather__awaited_time_before_fetching_element_data 30

    [OVERRIDE_FROM] /etc/shinken-user/configuration/daemons/brokers/modules/webui/modules/webui_module_service_weather/webui                                                                                                                   ───
    # broker__module_webui__module_service_weather__defaultcache__grid_layout.cfg
    [OVERRIDE_FROM] /etc/shinken-user/configuration/daemons/brokers/modules/webui/modules/webui_module_service_weather/webui_module_service_weather__default_info_bar_layout.cfg
    [OVERRIDE_FROM] /etc/shinken-user/configuration/daemons/brokers/modules/webui/modules/webui_module_service_weather/webui_module_service_weather__default_widgets_layout.cfg 
	[OVERRIDE_FROM] /etc/shinken-user/configuration/daemons/brokers/modules/webui/modules/webui_module_service_weather/webui_module_service_weather__default_notifications_settings.cfg
 }
  

 ───       Change this parameter will change all your external links.                                                                          ───
    #                                                                                                                                               ───
    #           Default : protocol_from_webui => It will be equal to the use_ssl of the WebUI. 														───
    #                                            If use_ssl is True, it will be HTTPS, else it will be HTTP                                         ───
    #           ...     : http                                                                                                                      ───
    #           ...     : https                                                                                                                     ───
    #                                                                                                                                               ───
    # broker__module_webui__module_service_weather__default_external_link__link_protocol protocol_from_webui

    # ─── This option allows you to change if the authentication is needed for an external link.                                                    ───
    #                                                                                                                                               ───
    #           Default : 1 ( authentication is needed )                                                                                            ───
    #           ...     : 0 ( authentication is not needed )                                                                                        ───
    #                                                                                                                                               ───
    # broker__module_webui__module_service_weather__default_external_link__authentication_needed 1

broker__module_webui__module_service_weather__views_trash__delay_before_deletion__service_weather use_default_for_all

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ────────────────────────────────────────────────────────    PERFORMANCE OPTIONS    ──────────────────────────────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ─── Maximal number of widgets for one weather page.                                                                                           ───
    # ─── Use this to limit your users and prevent them from making a weather page that takes                                                       ───
    # ─── all server resources.                                                                                                                     ───
    # ───                                                                                                                                           ───
    # broker__module_webui__module_service_weather__default_max_widget_number 100

    # ───────────────────────  CACHE  ─────────────────────────────────────────────────────────────────────────────────────────────────────────────── #

    # ─── The refresh interval in seconds between each cache data calculation.                                                                      ───
    # ─── Increase this period if the cache takes too many resources on server.                                                                     ───
    # ─── Minimum value is 60 seconds.                                                                                                              ───
    #                                                                                                                                               ───
    #           Default : 60 ( seconds )                                                                                                            ───
    #                                                                                                                                               ───
    # broker__module_webui__module_service_weather__cache__refresh_interval 60

    # ─── Define the limited time allowed to refresh the cache before raising a warning.                                                            ───
    # ─── This will be used by the shinken-broker-module-weather-service checks to change its state                                                 ───
    #                                                                                                                                               ───
    #           Default : 30 ( seconds )                                                                                                            ───
    #                                                                                                                                               ───
    # broker__module_webui__module_service_weather__cache__time_taken_for_compute_warning 30

    # ─── Define the limited time allowed to refresh the cache before raising an error.                                                             ───
    # ─── This will be used by the shinken-broker-module-weather-service checks to change its state                                                 ───
    #                                                                                                                                               ───
    #           Default : 40 ( seconds )                                                                                                            ───
    #                                                                                                                                               ───
    # broker__module_webui__module_service_weather__cache__time_taken_for_compute_critical 40