Différences

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

--- report:zabbix:userguide [2026/02/03 12:45] – créée admin
+++ report:zabbix:userguide [2026/02/04 16:22] (Version actuelle) – admin
@@ Ligne 1: / Ligne 1: @@
-<html><!-- nameoodle --></html>{{ :blocks:logo-apl.png? nolink |}}<html><!-- /nameoodle --></html>
+<html><!-- nomoodle --></html>{{ :blocks:logo-apl.png? nolink |}}<html><!-- /nomoodle --></html>
@@ Ligne 7: / Ligne 7: @@
 ====Overall Presentation====
-The Zabbix report is report plugin performing measurements and data emission to a Zabbix Server and has no direct interface in Moodle. Only global configuration is necessary to ensure operation. The measurement results are exploited in the Zabbix interface, through graphs, recollection screens, or customized dashboards.
+The Zabbix report is report plugin performing measurements and data emission to a Zabbix Server and has **no direct interface** in Moodle. Only global configuration is necessary to ensure operation. The measurement results are exploited in the Zabbix interface, through graphs, recollection screens, or customized dashboards.
 Path : ''Site admin => plugins => reports => zabbix sender''
-====Plugin overview====
-{{ :report:zabbix:plugin-sender.png? nolink&800 |}}
 ====Report configuration====
