Différences

Ci-dessous, les différences entre deux révisions de la page.

--- report:zabbix:customindicators [2026/02/07 11:07] – créée admin
+++ report:zabbix:customindicators [2026/02/07 17:10] (Version actuelle) – [Creating the measurements] admin
@@ Ligne 27: / Ligne 27: @@
 Than fill the measurment definition form:
+{{ :report:zabbix:custom_measurement_form_1.jpg?800 |}}
+**Measurement name:** Visible name for the measurment. Zabbix report usually name the measurements in Zabbix as "MOODLE <TOPIC> <ITEM> [<SUBITEM>] (f.e ''MOODLE ASSIGN DAILY SUBMISSIONS''), but you are free to give any name. It is recommended to choose the name you will also setup as Zabbix Item name in Zabbix.
+**Measuremnet Key:** This is the name of the item key in Zabbix. We use a dotted namespace for measurments, such as f.e. moodle.assign.dailysubmissions. Custom measurements are recommended adopting the ''moodle.custom.<itemname>'' namespace, but once again, you are free to choose any token, pursuant the Zabbic Item's key matches.
+**Units:** Give the measurement Units that will match Zabbix item definition.
+**Active:** Custom measurements can be disabled at any time, and so wil not be actualized if disabled.
+**Indicator SQL Query: ** Write a SQL query from moodle DB data. It must be a SELECT statement that returns a single value aliased to the field name ''meas''.
+{{ :report:zabbix:custom_measurement_form_2.jpg?800 |}}
+**Context:** System context will send a unique value based on query. Other contexts will send **as many** values as context instances in the context level. This will generate discoverable keys of the form: ''moodle.custom.<contextlevel>.<instanceid>.<itemname>''. These keys match the "discorevering" model of Zabbix.
+e.g. : ''moodle.custom.course.<id>.sectioncount''
+In case you run a custom measurement on a discoverable context level, your SQL statement SHOULD use the '':instanceid'' placeholder to focus the query to the appropriate instance.
+//IMPORTANT NOTE: At the moment, individual instances for a scanned context will generate one SQL query per instance, wich must result as **very costfull process** when targeting f.e. users, or many courses. In case this features finds interested people, we will drop in roadmap an optimisation taskforce to do it better.//
+**Context allowed instances:** If some context other that System Context is choosed, filling this field wil only send indicator values for the listed instance ids. Give a comma separated list of DB ids of instances represented by the choosen context level. All instances are sent if empty.
+**Context excluded instances:** If some context other that System Context is choosed, filling this field wil exclude for sending values for the listed instance ids. Give a comma separated list of DB ids of instances represented by the choosen context level. All instances are sent if empty.
+**Emission Rate:** Choose the emission task rate for this indicator.
+====Setting up the item in Zabbix====
+In Zabbix, edit the host representing the Moodle instance. Add a new element matching the Measurement Key, Adjust the storage ranges if needed, and add this measurement or graphs using it in your dashboards.
+====Checking the custom indicator works====
+You should have checked your SQL statement previoulsy in your DB command line tool or your DB manager tool.
+To check if the measurmeent works, and sends expected values:
+   - Ensure your CLI path is setup in the Server settings
+   - Go to **scheduled tasks board** in Moodle Server section
+   - Run the appropriate Zabbix sending task
+   - Check you can see the sending trace line in output.
+====Example of check====
+{{ :report:zabbix:failing_measure.jpg?1000 |}}
+The above measure fails because of misuse of the ''STR_REPLACE()'' macro rather than ''REPLACE()'' function. The scheduled task crashes and will not run any more measurements of the weekly emission.
+{{ :report:zabbix:correct_measure.jpg?1000 |}}
+Once fixed, the measure is sending the proper way.
 ----