1 Zabbix agent 2

Zabbix agent 2 supports all item keys supported for Zabbix agent on Unix and Windows. This page provides details on the additional item keys, which you can use with Zabbix agent 2 only, grouped by the plugin they belong to.

The item keys are listed without parameters and additional information. Click on the item key to see the full details.

See also: Built-in plugins

Itemsleutel-details

Parameters zonder haakjes zijn verplicht. Parameters gemarkeerd met haakjes < > zijn optioneel.

ceph.df.details[connString,<user>,<apikey>]

Het gebruik van data en de verdeling ervan over pools in de cluster.
Retourwaarde: JSON-object.

Parameters:

• connString - de URI of sessienaam;
  
• user, password - de aanmeldingsgegevens voor Ceph.
  

ceph.osd.stats[connString,<user>,<apikey>]

Geaggregeerde en per OSD-statistieken.
Retourwaarde: JSON-object.

Parameters:

• connString - de URI of sessienaam;
  
• user, password - de aanmeldingsgegevens voor Ceph.
  

ceph.osd.discovery[connString,<user>,<apikey>]

De lijst met ontdekte OSD's. Gebruikt voor ontdekking op laag niveau.
Retourwaarde: JSON-object.

Parameters:

• connString - de URI of sessienaam;
  
• user, password - de aanmeldingsgegevens voor Ceph.
  

ceph.osd.dump[connString,<user>,<apikey>]

De gebruiksdrempels en statussen van OSD's.
Retourwaarde: JSON-object.

Parameters:

• connString - de URI of sessienaam;
  
• user, password - de aanmeldingsgegevens voor Ceph.
  

ceph.ping[connString,<user>,<apikey>]

Test of er een verbinding met Ceph kan worden gemaakt.
Retourwaarde: 0 - verbinding is verbroken (indien er enige fout wordt gepresenteerd, inclusief AUTH- en configuratieproblemen); 1 - verbinding is succesvol.

Parameters:

• connString - de URI of sessienaam;
  
• user, password - de aanmeldingsgegevens voor Ceph.
  

ceph.pool.discovery[connString,<user>,<apikey>]

De lijst met ontdekte pools. Gebruikt voor ontdekking op laag niveau.
Retourwaarde: JSON-object.

Parameters:

• connString - de URI of sessienaam;
  
• user, password - de aanmeldingsgegevens voor Ceph.
  

ceph.status[connString,<user>,<apikey>]

De algehele status van de cluster.
Retourwaarde: JSON-object.

Parameters:

• connString - de URI of sessienaam;
  
• user, password - de aanmeldingsgegevens voor Ceph.
  

docker.container_info[<ID>,<info>]

Gedetailleerde informatie over een container op laag niveau.
Retourwaarde: De uitvoer van de ContainerInspect API-oproep geserialiseerd als JSON.

Parameters:

• ID - de ID of naam van de container;
  
• info - de hoeveelheid informatie die wordt teruggegeven. Ondersteunde waarden: short (standaard) of full.

De gebruiker 'zabbix' van Agent 2 moet worden toegevoegd aan de 'docker' groep voor voldoende rechten. Anders zal de controle mislukken.

docker.container_stats[<ID>]

De statistieken van het resourcegebruik van de container.
Retourwaarde: De uitvoer van de ContainerStats API-oproep en het geserialiseerde CPU-gebruikspercentage als JSON.

Parameter:

• ID - de ID of naam van de container.

De gebruiker 'zabbix' van Agent 2 moet worden toegevoegd aan de 'docker' groep voor voldoende rechten. Anders zal de controle mislukken.

docker.containers

De lijst met containers.
Retourwaarde: De uitvoer van de ContainerList API-oproep geserialiseerd als JSON.

De gebruiker 'zabbix' van Agent 2 moet worden toegevoegd aan de 'docker' groep voor voldoende rechten. Anders zal de controle mislukken.

docker.containers.discovery[<opties>]

Geeft de lijst met containers terug. Gebruikt voor ontdekking op laag niveau.
Retourwaarde: JSON-object.

Parameter:

• opties - specificeer of alle containers dan wel alleen actieve containers moeten worden ontdekt. Ondersteunde waarden: true - retourneer alle containers; false - retourneer alleen actieve containers (standaard).

De gebruiker 'zabbix' van Agent 2 moet worden toegevoegd aan de 'docker' groep voor voldoende rechten. Anders zal de controle mislukken.

docker.data.usage

Informatie over het huidige datagebruik.
Retourwaarde: De uitvoer van de SystemDataUsage API-oproep, geserialiseerd als JSON.

De gebruiker 'zabbix' van Agent 2 moet worden toegevoegd aan de 'docker' groep voor voldoende rechten. Anders zal de controle mislukken.

docker.images

Geeft de lijst van afbeeldingen terug.
Retourwaarden: De uitvoer van de ImageList API-oproep, geserialiseerd als JSON.

De gebruiker 'zabbix' van Agent 2 moet worden toegevoegd aan de 'docker' groep voor voldoende rechten. Anders zal de controle mislukken.

docker.images.discovery

Geeft de lijst van afbeeldingen terug. Gebruikt voor laag-niveau ontdekking.
Retourwaarden: JSON object.

De gebruiker 'zabbix' van Agent 2 moet worden toegevoegd aan de 'docker' groep voor voldoende rechten. Anders zal de controle mislukken.

docker.info

De systeeminformatie.
Retourwaarden: De uitvoer van de SystemInfo API-aanroep, geserialiseerd als JSON.

De gebruiker 'zabbix' van Agent 2 moet worden toegevoegd aan de 'docker' groep voor voldoende rechten. Anders zal de controle mislukken.

docker.ping

Test of de Docker-daemon actief is of niet.
Retourwaarden: 1 - de verbinding is actief; 0 - de verbinding is verbroken.

De gebruiker 'zabbix' van Agent 2 moet worden toegevoegd aan de 'docker' groep voor voldoende rechten. Anders zal de controle mislukken.

memcached.ping[connString,<user>,<password>]

Test of een verbinding actief is of niet.
Retourwaarden: 1 - de verbinding is actief; 0 - de verbinding is verbroken (als er een fout wordt weergegeven, inclusief AUTH en configuratieproblemen).

Parameters:

• connString - de URI of sessienaam;
  
• user, password - de inloggegevens van Memcached.
  

memcached.stats[connString,<user>,<password>,<type>]

Haalt de uitvoer op van het STATS-commando.
Retourwaarden: JSON - de uitvoer is geserialiseerd als JSON.

Parameters:

• connString - de URI of sessienaam;
  
• user, password - de inloggegevens van Memcached;
  
• type - het gewenste type statistieken: items, sizes, slabs of settings (standaard leeg, retourneert algemene statistieken).

mongodb.collection.stats[connString,<user>,<password>,<database>,collection]

Geeft verschillende opslagstatistieken terug voor een opgegeven collectie.
Retourwaarden: JSON-object.

Parameters:

• connString - de URI of sessienaam;
  
• user, password - de inloggegevens van MongoDB;
  
• database - de naam van de database (standaard: admin);
  
• collection - de naam van de collectie.

mongodb.collections.discovery[connString,<user>,<password>]

Geeft een lijst van ontdekte collecties terug. Gebruikt voor laag-niveau ontdekking.
Retourwaarden: JSON-object.

Parameters:

• connString - de URI of sessienaam;
  
• user, password - de inloggegevens van MongoDB.

mongodb.collections.usage[connString,<user>,<password>]

Geeft de gebruikstatistieken voor collecties terug.
Retourwaarden: JSON-object.