-**Zabbix server protocol (zabbixprotocol):** The server's protocol used for administration operations using the zabbix API. the Zabbix server should be directly accessible without redirects. Default : HTTPS
+{{ :report:zabbix:zabbixreportsettings_1.jpg?1000 |}}
-**Zabbix server IP:** direct IP of the server or zabbix proxy. A known DNS name is acceptable - Default: Empty
+**Zabbix server protocol ''zabbixprotocol'':** The server's protocol used for administration operations using the zabbix API. the Zabbix server should be directly accessible without redirects. Default : HTTPS
-**Moodle host name in zabbix (zabbixhostname):** The host name associated with the MOODLE model in the zabbix server configuration. To be represented, a host definition must be created in Zabbix that exactly matches that name. Default the Moodle or is the report plugin: monmoodle.com
+**Zabbix server IP ''zabbixserver'':** direct IP of the server or zabbix proxy. A known DNS name is acceptable - Default: Empty
-**Order zabbix_sender (zabbixsendercmd):** The location of the "sender" command for the transmission of data to Zabbix.  Defect : /usr/bin/zabbix_sender
+**Moodle host name in zabbix ''zabbixhostname'':** The host name used to defined the host entry in the Zabbix server configuration. Herein name must match exactly what was used in host definition.
-**Determination of user roles (userrolepolicy):** Method of determining user roles. Some methods require special configurations.
+**zabbix_sender shell command''zabbixsendercmd'':** The location of the "sender" command to send data to Zabbix.  Defaults to: /usr/bin/zabbix_sender
-Default : Resolution based on standard role assignments of moodle.
+{{ :report:zabbix:zabbixreportsettings_2.jpg?1000 |}}
-Other choice : Resolution based on profile fields (case of Moodle in ENTs)
-**Username Zabbix (zabbixadminusername):** This is the name of the administrator user who can operate the Zabbix API. This user must be created in the Zabbix administration. He doesn't need access to the Zabbix frontend. However, he must be able to read and write in the MOODLE models of the zabbix host associated with Moodle.  Default : admin
+**User roles ''userrolepolicy'':** Method for determination of user roles. This determination can be usefull for some values that are indexed to a user role, such as Studetns or Teachers, f.e. when counting connections. Some methods require special configurations. Default: Resolution based on standard role assignments of moodle.
-**Zabbix password (zabbixadminpassword):** The password of the administrator user capable of operating the Zabbix API.
+   * Other choice: Resolution based on profile fields (case of Moodle in ENTs)
-===Zabbix groups (zabbixgroups)===
+**Username Zabbix ''zabbixadminusername'':** The administrator's username who can operate the Zabbix API. This user must have been created in the Zabbix administration. This user does NOT need to access the Zabbix frontend. However, he do needs to read and write in the MOODLE models of the zabbix host associated with Moodle.  Default: admin
-Groups (comma list) to which the host representing this Moodle is attached. The zabbix hosts associated with a moodle can be grouped into zabbix groups to perform measurement consolidations on a moodle group.
+**Zabbix password ''zabbixadminpassword'':** The administrator's password allowed to operate the Zabbix API.
-**Definition of the local interface (interfacedef):** The method to inform Zabbix of the network interface to use to communicate with this server. Default : By DNS
+**Zabbix groups ''zabbixgroups'':**
-**In operation (tellithasstarted):** By activating this box, you inform Zabbix that this platform is in operation.
+Groups (comma separated list) to attach this host to. Zabbix hosts representing a moodle can be grouped into zabbix groups to perform measurement consolidations using a MOODLE GROUP template. This template provides predefined aggregations on most common indicators.
-This allows "zone" statistics in the case of constellations of Moodles which only take into account platforms actually in operation. You can alternatively offer a heuristic by SQL query to determine this state. Explicit activation (this parameter) prevails. Defect : Waiting for operation
-**SQL heuristic for exploitation (tellithasstartedsql):** An SQL query delivering a result named "started" determines the start-up state of the operation. Defect : Empty
+**Definition of the local interface ''interfacedef'':** A method to inform Zabbix server on which network interface it will communicate with this server. Default : By DNS
-**Registration in zabbix:** By using this form, and to the extent that your user administrator zabbix is created and has sufficient rights, you can ask the Zabbix server to save the local host definition that matches this Moodle.
+{{ :report:zabbix:zabbixreportsettings_3.jpg?1000 |}}
+**In operation ''tellithasstarted'':** By activating this box, you inform Zabbix that this platform is a production environment. This is usefull when grouping moodles in a Moodle Group in Zabbix, so that effective production plaforms can be identified (vs. candidate instances, or preproduction instances).
+You can alternatively define a finer heuristic using a SQL query to determine this state. Explicit activation (this parameter) prevails. Default: Waiting for operation
+**SQL heuristic for exploitation ''tellithasstartedsql'':** An SQL query delivering a result named "started" determines the production state of the operation. Default: Empty
+**Zabbix allowed cron period:** This was recently added for some installations of Moodle using large Moodle arrays (f.e. using [[:local:vmoodle|Moodle Virtualization plugin]]). In that case, we would need to slower down a bit the Zabbix frequency specially for the **instant task** to lower the data recolection technical impact on the installation (we used it f.e. on large array with 350 moodles aside)
+{{ :report:zabbix:zabbixreportsettings_4.jpg?1000 |}}
+**Registration in zabbix:** By using this form, and pursuant your Zabbix administrator remote user is created and has sufficient permissions, you can ask the Zabbix server to register the local host definition that matches this Moodle.
+Once the settings are properly setup, save them once. then, go to the registration process clocking on the link. You will be routed to a confirmation screen:
+{{ :report:zabbix:zabbixregistering.jpg?1000 |}}
+Clicking on the confirmation button will send all the required information to Zabbix to initiate a new host configuration for your Moodle. Of course the administrator user needs to be correctly setup in Zabbix for the registration to work.
 ====PRO version ====
-By entering activation keys obtained from your TMA provider, you will activate the additional functions of this plugin.
+By entering activation keys obtained from your TMA provider, you will activate the plugin's additional features:
+  * Moodle Plugins local indicators (See our [[report:zabbix:developerguide|plugin developer guide]] for more details on how designing your specific indicators in your plugins).
+  * Zabbix discovery of Moodle dynamic environment (read the additional [[:report:zabbix:discoveringdata|guide for setting up discovery]])
+  * [[:report:zabbix:customindicators|Moodle administrator defined custom measurements]] (without coding)
 ----
-<html><!-- nameoodle --></html>
+<html><!-- nomoodle --></html>
-[[:report:zabbix|Return to plugin index]] - [[:plugins|Return to plugin index]] - [[:start|Return to catalog]]
+[[:report:zabbix|Back to Zabbix Report index]] - [[:plugins|Back to plugin index]] - [[:start|Back to catalog]]
 <html><!-- /nomoodle --></html>