You are here

Home » API reference » Monitoring 8

monitoring.schema.yml in Monitoring 8

config/schema/monitoring.schema.yml

File

config/schema/monitoring.schema.yml
View source 
  1. # General settings.

  2. monitoring.settings:

  3.   type: config_object

  4.   label: 'Monitoring settings'

  5.   mapping:

  6.     sensor_call_logging:

  7.       type: string

  8.       label: 'Call logging'

  9.     cron_run_sensors:

  10.       type: boolean

  11.       label: 'Run sensors during cron runs'

  12.     disable_sensor_autocreate:

  13.       type: boolean

  14.       label: 'Whether to never create sensors automatically in response to config changes'

  15. 

  16. # Config schema for sensor config entity.

  17. monitoring.sensor_config.*:

  18.   type: config_entity

  19.   label: 'Monitoring Sensor'

  20.   mapping:

  21.     id:

  22.       type: string

  23.       label: 'Machine-readable name'

  24.     label:

  25.       type: label

  26.       label: 'Sensor Label'

  27.     description:

  28.       type: text

  29.       label: 'Description'

  30.     category:

  31.       type: string

  32.       label: 'Category'

  33.     plugin_id:

  34.       type: string

  35.       label: 'Sensor plugin ID'

  36.     result_class:

  37.       type: string

  38.       label: 'Result Class'

  39.     value_label:

  40.       type: string

  41.       label: 'Value Label'

  42.     value_type:

  43.       type: string

  44.       label: 'Value Type'

  45.     status:

  46.       type: boolean

  47.       label: 'Enabled'

  48.     caching_time:

  49.       type: integer

  50.       label: 'Sensor Caching Time'

  51.     settings:

  52.       type: monitoring.settings.[%parent.plugin_id]

  53.       label: 'Settings'

  54.     thresholds:

  55.       type: mapping

  56.       label: 'Threshold'

  57.       mapping:

  58.         type:

  59.           type: string

  60.           label: 'Type'

  61.         warning:

  62.           type: integer

  63.           label: 'Warning'

  64.         critical:

  65.           type: integer

  66.           label: 'Critical'

  67.         warning_low:

  68.           type: integer

  69.           label: 'Warning'

  70.         critical_low:

  71.           type: integer

  72.           label: 'Critical'

  73.         warning_high:

  74.           type: integer

  75.           label: 'Warning'

  76.         critical_high:

  77.           type: integer

  78.           label: 'Critical'

  79. 

  80. # Base type for settings with common settings.

  81. monitoring.settings_base:

  82.   type: mapping

  83.   mapping:

  84.     result_logging:

  85.       type: boolean

  86.       label: Result logging

  87. 

  88. # Base settings for database and entity aggregators.

  89. monitoring.settings.aggregator_base:

  90.   type: monitoring.settings_base

  91.   mapping:

  92.     time_interval_field:

  93.       type: string

  94.       label: 'Time interval field'

  95.     time_interval_value:

  96.       type: integer

  97.       label: 'Time interval value'

  98.     conditions:

  99.       type: sequence

  100.       label: Conditions

  101.       sequence:

  102.         type: mapping

  103.         mapping:

  104.           field:

  105.             type: string

  106.           value:

  107.             type: string

  108.           operator:

  109.             type: string

  110.     verbose_fields:

  111.       type: sequence

  112.       label: Verbose fields

  113.       sequence:

  114.         type: string

  115.         label: 'Field'

  116. 

  117. monitoring.settings.database_aggregator:

  118.   type: monitoring.settings.aggregator_base

  119.   mapping:

  120.     table:

  121.       type: string

  122.       label: 'Table'

  123.     history_status:

  124.       type: boolean

  125.       label: 'History status'

  126. 

  127. monitoring.settings.entity_aggregator:

  128.   type: monitoring.settings.aggregator_base

  129.   label: 'Entity aggregator sensor settings'

  130.   mapping:

  131.     entity_type:

  132.       type: string

  133.       label: 'Table'

  134.     verbose_fields:

  135.       type: sequence

  136.       label: Fields / Attributes

  137.       sequence:

  138.         type: string

  139.         label: The field to display

  140. 

  141. monitoring.settings.monitoring_git_dirty_tree:

  142.   type: monitoring.settings_base

  143.   label: 'Dirty git tree sensor settings'

  144.   mapping:

  145.     repo_path:

  146.       type: string

  147.       label: 'Repository path'

  148.     status_cmd:

  149.       type: string

  150.       label: 'Status command'

  151.     check_branch:

  152.       type: boolean

  153.       label: 'Should check branch'

  154.     ahead_cmd:

  155.       type: string

  156.       label: 'Ahead command'

  157.     branches_cmd:

  158.       type: string

  159.       label: 'Branches command'

  160.     actual_branch_cmd:

  161.       type: string

  162.       label: 'Actual branch command'

  163.     expected_branch:

  164.       type: string

  165.       label: 'Git branch'

  166.     submodules_cmd:

  167.       type: string

  168.       label: 'Check submodules command'

  169. 

  170. monitoring.settings.monitoring_disappeared_sensors:

  171.   type: monitoring.settings_base

  172.   label: 'Disappaered sensor settings'

  173. 

  174. monitoring.settings.queue_size:

  175.   type: monitoring.settings_base

  176.   label: 'Queue size sensor settings'

  177.   mapping:

  178.     queue:

  179.       type: string

  180.       label: Name of the queue

  181. 

  182. monitoring.settings.update_status:

  183.   type: monitoring.settings_base

  184.   label: 'Update status sensor settings'

  185.   mapping:

  186.     type:

  187.       type: string

  188.       label: Type of updates to check

  189. 

  190. monitoring.settings.core_requirements:

  191.   type: monitoring.settings_base

  192.   label: 'Core requirements sensor settings'

  193.   mapping:

  194.     module:

  195.       type: string

  196.       label: 'Module name'

  197.     exclude_keys:

  198.       type: sequence

  199.       label: 'Exclude list'

  200.       sequence:

  201.         type: string

  202.         label: 'Exclude key'

  203. 

  204. monitoring.settings.payment_turnover:

  205.   type: monitoring.settings.entity_aggregator

  206.   label: 'Payment turnover sensor settings'

  207.   mapping:

  208.     currency_code:

  209.       type: string

  210.       lavel: Currency code

  211. 

  212. monitoring.settings.view_display_aggregator:

  213.   type: monitoring.settings_base

  214.   label: 'View display aggregator sensor settings'

  215.   mapping:

  216.     view:

  217.       type: string

  218.       label: 'View'

  219.     display:

  220.       type: string

  221.       label: 'Display'

  222. 

  223. monitoring.settings.search_api_unindexed:

  224.   type: monitoring.settings_base

  225.   label: 'Search Api settings'

  226.   mapping:

  227.     index_id:

  228.       type: string

  229.       label: 'Index ID'

  230. 

  231. monitoring.settings.watchdog_aggregator:

  232.   type: monitoring.settings.database_aggregator

  233.   label: 'Watchdog sensor settings'

  234. 

  235. monitoring.settings.php_notices:

  236.   type: monitoring.settings.watchdog_aggregator

  237.   label: 'PHP notices sensor settings'

  238. 

  239. monitoring.settings.dblog_404:

  240.   type: monitoring.settings.database_aggregator

  241.   label: '404 settings'

  242. 

  243. monitoring.settings.image_style_missing:

  244.   type: monitoring.settings.database_aggregator

  245.   label: 'Missing images sensor settings'

  246. 

  247. monitoring.settings.temporary_files_usages:

  248.   type: monitoring.settings.database_aggregator

  249.   label: 'Temporary files usages sensor settings'

  250. 

  251. monitoring.settings.redirect_404:

  252.   type: monitoring.settings.database_aggregator

  253.   label: 'Redirect 404 sensor settings'

  254. 

  255. monitoring.settings.user_integrity:

  256.   type: monitoring.settings_base

  257.   label: 'Privileged user integrity'

  258. 

  259. monitoring.settings.user_failed_logins:

  260.   type: monitoring.settings.watchdog_aggregator

  261.   label: 'Failed user sensor settings'

  262. 

  263. monitoring.settings.user_void_failed_logins:

  264.   type: monitoring.settings.watchdog_aggregator

  265.   label: 'Failed user sensor settings'

  266. 

  267. monitoring.settings.twig_debug_mode:

  268.   type: monitoring.settings_base

  269.   label: 'Monitor twig settings'

  270. 

  271. monitoring.settings.disk_usage:

  272.   type: monitoring.settings_base

  273.   label: 'Monitor disk space usage'

  274.   mapping:

  275.     directory:

  276.       label: Directory

  277.       type: string

  278. 

  279. monitoring.settings.system_load:

  280.   type: monitoring.settings_base

  281.   label: 'Monitor system load'

  282.   mapping:

  283.     average_monitored:

  284.       label: Average

  285.       type: string

  286. 

  287. monitoring.settings.monitoring_installed_modules:

  288.   type: monitoring.settings_base

  289.   label: 'Installed modules sensor settings'

  290.   mapping:

  291.     allow_additional:

  292.       label: Allow additional

  293.       type: boolean

  294.     modules:

  295.       label: Installed modules

  296.       type: sequence

  297.       sequence:

  298.         type: string

  299.         label: 'Module name'

  300. 

  301. monitoring.settings.config_value:

  302.   type: monitoring.settings_base

  303.   label: 'Config sensor settings'

  304.   mapping:

  305.     config:

  306.       type: string

  307.       label: 'Type'

  308.     key:

  309.       type: string

  310.       label: 'Key'

  311.     value:

  312.       # Value can be of different type (string, ...), depending on the settings.

  313.       type: ignore

  314.       label: 'Value'

  315. 

  316. monitoring.settings.state_value:

  317.   type: monitoring.settings_base

  318.   label: 'State sensor settings'

  319.   mapping:

  320.     key:

  321.       type: string

  322.       label: 'Key'

  323.     value:

  324.       # Value can be of different type (string, ...), depending on the settings.

  325.       type: ignore

  326.       label: 'Value'

  327. 

  328. monitoring.settings.cron_last_run_time:

  329.   type: monitoring.settings_base

  330.   label: 'Cron last run time sensor settings'

  331.   mapping: { }

  332. 

  333. monitoring.settings.ultimate_cron_errors:

  334.   type: monitoring.settings_base

  335.   label: 'Ultimate cron errors sensor settings'

  336. 

  337. monitoring.settings.database_disk_usage:

  338.   type: monitoring.settings_base

  339.   label: 'Monitors how much space the database uses'

  340. 

  341. monitoring.settings.solr_disk_usage:

  342.   type: monitoring.settings_base

  343.   label: 'Solr disk usage'

  344.   mapping:

  345.     server:

  346.       label: 'Server'

  347.       type: string

  348. 

  349. monitoring.settings.monitoring_system_memory:

  350.   type: monitoring.settings_base

  351.   label: 'System memory sensor settings'

  352.   mapping:

  353.     memory:

  354.       type: string

  355.       label: 'Memory'

  356.     value:

  357.       type: string

  358.       label: 'Value'

  359. 

  360. monitoring.settings.commerce_turnover:

  361.   type: monitoring.settings.entity_aggregator

  362.   label: 'Commerce total turnover sensor settings'

  363.   mapping:

  364.     commerce_order_paid_states:

  365.       type: sequence

  366.       label: '"Paid" order states'

  367.       sequence:

  368.         type: string

  369.         label: 'States'

  370.     commerce_order_currency:

  371.       type: string

  372.       label: 'Currency'