Parameters:

• connString - de URI of sessienaam;
  
• user, password - de inloggegevens van MongoDB.

mongodb.connpool.stats[connString,<user>,<password>]

Geeft informatie terug over de open uitgaande verbindingen van de huidige database-instantie naar andere leden van de gedeelde cluster of replica-set.
Retourwaarde: JSON-object.

Parameters:

• connString - de URI of sessienaam;
  
• user, password - de inloggegevens van MongoDB;
  
• database - de naam van de database (standaard: admin);
  
• collection - de naam van de collectie.

mongodb.db.stats[connString,<user>,<password>,<database>]

Geeft de statistieken terug die de staat van een gegeven databasesysteem weerspiegelen.
Retourwaarde: JSON-object.

Parameters:

• connString - de URI of sessienaam;
  
• user, password - de inloggegevens van MongoDB;
  
• database - de naam van de database (standaard: admin).

mongodb.db.discovery[connString,<user>,<password>]

Geeft een lijst van ontdekte databases terug. Gebruikt voor ontdekking op laag niveau.
Retourwaarde: JSON-object.

Parameters:

• connString - de URI of sessienaam;
  
• user, password - de inloggegevens van MongoDB.

mongodb.jumbo_chunks.count[connString,<user>,<password>]

Geeft het aantal jumbo-chunks terug.
Retourwaarde: JSON-object.

Parameters:

• connString - de URI of sessienaam;
  
• user, password - de inloggegevens van MongoDB.

mongodb.oplog.stats[connString,<user>,<password>]

Geeft de status van de replica set terug, met behulp van gegevens die zijn opgehaald uit het oplog.
Retourwaarde: JSON-object.

Parameters:

• connString - de URI of sessienaam;
  
• user, password - de inloggegevens van MongoDB.

mongodb.ping[connString,<user>,<password>]

Test of er een verbinding actief is of niet.
Retourwaarde: 1 - de verbinding is actief; 0 - de verbinding is verbroken (als er fouten zijn, inclusief AUTH- en configuratieproblemen).

Parameters:

• connString - de URI of sessienaam;
  
• user, password - de inloggegevens van MongoDB.

mongodb.rs.config[connString,<user>,<password>]

Returns the current configuration of the replica set.
Return value: JSON object.

Parameters:

• connString - the URI or session name;
  
• user, password - the MongoDB login credentials.
  

mongodb.rs.status[connString,<user>,<password>]

Returns the replica set status from the point of view of the member where the method is run.
Return value: JSON object.

Parameters:

• connString - the URI or session name;
  
• user, password - the MongoDB login credentials.
  

mongodb.server.status[connString,<user>,<password>]

Returns the database state.
Return value: JSON object.

Parameters:

• connString - the URI or session name;
  
• user, password - the MongoDB login credentials.
  

mongodb.sh.discovery[connString,<user>,<password>]

Returns the list of discovered shards present in the cluster.
Return value: JSON object.

Parameters:

• connString - the URI or session name;
  
• user, password - the MongoDB login credentials.
  

mongodb.version[connString,<user>,<password>]

Returns the database server version.
Return value: String.

Parameters:

• connString - the URI or session name;
  
• user, password - the MongoDB login credentials.
  

mqtt.get[<broker url>,topic,<user>,<password>]

Subscribes to a specific topic or topics (with wildcards) of the provided broker and waits for publications.
Return value: Depending on the topic content. If wildcards are used, returns topic content as JSON.

Parameters:

• broker url - the MQTT broker URL in the format protocol://host:port without query parameters (supported protocols: tcp, ssl, ws). If no value is specified, the agent will use tcp://localhost:1883. If a protocol or port is omitted, the default protocol (tcp) or port (1883) will be used;
  
• topic - the MQTT topic (mandatory). Wildcards (+,#) are supported;
  
• user, password - the authentication credentials (if required).
  

Comments:

• The item must be configured as an active check ('Zabbix agent (active)' item type);
• TLS encryption certificates can be used by saving them into a default location (e.g. /etc/ssl/certs/ directory for Ubuntu). For TLS, use the tls:// scheme.

mssql.availability.group.get[URI,<user>,<password>]

Returns availability groups.
Return value: JSON object.

Parameters:

• URI - MSSQL server URI (the only supported schema is sqlserver://). Embedded credentials will be ignored;
  
• user, password - username, password to send to protected MSSQL server.
  

Supported since Zabbix 6.4.12. For more information see the MSSQL plugin readme.

mssql.custom.query[URI,<user>,<password>,queryName,<args...>]

Returns the result of a custom query.
Return value: JSON object.

Parameters:

• URI - MSSQL server URI (the only supported schema is sqlserver://). Embedded credentials will be ignored;
  
• user, password - username, password to send to protected MSSQL server;
  
• queryName - name of a custom query configured in Plugins.MSSQL.CustomQueriesDir without the .sql extension;
  
• args - one or several comma-separated arguments to pass to a query.

Supported since Zabbix 6.4.12. For more information see the MSSQL plugin readme.

mssql.db.get

Returns all available MSSQL databases.
Return value: JSON object.

Supported since Zabbix 6.4.12. For more information see the MSSQL plugin readme.

mssql.job.status.get

Returns the status of jobs.
Return value: JSON object.

Supported since Zabbix 6.4.12. For more information see the MSSQL plugin readme.

mssql.last.backup.get

Returns the last backup time for all databases.
Return value: JSON object.

Supported since Zabbix 6.4.12. For more information see the MSSQL plugin readme.

mssql.local.db.get

Returns databases that are participating in an Always On availability group and replica (primary or secondary) and are located on the server that the connection was established to.
Return value: JSON object.

Supported since Zabbix 6.4.12. For more information see the MSSQL plugin readme.

mssql.mirroring.get

Returns mirroring info.
Return value: JSON object.

Supported since Zabbix 6.4.12. For more information see the MSSQL plugin readme.

mssql.nonlocal.db.get

Returns databases that are participating in an Always On availability group and replica (primary or secondary) located on other servers (the database is not local to the SQL Server instance that the connection was established to).
Return value: JSON object.

Supported since Zabbix 6.4.12. For more information see the MSSQL plugin readme.

mssql.perfcounter.get

Returns the performance counters.
Return value: JSON object.

Supported since Zabbix 6.4.12. For more information see the MSSQL plugin readme.

mssql.ping

Ping the database. Test if connection is correctly configured.
Return value: 1 - alive, 0 - not alive.

Supported since Zabbix 6.4.12. For more information see the MSSQL plugin readme.

mssql.quorum.get

Returns the quorum info.
Return value: JSON object.

Supported since Zabbix 6.4.12. For more information see the MSSQL plugin readme.

mssql.quorum.member.get

Returns the quorum members.
Return value: JSON object.

Supported since Zabbix 6.4.12. For more information see the MSSQL plugin readme.

mssql.replica.get

Returns the replicas.
Return value: JSON object.

Supported since Zabbix 6.4.12. For more information see the MSSQL plugin readme.

mssql.version

Returns the MSSQL version.
Return value: String.

Supported since Zabbix 6.4.12. For more information see the MSSQL plugin readme.

mysql.custom.query[connString,<user>,<password>,queryName,<args...>]

Returns the result of a custom query.
Return value: JSON object.

Parameters:

• connString - URI or session name;
  
• user, password - MySQL login credentials;
  
• queryName - name of a custom query, must match SQL file name without an extension;
  
• args - one or several comma-separated arguments to pass to a query.

Supported since Zabbix 6.4.6.

mysql.db.discovery[connString,<user>,<password>]

Returns the list of MySQL databases. Used for low-level discovery.
Return value: The result of the "show databases" SQL query in LLD JSON format.

Parameters:

• connString - the URI or session name;
  
• user, password - the MySQL login credentials.
  

mysql.db.size[connString,<user>,<password>,<database name>]

The database size in bytes.
Return value: Result of the "select coalesce(sum(data_length + index_length),0) as size from information_schema.tables where table_schema=?" SQL query for a specific database in bytes.

Parameters:

• connString - the URI or session name;
  
• user, password - the MySQL login credentials;
  
• database name - the database name.

mysql.get_status_variables[connString,<user>,<password>]

Values of the global status variables.
Return value: Result of the "show global status" SQL query in JSON format.

Parameters:

• connString - the URI or session name;
  
• user, password - the MySQL login credentials.
  

mysql.ping[connString,<user>,<password>]

Test if a connection is alive or not.
Return value: 1 - the connection is alive; 0 - the connection is broken (if there is any error presented including AUTH and configuration issues).

Parameters:

• connString - the URI or session name;
  
• user, password - the MySQL login credentials.
  

mysql.replication.discovery[connString,<user>,<password>]

Returns the list of MySQL replications. Used for low-level discovery.
Return value: The result of the "show slave status" SQL query in LLD JSON format.

Parameters:

• connString - the URI or session name;
  
• user, password - the MySQL login credentials.
  

mysql.replication.get_slave_status[connString,<user>,<password>,<master host>]

The replication status.
Return value: Result of the "show slave status" SQL query in JSON format.

Parameters:

• connString - the URI or session name;
  
• user, password - the MySQL login credentials;
  
• master host - the replication master host name.
  

mysql.version[connString,<user>,<password>]

The MySQL version.
Return value: String (with the MySQL instance version).

Parameters:

• connString - the URI or session name;
  
• user, password - the MySQL login credentials.
  

oracle.diskgroups.stats[connString,<user>,<password>,<service>,<diskgroup>]

Returns the Automatic Storage Management (ASM) disk groups statistics.
Return value: JSON object.

Parameters:

• connString - the URI or session name;
  
• user - the Oracle username, supports appending one of the login options as sysdba, as sysoper, or as sysasm in the format user as sysdba (a login option is case-insensitive, must not contain a trailing space);
  
• password - the Oracle password;
  
• service - the Oracle service name;
  
• diskgroup - the name of the ASM disk group to query.

oracle.diskgroups.discovery[connString,<user>,<password>,<service>]

Returns the list of ASM disk groups. Used for low-level discovery.
Return value: JSON object.

Parameters:

• connString - the URI or session name;
  
• user - the Oracle username, supports appending one of the login options as sysdba, as sysoper, or as sysasm in the format user as sysdba (a login option is case-insensitive, must not contain a trailing space);
  
• password - the Oracle password;
  
• service - the Oracle service name.
  

oracle.archive.info[connString,<user>,<password>,<service>,<destination>]

De statistieken van archieflogboeken.
Retourwaarden: JSON-object.

Parameters:

• connString - de URI of sessienaam;
  
• user - de Oracle-gebruikersnaam, ondersteunt het toevoegen van een van de aanmeldingsopties as sysdba, as sysoper of as sysasm in het formaat gebruiker as sysdba (een aanmeldingsoptie is hoofdletterongevoelig, mag geen spaties aan het einde bevatten);
  
• password - het Oracle-wachtwoord;
  
• service - de naam van de Oracle-service;
  
• destination - de naam van de bestemming om op te vragen.

oracle.cdb.info[connString,<user>,<password>,<service>,<database>]

Informatie over Containerdatabases (CDB's).
Retourwaarden: JSON-object.

Parameters:

• connString - de URI of sessienaam;
  
• user - de Oracle-gebruikersnaam, ondersteunt het toevoegen van een van de aanmeldingsopties as sysdba, as sysoper of as sysasm in het formaat gebruiker as sysdba (een aanmeldingsoptie is hoofdletterongevoelig, mag geen spaties aan het einde bevatten);
  
• password - het Oracle-wachtwoord;
  
• service - de naam van de Oracle-service;
  
• database - de naam van de database om op te vragen.

oracle.custom.query[connString,<user>,<password>,<service>,queryName,<args...>]

Het resultaat van een aangepaste query.
Retourwaarden: JSON-object.

Parameters:

• connString - de URI of sessienaam;
  
• user - de Oracle-gebruikersnaam, ondersteunt het toevoegen van een van de aanmeldingsopties as sysdba, as sysoper of as sysasm in het formaat gebruiker as sysdba (een aanmeldingsoptie is hoofdletterongevoelig, mag geen spaties aan het einde bevatten);
  
• password - het Oracle-wachtwoord;
  
• service - de naam van de Oracle-service;
  
• queryName - de naam van een aangepaste query, moet overeenkomen met de naam van het SQL-bestand zonder extensie;
• args - één of meerdere door komma's gescheiden argumenten om door te geven aan de query.

oracle.datafiles.stats[connString,<user>,<password>,<service>]

Geeft de statistieken van gegevensbestanden terug.
Retourwaarden: JSON-object.

Parameters:

• connString - de URI of sessienaam;
  
• user - de Oracle-gebruikersnaam, ondersteunt het toevoegen van een van de aanmeldingsopties "as sysdba", "as sysoper" of "as sysasm" in het formaat "gebruiker as sysdba" (een aanmeldingsoptie is hoofdletterongevoelig, mag geen spaties aan het einde bevatten);
  
• password - het Oracle-wachtwoord;
  
• service - de naam van de Oracle-service;
  
• diskgroup - de naam van de ASM-diskgroep om op te vragen.

oracle.db.discovery[connString,<user>,<password>,<service>]

Geeft de lijst van databases terug. Gebruikt voor laag-niveau ontdekking.
Retourwaarden: JSON-object.

Parameters:

• connString - de URI of sessienaam;
  
• user - de Oracle-gebruikersnaam, ondersteunt het toevoegen van een van de aanmeldingsopties "as sysdba", "as sysoper" of "as sysasm" in het formaat "gebruiker as sysdba" (een aanmeldingsoptie is hoofdletterongevoelig, mag geen spaties aan het einde bevatten);
  
• password - het Oracle-wachtwoord;
  
• service - de naam van de Oracle-service.
  

oracle.fra.stats[connString,<user>,<password>,<service>]

Geeft de statistieken van de Fast Recovery Area (FRA) terug.
Retourwaarden: JSON-object.

Parameters:

• connString - de URI of sessienaam;
  
• user - de Oracle-gebruikersnaam, ondersteunt het toevoegen van een van de aanmeldingsopties "as sysdba", "as sysoper" of "as sysasm" in het formaat "gebruiker as sysdba" (een aanmeldingsoptie is hoofdletterongevoelig, mag geen spaties aan het einde bevatten);
  
• password - het Oracle-wachtwoord;
  
• service - de naam van de Oracle-service.
  

oracle.instance.info[connString,<user>,<password>,<service>]

De statistieken van de instantie.
Retourwaarden: JSON-object.

Parameters:

• connString - de URI of sessienaam;
  
• user - de Oracle-gebruikersnaam, ondersteunt het toevoegen van een van de aanmeldingsopties "as sysdba", "as sysoper" of "as sysasm" in het formaat "gebruiker as sysdba" (een aanmeldingsoptie is hoofdletterongevoelig, mag geen spaties aan het einde bevatten);
  
• password - het Oracle-wachtwoord;
  
• service - de naam van de Oracle-service.
  

oracle.pdb.info[connString,<user>,<password>,<service>,<database>]

De informatie over Pluggable Databases (PDB's).
Retourwaarden: JSON-object.

Parameters:

• connString - de URI of sessienaam;
  
• user - de Oracle-gebruikersnaam, ondersteunt het toevoegen van een van de aanmeldingsopties "as sysdba", "as sysoper" of "as sysasm" in het formaat "gebruiker as sysdba" (een aanmeldingsoptie is hoofdletterongevoelig, mag geen spaties aan het einde bevatten);
  
• password - het Oracle-wachtwoord;
  
• service - de naam van de Oracle-service;
  
• database - de naam van de database om op te vragen.

oracle.pdb.discovery[connString,<user>,<password>,<service>]

Geeft de lijst van PDB's terug. Gebruikt voor laag-niveau ontdekking.
Retourwaarden: JSON-object.

Parameters:

• connString - de URI of sessienaam;
  
• user - de Oracle-gebruikersnaam, ondersteunt het toevoegen van een van de aanmeldingsopties "as sysdba", "as sysoper" of "as sysasm" in het formaat "gebruiker as sysdba" (een aanmeldingsoptie is hoofdletterongevoelig, mag geen spaties aan het einde bevatten);
  
• password - het Oracle-wachtwoord;
  
• service - de naam van de Oracle-service.
  

oracle.pga.stats[connString,<user>,<password>,<service>]

Geeft de statistieken van de Program Global Area (PGA) terug.
Retourwaarden: JSON-object.

Parameters:

• connString - de URI of sessienaam;
  
• user - de Oracle-gebruikersnaam, ondersteunt het toevoegen van een van de aanmeldingsopties "as sysdba", "as sysoper" of "as sysasm" in het formaat "gebruiker as sysdba" (een aanmeldingsoptie is hoofdletterongevoelig, mag geen spaties aan het einde bevatten);
  
• password - het Oracle-wachtwoord;
  
• service - de naam van de Oracle-service.
  

oracle.ping[connString,<user>,<password>,<service>]

Test of er een verbinding met Oracle kan worden gemaakt.
Retourwaarde: 1 - de verbinding is succesvol; 0 - de verbinding is verbroken (bij foutmeldingen inclusief AUTH- en configuratieproblemen).

Parameters:

• connString - de URI of sessienaam;
  
• user - de Oracle-gebruikersnaam, ondersteunt het toevoegen van een van de aanmeldingsopties "as sysdba", "as sysoper" of "as sysasm" in het formaat "gebruiker as sysdba" (een aanmeldingsoptie is hoofdletterongevoelig, mag geen spaties aan het einde bevatten);
  
• password - het Oracle-wachtwoord;
  
• service - de naam van de Oracle-service.
  

oracle.proc.stats[connString,<user>,<password>,<service>]

Geeft de statistieken van de processen terug.
Retourwaarden: JSON-object.

Parameters:

• connString - de URI of sessienaam;
  
• user - de Oracle-gebruikersnaam, ondersteunt het toevoegen van een van de aanmeldingsopties "as sysdba", "as sysoper" of "as sysasm" in het formaat "gebruiker as sysdba" (een aanmeldingsoptie is hoofdletterongevoelig, mag geen spaties aan het einde bevatten);
  
• password - het Oracle-wachtwoord;
  
• service - de naam van de Oracle-service.
  

oracle.redolog.info[connString,<user>,<password>,<service>]

De informatie van het logbestand uit het controlebestand.
Retourwaarden: JSON-object.

Parameters:

• connString - de URI of sessienaam;
  
• user - de Oracle-gebruikersnaam, ondersteunt het toevoegen van een van de aanmeldingsopties "as sysdba", "as sysoper" of "as sysasm" in het formaat "gebruiker as sysdba" (een aanmeldingsoptie is hoofdletterongevoelig, mag geen spaties aan het einde bevatten);
  
• password - het Oracle-wachtwoord;
  
• service - de naam van de Oracle-service.
  

oracle.sga.stats[connString,<user>,<password>,<service>]

Geeft de statistieken van de System Global Area (SGA) terug.
Retourwaarden: JSON-object.

Parameters:

• connString - de URI of sessienaam;
  
• user - de Oracle-gebruikersnaam, ondersteunt het toevoegen van een van de aanmeldingsopties "as sysdba", "as sysoper" of "as sysasm" in het formaat "gebruiker as sysdba" (een aanmeldingsoptie is hoofdletterongevoelig, mag geen spaties aan het einde bevatten);
  
• password - het Oracle-wachtwoord;
  
• service - de naam van de Oracle-service.
  

oracle.sessions.stats[connString,<user>,<password>,<service>,<lockMaxTime>]

Geeft de statistieken van de sessies terug.
Retourwaarden: JSON-object.

Parameters:

• connString - de URI of sessienaam;
  
• user - de Oracle-gebruikersnaam, ondersteunt het toevoegen van een van de aanmeldingsopties "as sysdba", "as sysoper" of "as sysasm" in het formaat "gebruiker as sysdba" (een aanmeldingsoptie is hoofdletterongevoelig, mag geen spaties aan het einde bevatten);
  
• password - het Oracle-wachtwoord;
  
• service - de naam van de Oracle-service;
  
• lockMaxTime - de maximale duur van sessievergrendeling in seconden om de sessie te tellen als langdurig vergrendeld. Standaard: 600 seconden.

oracle.sys.metrics[connString,<user>,<password>,<service>,<duration>]

Geeft een reeks waarden van systeemmetingen terug.
Retourwaarden: JSON-object.

Parameters:

• connString - de URI of sessienaam;
  
• user - de Oracle-gebruikersnaam, ondersteunt het toevoegen van een van de aanmeldingsopties "as sysdba", "as sysoper" of "as sysasm" in het formaat "gebruiker as sysdba" (een aanmeldingsoptie is hoofdletterongevoelig, mag geen spaties aan het einde bevatten);
  
• password - het Oracle-wachtwoord;
  
• service - de naam van de Oracle-service;
  
• duration - het opname-interval (in seconden) van systeemmetingen. Mogelijke waarden: 60 - lange duur (standaard), 15 - korte duur.

oracle.sys.params[connString,<user>,<password>,<service>]

Geeft een reeks waarden van systeemparameters terug.
Retourwaarden: JSON-object.

Parameters:

• connString - de URI of sessienaam;
  
• user - de Oracle-gebruikersnaam, ondersteunt het toevoegen van een van de aanmeldingsopties "as sysdba", "as sysoper" of "as sysasm" in het formaat "gebruiker as sysdba" (een aanmeldingsoptie is hoofdletterongevoelig, mag geen spaties aan het einde bevatten);
  
• password - het Oracle-wachtwoord;
  
• service - de naam van de Oracle-service.
  

oracle.ts.stats[connString,<user>,<password>,<service>,<tablespace>,<type>]

Geeft de statistieken van de tablespaces terug.
Retourwaarden: JSON-object.

Parameters:

• connString - de URI of sessienaam;
  
• user - de Oracle-gebruikersnaam, ondersteunt het toevoegen van een van de aanmeldingsopties "as sysdba", "as sysoper" of "as sysasm" in het formaat "gebruiker as sysdba" (een aanmeldingsoptie is hoofdletterongevoelig, mag geen spaties aan het einde bevatten);
  
• password - het Oracle-wachtwoord;
  
• service - de naam van de Oracle-service;
  
• tablespace - naam van de tablespace om op te vragen. Standaard (indien leeg gelaten en type is ingesteld):
  - "TEMP" (indien type is ingesteld op "TEMPORARY");
  - "USERS" (indien type is ingesteld op "PERMANENT").
• type - het type tablespace om op te vragen. Standaard (indien tablespace is ingesteld): "PERMANENT".

oracle.ts.discovery[connString,<user>,<password>,<service>]

Geeft een lijst van tablespaces terug. Gebruikt voor laag-niveau ontdekking.
Retourwaarden: JSON-object.

Parameters:

• connString - de URI of sessienaam;
  
• user - de Oracle-gebruikersnaam, ondersteunt het toevoegen van een van de aanmeldingsopties "as sysdba", "as sysoper" of "as sysasm" in het formaat "gebruiker as sysdba" (een aanmeldingsoptie is hoofdletterongevoelig, mag geen spaties aan het einde bevatten);
  
• password - het Oracle-wachtwoord;
  
• service - de naam van de Oracle-service.

oracle.user.info[connString,<user>,<password>,<service>,<username>]

Geeft informatie over de Oracle-gebruiker terug.
Retourwaarden: JSON-object.

Parameters:

• connString - de URI of sessienaam;
  
• user - de Oracle-gebruikersnaam, ondersteunt het toevoegen van een van de aanmeldingsopties "as sysdba", "as sysoper" of "as sysasm" in het formaat "gebruiker as sysdba" (een aanmeldingsoptie is hoofdletterongevoelig, mag geen spaties aan het einde bevatten);
  
• password - het Oracle-wachtwoord;
  
• service - de naam van de Oracle-service;
  
• username - de gebruikersnaam waarvoor de informatie nodig is. Gebruikersnamen in kleine letters worden niet ondersteund. Standaard: huidige gebruiker.

oracle.version[connString,<user>,<password>,<service>] {oracle.version}

Returns the database server version.
Return value: String.

Parameters:

• connString - the URI or session name;
  
• user - the Oracle username, supports appending one of the login options as sysdba, as sysoper, or as sysasm in the format user as sysdba (a login option is case-insensitive, must not contain a trailing space);
  
• password - the Oracle password;
  
• service - the Oracle service name.

pgsql.autovacuum.count[uri,<username>,<password>,<database name>]

Het aantal autovacuum-werkers.
Retourwaarden: Geheel getal (integer).

Parameters:

• uri - de URI of sessienaam;
  
• username, password - de PostgreSQL-inloggegevens;
  
• database name - de naam van de database.
  

pgsql.archive[uri,<username>,<password>,<database name>]

De informatie over gearchiveerde bestanden.
Retourwaarden: JSON-object.

Parameters:

• uri - de URI of sessienaam;
  
• username, password - de PostgreSQL-inloggegevens;
  
• database name - de naam van de database.
  

De geretourneerde gegevens worden verwerkt door afhankelijke items:

• pgsql.archive.count_archived_files - het aantal WAL-bestanden dat succesvol is gearchiveerd;
  
• pgsql.archive.failed_trying_to_archive - het aantal mislukte pogingen om WAL-bestanden te archiveren;
  
• pgsql.archive.count_files_to_archive - het aantal bestanden om te archiveren;
  
• pgsql.archive.size_files_to_archive - de grootte van de te archiveren bestanden.

pgsql.bgwriter[uri,<username>,<password>,<database name>]

Het gecombineerde aantal checkpoints voor de databasemcluster, opgesplitst naar het type checkpoint.
Retourwaarden: JSON-object.

Parameters:

• uri - de URI of sessienaam;
  
• username, password - de PostgreSQL-inloggegevens;
  
• database name - de naam van de database.
  

De geretourneerde gegevens worden verwerkt door afhankelijke items:

• pgsql.bgwriter.buffers_alloc - het aantal toegewezen buffers;
  
• pgsql.bgwriter.buffers_backend - het aantal buffers dat rechtstreeks door een backend is geschreven;
  
• pgsql.bgwriter.maxwritten_clean - het aantal keren dat de achtergrondschrijver een schoonmaakscan heeft gestopt, omdat het te veel buffers had geschreven;
  
• pgsql.bgwriter.buffers_backend_fsync - het aantal keren dat een backend zijn eigen fsync-oproep moest uitvoeren in plaats van de achtergrondschrijver;
• pgsql.bgwriter.buffers_clean - het aantal buffers dat door de achtergrondschrijver is geschreven;
• pgsql.bgwriter.buffers_checkpoint - het aantal buffers dat tijdens checkpoints is geschreven;
• pgsql.bgwriter.checkpoints_timed - het aantal geplande checkpoints dat is uitgevoerd;
• pgsql.bgwriter.checkpoints_req - het aantal aangevraagde checkpoints dat is uitgevoerd;
• pgsql.bgwriter.checkpoint_write_time - de totale tijd die is besteed aan het deel van de checkpoint-verwerking waarbij bestanden naar schijf worden geschreven, in milliseconden;
• pgsql.bgwriter.sync_time - de totale tijd die is besteed aan het deel van de checkpoint-verwerking waarbij bestanden worden gesynchroniseerd met schijf.

pgsql.cache.hit[uri,<username>,<password>,<database name>]

De trefkans in de PostgreSQL-buffercache.
Retourwaarden: Getal met decimalen (float).

Parameters:

• uri - de URI of sessienaam;
  
• username, password - de PostgreSQL-inloggegevens;
  
• database name - de naam van de database.
  

pgsql.connections[uri,<username>,<password>,<database name>]

Geeft verbindingen weer per type.
Retourwaarden: JSON-object.

Parameters:

• uri - de URI of sessienaam;
  
• username, password - de PostgreSQL-inloggegevens;
  
• database name - de naam van de database.
  

De geretourneerde gegevens worden verwerkt door afhankelijke items:

• pgsql.connections.active - de backend voert een query uit;
  
• pgsql.connections.fastpath_function_call - de backend voert een snelpadfunctie uit;
  
• pgsql.connections.idle - de backend wacht op een nieuwe opdracht van de client;
  
• pgsql.connections.idle_in_transaction - de backend is in een transactie, maar voert momenteel geen query uit;
  
• pgsql.connections.prepared - het aantal voorbereide verbindingen;
  
• pgsql.connections.total - het totale aantal verbindingen;
  
• pgsql.connections.total_pct - percentage van het totale aantal verbindingen ten opzichte van de instelling 'max_connections' van de PostgreSQL-server;
  
• pgsql.connections.waiting - aantal verbindingen in een query;
  
• pgsql.connections.idle_in_transaction_aborted - de backend is in een transactie, maar voert momenteel geen query uit en een van de instructies in de transactie heeft een fout veroorzaakt.

pgsql.custom.query[uri,<username>,<password>,queryName,<args...>]

Geeft het resultaat terug van een aangepaste query.
Retourwaarden: JSON-object.

Parameters:

• uri - de URI of sessienaam;
  
• username, password - de PostgreSQL-inloggegevens;
  
• queryName - de naam van een aangepaste query, moet overeenkomen met de bestandsnaam van het SQL-bestand zonder extensie;
  
• args - één of meerdere argumenten, gescheiden door komma's, om aan een query door te geven.

pgsql.db.age[uri,<username>,<password>,<database name>]

De leeftijd van de oudste FrozenXID van de database.
Retourwaarden: Geheel getal (integer).

Parameters:

• uri - de URI of sessienaam;
  
• username, password - de PostgreSQL-inloggegevens;
  
• database name - de naam van de database.
  

pgsql.db.bloating_tables[uri,<username>,<password>,<database name>]

Het aantal opgeblazen tabellen per database.
Retourwaarden: Geheel getal (integer).

Parameters:

• uri - de URI of sessienaam;
  
• username, password - de PostgreSQL-inloggegevens;
  
• database name - de naam van de database.
  

pgsql.db.discovery[uri,<username>,<password>,<database name>]

De lijst met PostgreSQL-databases. Gebruikt voor laag-niveau ontdekking.
Retourwaarden: JSON-object.

Parameters:

• uri - de URI of sessienaam;
  
• username, password - de PostgreSQL-inloggegevens;
  
• database name - de naam van de database.
  

pgsql.db.size[uri,<username>,<password>,<database name>]

De grootte van de database in bytes.
Retourwaarden: Geheel getal (integer).

Parameters:

• uri - de URI of sessienaam;
  
• username, password - de PostgreSQL-inloggegevens;
  
• database name - de naam van de database.
  

pgsql.dbstat[uri,<username>,<password>,<database name>]

Verzamelt de statistieken per database. Gebruikt voor laag-niveau ontdekking.
Retourwaarden: JSON-object.

Parameters:

• uri - de URI of sessienaam;
  
• username, password - de PostgreSQL-inloggegevens;
  
• database name - de naam van de database.
  

De geretourneerde gegevens worden verwerkt door afhankelijke items:

• pgsql.dbstat.numbackends["{#DBNAME}"] - het aantal achtergrondprocessen dat momenteel verbonden is met deze database;
  
• pgsql.dbstat.sum.blk_read_time["{#DBNAME}"] - de tijd die achtergrondprocessen in deze database besteden aan het lezen van datablokken, in milliseconden;
  
• pgsql.dbstat.sum.blk_write_time["{#DBNAME}"] - de tijd die achtergrondprocessen in deze database besteden aan het schrijven van datablokken, in milliseconden;
  
• pgsql.dbstat.sum.checksum_failures["{#DBNAME}"] - het aantal mislukte controlegetallen voor gegevenspagina's dat is gedetecteerd (of op een gedeeld object), of NULL als gegevenscontroles niet zijn ingeschakeld (alleen PostgreSQL versie 12);
  
• pgsql.dbstat.blks_read.rate["{#DBNAME}"] - het aantal schijfblokken dat in deze database is gelezen;
  
• pgsql.dbstat.deadlocks.rate["{#DBNAME}"] - het aantal deadlocks dat is gedetecteerd in deze database;
  
• pgsql.dbstat.blks_hit.rate["{#DBNAME}"] - het aantal keren dat schijfblokken al in de buffercache zijn gevonden, zodat een leesbewerking niet nodig was (dit omvat alleen hits in de PostgreSQL Pro-buffercache, niet de bestandssysteemcache van het besturingssysteem);
  
• pgsql.dbstat.xact_rollback.rate["{#DBNAME}"] - het aantal transacties in deze database dat is teruggedraaid;
  
• pgsql.dbstat.xact_commit.rate["{#DBNAME}"] - het aantal transacties in deze database dat is voltooid;
  
• pgsql.dbstat.tup_updated.rate["{#DBNAME}"] - het aantal rijen dat is bijgewerkt door query's in deze database;
  
• pgsql.dbstat.tup_returned.rate["{#DBNAME}"] - het aantal rijen dat is geretourneerd door query's in deze database;
  
• pgsql.dbstat.tup_inserted.rate["{#DBNAME}"] - het aantal rijen dat is ingevoegd door query's in deze database;
  
• pgsql.dbstat.tup_fetched.rate["{#DBNAME}"] - het aantal rijen dat is opgehaald door query's in deze database;
  
• pgsql.dbstat.tup_deleted.rate["{#DBNAME}"] - het aantal rijen dat is verwijderd door query's in deze database;
  
• pgsql.dbstat.conflicts.rate["{#DBNAME}"] - het aantal query's dat is geannuleerd vanwege conflicten met herstel in deze database (de conflicten treden alleen op bij standby-servers);
  
• pgsql.dbstat.temp_files.rate["{#DBNAME}"] - het aantal tijdelijke bestanden dat is gemaakt door query's in deze database. Alle tijdelijke bestanden worden geteld, ongeacht de instellingen voor log_temp_files en de redenen waarom het tijdelijke bestand is gemaakt (bijvoorbeeld sorteren of hashen);
  
• pgsql.dbstat.temp_bytes.rate["{#DBNAME}"] - de totale hoeveelheid gegevens die door query's in deze database naar tijdelijke bestanden is geschreven. Inclusief gegevens uit alle tijdelijke bestanden, ongeacht de instellingen voor log_temp_files en de redenen waarom het tijdelijke bestand is gemaakt (bijvoorbeeld sorteren of hashen).

pgsql.dbstat.sum[uri,<username>,<password>,<database name>]

De samengevatte gegevens voor alle databases in een cluster.
Retourwaarden: JSON-object.

Parameters:

• uri - de URI of sessienaam;
  
• username, password - de PostgreSQL-inloggegevens;
  
• database name - de naam van de database.
  

De geretourneerde gegevens worden verwerkt door afhankelijke items:

• pgsql.dbstat.numbackends - het aantal achtergrondprocessen dat momenteel verbonden is met deze database;
  
• pgsql.dbstat.sum.blk_read_time - de tijd die achtergrondprocessen in deze database besteden aan het lezen van datablokken, in milliseconden;
  
• pgsql.dbstat.sum.blk_write_time - de tijd die achtergrondprocessen in deze database besteden aan het schrijven van datablokken, in milliseconden;
  
• pgsql.dbstat.sum.checksum_failures - het aantal mislukte controlegetallen voor gegevenspagina's dat is gedetecteerd (of op een gedeeld object), of NULL als gegevenscontroles niet zijn ingeschakeld (alleen PostgreSQL versie 12);
  
• pgsql.dbstat.sum.xact_commit - het aantal transacties in deze database dat is voltooid;
  
• pgsql.dbstat.sum.conflicts - databasestatistieken over query's die zijn geannuleerd vanwege conflicten met herstel op standby-servers;
  
• pgsql.dbstat.sum.deadlocks - het aantal deadlocks dat is gedetecteerd in deze database;
  
• pgsql.dbstat.sum.blks_read - het aantal schijfblokken dat in deze database is gelezen;
  
• pgsql.dbstat.sum.blks_hit - het aantal keren dat schijfblokken al in de buffercache zijn gevonden, zodat een leesbewerking niet nodig was (alleen hits in de PostgreSQL Pro-buffercache zijn inbegrepen);
  
• pgsql.dbstat.sum.temp_bytes - de totale hoeveelheid gegevens die door query's in deze database naar tijdelijke bestanden is geschreven. Inclusief gegevens uit alle tijdelijke bestanden, ongeacht de instellingen voor log_temp_files en de redenen waarom het tijdelijke bestand is gemaakt (bijvoorbeeld sorteren of hashen);
  
• pgsql.dbstat.sum.temp_files - het aantal tijdelijke bestanden dat is gemaakt door query's in deze database. Alle tijdelijke bestanden worden geteld, ongeacht de instellingen voor log_temp_files en de redenen waarom het tijdelijke bestand is gemaakt (bijvoorbeeld sorteren of hashen);
  
• pgsql.dbstat.sum.xact_rollback - het aantal teruggedraaide transacties in deze database;
  
• pgsql.dbstat.sum.tup_deleted - het aantal rijen dat is verwijderd door query's in deze database;
  
• pgsql.dbstat.sum.tup_fetched - het aantal rijen dat is opgehaald door query's in deze database;
  
• pgsql.dbstat.sum.tup_inserted - het aantal rijen dat is ingevoegd door query's in deze database;
  
• pgsql.dbstat.sum.tup_returned - het aantal rijen dat is geretourneerd door query's in deze database;
  
• pgsql.dbstat.sum.tup_updated - het aantal rijen dat is bijgewerkt door query's in deze database.

pgsql.locks[uri,<username>,<password>,<database name>]

De informatie over toegekende vergrendelingen per database. Gebruikt voor lage-niveau ontdekking.
Retourwaarde: JSON-object.

Parameters:

• uri - de URI of sessienaam;
  
• username, password - de PostgreSQL-inloggegevens;
  
• database name - de naam van de database.
  

De geretourneerde gegevens worden verwerkt door afhankelijke items:

• pgsql.locks.shareupdateexclusive["{#DBNAME}"] - het aantal share update exclusive-vergrendelingen;
  
• pgsql.locks.accessexclusive["{#DBNAME}"] - het aantal access exclusive-vergrendelingen;
  
• pgsql.locks.accessshare["{#DBNAME}"] - het aantal access share-vergrendelingen;
  
• pgsql.locks.exclusive["{#DBNAME}"] - het aantal exclusive-vergrendelingen;
  
• pgsql.locks.rowexclusive["{#DBNAME}"] - het aantal row exclusive-vergrendelingen;
  
• pgsql.locks.rowshare["{#DBNAME}"] - het aantal row share-vergrendelingen;
  
• pgsql.locks.share["{#DBNAME}"] - het aantal shared-vergrendelingen;
  
• pgsql.locks.sharerowexclusive["{#DBNAME}"] - het aantal share row exclusive-vergrendelingen.

pgsql.oldest.xid[uri,<username>,<password>,<database name>]

De leeftijd van de oudste XID (Transaction ID).
Retourwaarde: Integer.

Parameters:

• uri - de URI of sessienaam;
  
• username, password - de PostgreSQL-inloggegevens;
  
• database name - de naam van de database.
  

pgsql.ping[uri,<username>,<password>,<database name>]

Test of een verbinding actief is of niet.
Retourwaarde: 1 - de verbinding is actief; 0 - de verbinding is verbroken (bij fouten, inclusief authenticatie- en configuratieproblemen).

Parameters:

• uri - de URI of sessienaam;
  
• username, password - de PostgreSQL-inloggegevens;
  
• database name - de naam van de database.
  

pgsql.queries[uri,<username>,<password>,<databasenaam>,<tijdsperiode>]

Query-metrics op basis van uitvoeringstijd.
Retourwaarde: JSON-object.

Parameters:

• uri - de URI of sessienaam;
  
• username, password - de PostgreSQL-inloggegevens;
  
• databasenaam - de naam van de database;
  
• tijdsperiode - de uitvoeringstijdlimiet voor het aantal trage queries (moet een positief geheel getal zijn).

De geretourneerde gegevens worden verwerkt door afhankelijke items:

• pgsql.queries.mro.time_max["{#DBNAME}"] - de maximale onderhoudsquerytijd;
  
• pgsql.queries.query.time_max["{#DBNAME}"] - de maximale querytijd;
  
• pgsql.queries.tx.time_max["{#DBNAME}"] - de maximale transactiequerytijd;
  
• pgsql.queries.mro.slow_count["{#DBNAME}"] - het aantal trage onderhoudsquery's;
  
• pgsql.queries.query.slow_count["{#DBNAME}"] - het aantal trage query's;
  
• pgsql.queries.tx.slow_count["{#DBNAME}"] - het aantal trage transactiequery's;
  
• pgsql.queries.mro.time_sum["{#DBNAME}"] - de totale onderhoudsquerytijd;
  
• pgsql.queries.query.time_sum["{#DBNAME}"] - de totale querytijd;
  
• pgsql.queries.tx.time_sum["{#DBNAME}"] - de totale transactiequerytijd.

pgsql.replication.count[uri,<gebruikersnaam>,<wachtwoord>]

Het aantal standby-servers.
Retourwaarde: Geheel getal.

Parameters:

• uri - de URI of sessienaam;
  
• gebruikersnaam, wachtwoord - de PostgreSQL-inloggegevens.

pgsql.replication.process[uri,<gebruikersnaam>,<wachtwoord>]

De flush-vertraging, schrijfvertraging en afspeelvertraging per elk verzendproces.
Retourwaarde: JSON-object.

Parameters:

• uri - de URI of sessienaam;
  
• gebruikersnaam, wachtwoord - de PostgreSQL-inloggegevens.

pgsql.replication.process.discovery[uri,<gebruikersnaam>,<wachtwoord>]

De ontdekking van de namen van replicatieprocessen.
Retourwaarde: JSON-object.

Parameters:

• uri - de URI of sessienaam;
  
• gebruikersnaam, wachtwoord - de PostgreSQL-inloggegevens.

pgsql.replication.recovery_role[uri,<gebruikersnaam>,<wachtwoord>]

De herstelstatus.
Retourwaarde: 0 - mastermodus; 1 - herstel is nog steeds bezig (standbymodus).

Parameters:

• uri - de URI of sessienaam;
  
• gebruikersnaam, wachtwoord - de PostgreSQL-inloggegevens.

pgsql.replication.status[uri,<gebruikersnaam>,<wachtwoord>]

De status van replicatie.
Retourwaarde: 0 - streaming is niet actief; 1 - streaming is actief; 2 - mastermodus.

Parameters:

• uri - de URI of sessienaam;
  
• gebruikersnaam, wachtwoord - de PostgreSQL-inloggegevens.

pgsql.replication_lag.b[uri,<gebruikersnaam>,<wachtwoord>]

De replicatievertraging in bytes.
Retourwaarde: Geheel getal.

Parameters:

• uri - de URI of sessienaam;
  
• gebruikersnaam, wachtwoord - de PostgreSQL-inloggegevens.

pgsql.replication_lag.sec[uri,<gebruikersnaam>,<wachtwoord>]

De replicatievertraging in seconden.
Retourwaarde: Geheel getal.

Parameters:

• uri - de URI of sessienaam;
  
• gebruikersnaam, wachtwoord - de PostgreSQL-inloggegevens.

pgsql.uptime[uri,<gebruikersnaam>,<wachtwoord>,<databasenaam>]

De PostgreSQL-uptime in milliseconden.
Retourwaarde: Decimaal getal.

Parameters:

• uri - de URI of sessienaam;
  
• gebruikersnaam, wachtwoord - de PostgreSQL-inloggegevens;
  
• databasenaam - de naam van de database.
  

pgsql.version[uri,<username>,<password>,<database name>]

Returns PostgreSQL version.
Return value: String.

Parameters:

• uri - the URI or session name;
  
• username, password - the PostgreSQL credentials;
  
• database name - the database name.
  

pgsql.wal.stat[uri,<gebruikersnaam>,<wachtwoord>,<databasenaam>]

De WAL-statistieken.
Retourwaarde: JSON-object.

Parameters:

• uri - de URI of sessienaam;
  
• gebruikersnaam, wachtwoord - de PostgreSQL-inloggegevens;
  
• databasenaam - de naam van de database.
  

De geretourneerde gegevens worden verwerkt door afhankelijke items:

• pgsql.wal.count — het aantal WAL-bestanden;
  
• pgsql.wal.write - de gebruikte WAL-lsn (in bytes).

redis.config[connString,<wachtwoord>,<patroon>]

Haalt de configuratieparameters op van een Redis-instantie die overeenkomen met het patroon.
Retourwaarde: JSON - als een globaal patroon werd gebruikt; enkele waarde - als een patroon geen jokertekens bevatte.

Parameters:

• connString - de URI of sessienaam;
  
• wachtwoord - het Redis-wachtwoord;
  
• patroon - een globaal patroon (* standaard).

redis.info[connString,<wachtwoord>,<sectie>]

Haalt de uitvoer van het INFO-commando op.
Retourwaarde: JSON - de uitvoer wordt geserialiseerd als JSON.

Parameters:

• connString - de URI of sessienaam;
  
• wachtwoord - het Redis-wachtwoord;
  
• sectie - de sectie van informatie (default standaard).
  

redis.ping[connString,<wachtwoord>]

Test of een verbinding al dan niet actief is.
Retourwaarde: 1 - de verbinding is actief; 0 - de verbinding is verbroken (bij elke foutmelding, inclusief AUTH- en configuratieproblemen).

Parameters:

• connString - de URI of sessienaam;
  
• wachtwoord - het Redis-wachtwoord.
  

redis.slowlog.count[connString,<wachtwoord>]

Het aantal trage logboekvermeldingen sinds Redis werd gestart.
Retourwaarde: Geheel getal.

Parameters:

• connString - de URI of sessienaam;
  
• wachtwoord - het Redis-wachtwoord.
  

smart.attribute.discovery

Geeft een lijst van S.M.A.R.T. apparaatattributen terug.
Retourwaarde: JSON-object.

Opmerkingen:

• De volgende macro's en hun waarden worden teruggegeven: {#NAME}, {#DISKTYPE}, {#ID}, {#ATTRNAME}, {#THRESH};
• Ondersteunde schijftypen zijn HDD, SSD en NVME. Schijven kunnen alleen of gecombineerd in een RAID zijn. {#NAME} krijgt een toevoeging in geval van RAID, bijvoorbeeld: {"{#NAME}": "/dev/sda cciss,2"}.

smart.disk.discovery

Geeft een lijst van S.M.A.R.T.-apparaten terug.
Retourwaarde: JSON-object.

Opmerkingen:

• De volgende macro's en hun waarden worden teruggegeven: {#NAME}, {#DISKTYPE}, {#MODEL}, {#SN}, {#PATH}, {#ATTRIBUTES}, {#RAIDTYPE};
• Ondersteunde schijftypen zijn HDD, SSD en NVME. Als een schijf niet tot een RAID behoort, zal {#RAIDTYPE} leeg zijn. {#NAME} krijgt een toevoeging in geval van RAID, bijvoorbeeld: {"{#NAME}": "/dev/sda cciss,2"}.

smart.disk.get[<pad>,<RAID-type>]

Geeft alle beschikbare eigenschappen van S.M.A.R.T.-apparaten terug.
Retourwaarde: JSON-object.

Parameters:

• pad - het schijfpad, de {#PATH}-macro kan als waarde worden gebruikt;
  
• RAID-type - het RAID-type, de {#RAID}-macro kan als waarde worden gebruikt.

Opmerkingen:

• Ondersteunde schijftypen zijn HDD, SSD en NVME. Schijven kunnen alleen of gecombineerd in een RAID zijn;
  
• De gegevens bevatten smartctl-versie en oproepargumenten, evenals aanvullende velden:
  disk_name - bevat de naam met de vereiste toevoegingen voor RAID-ontdekking, bijvoorbeeld: {"disk_name": "/dev/sda cciss,2"}
  disk_type - bevat het schijftype HDD, SSD of NVME, bijvoorbeeld: {"disk_type": "ssd"};
  
• Als er geen parameters worden opgegeven, geeft het item informatie over alle schijven terug.

systemd.unit.get[unit naam,<interface>]

Geeft alle eigenschappen van een systemd-unit terug.
Retourwaarde: JSON-object.

Parameters:

• unit naam - de naam van de unit (je kunt de {#UNIT.NAME}-macro in het item-prototype gebruiken om de naam te ontdekken);
  
• interface - het type van de unit-interface, mogelijke waarden: Unit (standaard), Service, Socket, Device, Mount, Automount, Swap, Target, Path.

Opmerkingen:

• Dit item wordt alleen ondersteund op het Linux-platform;
• LoadState, ActiveState en UnitFileState voor de Unit-interface worden geretourneerd als tekst en geheel getal: "ActiveState":{"state":1,"text":"active"}.

systemd.unit.info[unit naam,<eigenschap>,<interface>]

Informatie over een systemd-unit.
Retourwaarde: String.

Parameters:

• unit naam - de naam van de unit (je kunt de {#UNIT.NAME}-macro in het item-prototype gebruiken om de naam te ontdekken);
  
• eigenschap - unit-eigenschap (bijv. ActiveState (standaard), LoadState, Description);
• interface - het type van de unit-interface (bijv. Unit (standaard), Socket, Service).

Opmerkingen:

• Dit item wordt alleen ondersteund op het Linux-platform;
• Dit item maakt het mogelijk om een specifieke eigenschap op te halen van een specifiek type interface zoals beschreven in dbus API.

Voorbeelden:

systemd.unit.info["{#UNIT.NAME}"] #verzamelt actieve status (actief, herladen, inactief, mislukt, activerend, deactiverend) informatie over ontdekte systemd-units
       systemd.unit.info["{#UNIT.NAME}",LoadState] #verzamelt laadstatusinformatie over ontdekte systemd-units
       systemd.unit.info[mysqld.service,Id] #haalt de technische naam van de service op (mysqld.service)
       systemd.unit.info[mysqld.service,Description] #haalt de beschrijving van de service op (MySQL-server)
       systemd.unit.info[mysqld.service,ActiveEnterTimestamp] #haalt de laatste keer op dat de service de actieve status heeft bereikt (1562565036283903)
       systemd.unit.info[dbus.socket,NConnections,Socket] #verzamelt het aantal verbindingen vanuit deze socket-unit

systemd.unit.discovery[<type>]

Lijst van systemd-units en hun details. Gebruikt voor ontdekking op laag niveau.
Retourwaarde: JSON object.

Parameter:

• type - mogelijke waarden: all, automount, device, mount, path, service (standaard), socket, swap, target.

Dit item wordt alleen ondersteund op het Linux-platform.

web.certificate.get[hostname,<port>,<address>]

Valideert de certificaten en retourneert certificaatgegevens.
Retourwaarde: JSON object.

Parameter:

• hostname - kan zowel IP als DNS zijn.
  Kan het URL-schema (https alleen), pad (wordt genegeerd) en poort bevatten.
  Als een poort wordt opgegeven in zowel de eerste als de tweede parameter, moeten hun waarden overeenkomen.
  Als het adres (de 3e parameter) is gespecificeerd, wordt het hostname alleen gebruikt voor SNI en hostname-verificatie;
  
• port - het poortnummer (standaard is 443 voor HTTPS);
  
• address - kan zowel IP als DNS zijn. Indien gespecificeerd, wordt het gebruikt voor de verbinding en wordt het hostname (de 1e parameter) gebruikt voor SNI en hostverificatie. In het geval dat de 1e parameter een IP is en de 3e parameter een DNS is, wordt de 1e parameter gebruikt voor de verbinding en wordt de 3e parameter gebruikt voor SNI en hostverificatie.

Opmerkingen:

• Dit item wordt niet ondersteund als de bron gespecificeerd in host niet bestaat of niet beschikbaar is, of als de TLS-handshake mislukt met een fout, behalve een ongeldig certificaat;
  
• Momenteel worden AIA (Authority Information Access) X.509-extensie, CRL's en OCSP (inclusief OCSP-stapeling), certificaattransparantie en aangepaste CA-vertrouwensopslagplaats niet ondersteund.