1 Agente Zabbix 2

O Zabbix Agent 2 suporta todas as chaves de item suportadas pelo Zabbix Agent em Unix e Windows. Esta página fornece detalhes sobre as chaves de item adicionais, que podem ser utilizadas apenas com o Zabbix Agent 2, agrupadas pelo plugin ao qual pertencem.

As chaves de item são listadas sem parâmetros e informações adicionais. Clique na chave de item para ver os detalhes completos.

Veja também: Plug-ins integrados

Detalhes principais do item

Os parâmetros sem colchetes angulares são obrigatórios. Os parâmetros marcados com colchetes angulares < > são opcionais.

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

O uso de dados do cluster e a distribuição entre pools.
Valor de retorno: Objeto JSON.

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user, password - as credenciais de login do Ceph.
  

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

Estatísticas agregadas e por OSD.
Valor de retorno: Objeto JSON.

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user, password - as credenciais de login do Ceph.
  

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

A lista de OSDs descobertos. Usada para [descoberta de baixo nível] (/manual/discovery/low_level_discovery).
Valor de retorno: Objeto JSON.

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user, password - as credenciais de login do Ceph.
  

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

Os limites de uso e os status dos OSDs.
Valor de retorno: Objeto JSON.

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user, password - as credenciais de login do Ceph.
  

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

Testa se uma conexão com o Ceph pode ser estabelecida.
Valor de retorno: 0 - a conexão é interrompida (se houver algum erro apresentado, inclusive AUTH e problemas de configuração); 1 - a conexão é bem-sucedida.

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user, password - as credenciais de login do Ceph.
  

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

A lista de pools descobertos. Usada para [descoberta de baixo nível] (/manual/discovery/low_level_discovery).
Valor de retorno: Objeto JSON.

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user, password - as credenciais de login do Ceph.
  

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

O status geral do cluster.
Valor de retorno: Objeto JSON.

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user, password - as credenciais de login do Ceph.
  

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

Informações de baixo nível sobre um contêiner.
Valor de retorno: A saída da chamada da API ContainerInspect serializada como JSON.

Parâmetros:

• ID - a ID ou o nome do contêiner;
  
• info - a quantidade de informações retornadas. Valores suportados: short (padrão) ou full.

O usuário do Agente 2 ("zabbix") deve ser adicionado ao "docker" grupo para obter privilégios suficientes. Caso contrário, a verificação falhará.

docker.container_stats[<ID>]

As estatísticas de uso de recursos do contêiner.
Valor de retorno: A saída da chamada da API ContainerStats e a porcentagem de uso da CPU serializada como JSON.

Parâmetro:

• ID - a ID ou o nome do contêiner.

O usuário do Agente 2 ("zabbix") deve ser adicionado ao "docker" grupo para obter privilégios suficientes. Caso contrário, a verificação falhará.

docker.containers

A lista de contêineres.
Valor de retorno: A saída da chamada da API ContainerList serializada como JSON.

O usuário do Agente 2 ("zabbix") deve ser adicionado ao "docker" group para obter privilégios suficientes. Caso contrário, a verificação falhará.

docker.containers.discovery[<options>]

Retorna a lista de contêineres. Usado para [descoberta de baixo nível] (/manual/discovery/low_level_discovery/).
Valor de retorno: Objeto JSON.

Parâmetro:

• options - especifica se todos ou apenas os contêineres em execução devem ser descobertos. Valores compatíveis: true - retorna todos os contêineres; false - retorna apenas os contêineres em execução (padrão).

O usuário do Agente 2 ("zabbix") deve ser adicionado ao "docker" grupo para obter privilégios suficientes. Caso contrário, a verificação falhará.

docker.data.usage

Informações sobre o uso atual de dados.
Valor de retorno: A saída da chamada da API SystemDataUsage serializada como JSON.

O usuário do Agente 2 ("zabbix") deve ser adicionado ao "docker" grupo para obter privilégios suficientes. Caso contrário, a verificação falhará.

docker.images

Retorna a lista de imagens.
Valor de retorno: A saída da chamada da API ImageList serializada como JSON.

O usuário do Agente 2 ("zabbix") deve ser adicionado ao "docker" group para obter privilégios suficientes. Caso contrário, a verificação falhará.

docker.images.discovery

Retorna a lista de imagens. Usado para [descoberta de baixo nível] (/manual/discovery/low_level_discovery/).
Valor de retorno: Objeto JSON.

O usuário do Agente 2 ("zabbix") deve ser adicionado ao "docker" grupo para obter privilégios suficientes. Caso contrário, a verificação falhará.

docker.info

As informações do sistema.
Valor de retorno: A saída da chamada da API SystemInfo serializada como JSON.

O usuário do Agente 2 ("zabbix") deve ser adicionado ao "docker" group para obter privilégios suficientes. Caso contrário, a verificação falhará.

docker.ping

Testa se o daemon do Docker está ativo ou não.
Valor de retorno: 1 - a conexão está ativa; 0 - a conexão está interrompida.

O usuário do Agente 2 ("zabbix") deve ser adicionado ao "docker" grupo para obter privilégios suficientes. Caso contrário, a verificação falhará.

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

Testa se uma conexão está ativa ou não.
Valor de retorno: 1 - a conexão está ativa; 0 - a conexão está interrompida (se houver algum erro apresentado, inclusive AUTH e problemas de configuração).

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user, password - as credenciais de login do Memcached.
  

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

Obtém a saída do comando STATS.
Valor de retorno: JSON - a saída é serializada como JSON.

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user, password - as credenciais de login do Memcached;
  
• type - tipo de estatística a ser retornado: items, sizes, slabs ou settings (vazio por padrão, retorna estatísticas gerais).

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

Retorna uma variedade de estatísticas de armazenamento para uma determinada coleção.
Valor de retorno: Objeto JSON.

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user, password - as credenciais de login do MongoDB;
  
• database - o nome do banco de dados (padrão: admin);
  
• collection - o nome da coleção.

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

Retorna uma lista de coleções descobertas. Usado para [descoberta de baixo nível] (/manual/discovery/low_level_discovery).
Valor de retorno: Objeto JSON.

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user, password - as credenciais de login do MongoDB.
  

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

Retorna as estatísticas de uso das coleções.
Valor de retorno: Objeto JSON.

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user, password - as credenciais de login do MongoDB.
  

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

Retorna informações sobre as conexões de saída abertas da instância atual do banco de dados para outros membros do cluster fragmentado ou conjunto de réplicas.
Valor de retorno: Objeto JSON.

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user, password - as credenciais de login do MongoDB;
  
• database - o nome do banco de dados (padrão: admin);
  
• collection - o nome da coleção.

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

Retorna as estatísticas que refletem um determinado estado do sistema de banco de dados.
Valor de retorno: Objeto JSON.

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user, password - as credenciais de login do MongoDB;
  
• database - o nome do banco de dados (padrão: admin).
  

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

Retorna uma lista de bancos de dados descobertos. Usado para [descoberta de baixo nível] (/manual/discovery/low_level_discovery).
Valor de retorno: Objeto JSON.

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user, password - as credenciais de login do MongoDB.
  

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

Retorna a contagem de jumbo chunks.
Valor de retorno: Objeto JSON.

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user, password - as credenciais de login do MongoDB.
  

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

Retorna o status do conjunto de réplicas, usando dados pesquisados no oplog.
Valor de retorno: Objeto JSON.

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user, password - as credenciais de login do MongoDB.
  

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

Testa se uma conexão está ativa ou não.
Valor de retorno: 1 - a conexão está ativa; 0 - a conexão está interrompida (se houver algum erro apresentado, inclusive AUTH e problemas de configuração).

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user, password - as credenciais de login do MongoDB.
  

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

Retorna a configuração atual do conjunto de réplicas.
Valor de retorno: Objeto JSON.

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user, password - as credenciais de login do MongoDB.
  

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

Retorna o status do conjunto de réplicas do ponto de vista do membro em que o método é executado.
Valor de retorno: Objeto JSON.

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user, password - as credenciais de login do MongoDB.
  

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

Retorna o estado do banco de dados.
Valor de retorno: Objeto JSON.

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user, password - as credenciais de login do MongoDB.
  

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

Retorna a lista de shards descobertos presentes no cluster.
Valor de retorno: Objeto JSON.

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user, password - as credenciais de login do MongoDB.
  

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>]

Inscreve-se em um tópico ou tópicos específicos (com curingas) do corretor fornecido e aguarda publicações.
Valor de retorno: Depende do conteúdo do tópico. Se forem usados curingas, retorna o conteúdo do tópico como JSON.

Parâmetros:

• broker url - a URL do broker MQTT no formato protocol://host:port sem parâmetros de consulta (protocolos suportados: tcp, ssl, ws). Se nenhum valor for especificado, o agente usará tcp://localhost:1883. Se um protocolo ou porta for omitido, será usado o protocolo padrão (tcp) ou a porta (1883);
  
• topic - o tópico MQTT (obrigatório). Há suporte para caracteres curinga (+,#);
  
• user, password - as credenciais de autenticação (se necessário).
  

Comentários:

• O item deve ser configurado como uma verificação ativa (tipo de item 'Zabbix agent (active)');
• Os certificados de criptografia TLS podem ser usados salvando-os em um local padrão (por exemplo, o diretório /etc/ssl/certs/ do Ubuntu). Para TLS, use o esquema tls://.

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...>]

Retorna o resultado de uma consulta personalizada.
Valor de retorno: Objeto JSON.

Parâmetros:

• connString - URI ou nome da sessão;
  
• user, password - credenciais de login do MySQL;
  
• QueryName - nome de uma consulta personalizada, deve corresponder ao nome do arquivo SQL sem uma extensão;
  
• args - um ou vários argumentos separados por vírgula para passar para uma consulta.

Suportado desde o Zabbix 6.4.6.

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

Retorna a lista de bancos de dados MySQL. Usado para [descoberta de baixo nível] (/manual/discovery/low_level_discovery).
Valor de retorno: O resultado da consulta SQL "show databases" no formato LLD JSON.

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user, password - as credenciais de login do MySQL.
  

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

O tamanho do banco de dados em bytes.
Valor de retorno: Resultado da consulta SQL "select coalesce(sum(data_length + index_length),0) as size from information_schema.tables where table_schema=?" Consulta SQL para um banco de dados específico em bytes.

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user, password - as credenciais de login do MySQL;
  
• database name - o nome do banco de dados.

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

Valores das variáveis de status globais.
Valor de retorno: Resultado da consulta SQL "show global status" no formato JSON.

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user, password - as credenciais de login do MySQL.
  

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

Testa se uma conexão está ativa ou não.
Valor de retorno: 1 - a conexão está ativa; 0 - a conexão está interrompida (se houver algum erro apresentado, inclusive AUTH e problemas de configuração).

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user, password - as credenciais de login do MySQL.
  

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

Retorna a lista de replicações do MySQL. Usado para [descoberta de baixo nível] (/manual/discovery/low_level_discovery).
Valor de retorno: O resultado da consulta SQL "show slave status" no formato LLD JSON.

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user, password - as credenciais de login do MySQL.
  

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

O status da replicação.
Valor de retorno: Resultado da consulta SQL "show slave status" no formato JSON.

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user, password - as credenciais de login do MySQL;
  
• host mestre - o nome do host mestre de replicação. Se nenhum for encontrado, será retornado um erro. Se esse parâmetro não for especificado, todos os hosts serão retornados.
  

Observe que antes do Zabbix 6.4.8, o parâmetro "master host" é ignorado e sempre o primeiro master host é retornado.

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

A versão do MySQL.
Valor de retorno: String (com a versão da instância do MySQL).

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user, password - as credenciais de login do MySQL.
  

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

Retorna as estatísticas dos grupos de discos do Gerenciamento Automático de Armazenamento (ASM).
Valor de retorno: Objeto JSON.

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user - o nome de usuário do Oracle, suporta a inclusão de uma das opções de login as sysdba, as sysoper ou as sysasm no formato user as sysdba (uma opção de login não diferencia maiúsculas de minúsculas e não deve conter um espaço no final);
  
• password - a senha do Oracle;
  
• service - o nome do serviço Oracle;
  
• diskgroup - o nome do grupo de discos ASM a ser consultado.

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

Retorna a lista de grupos de discos ASM. Usado para [descoberta de baixo nível] (/manual/discovery/low_level_discovery).
Valor de retorno: Objeto JSON.

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user - o nome de usuário do Oracle, suporta a inclusão de uma das opções de login as sysdba, as sysoper ou as sysasm no formato user as sysdba (uma opção de login não diferencia maiúsculas de minúsculas e não deve conter um espaço no final);
  
• password - a senha do Oracle;
  
• service - o nome do serviço Oracle.
  

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

As estatísticas de registros do arquivo.
Valor de retorno: Objeto JSON.

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user - o nome de usuário do Oracle, suporta a inclusão de uma das opções de login as sysdba, as sysoper ou as sysasm no formato user as sysdba (uma opção de login não diferencia maiúsculas de minúsculas e não deve conter um espaço no final);
  
• password - a senha do Oracle;
  
• service - o nome do serviço Oracle;
  
• destination - o nome do destino a ser consultado.

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

As informações dos bancos de dados de contêineres (CDBs).
Valor de retorno: Objeto JSON.

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user - o nome de usuário do Oracle, suporta a inclusão de uma das opções de login as sysdba, as sysoper ou as sysasm no formato user as sysdba (uma opção de login não diferencia maiúsculas de minúsculas e não deve conter um espaço no final);
  
• password - a senha do Oracle;
  
• service - o nome do serviço Oracle;
  
• destination - o nome do banco de dados a ser consultado.

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

O resultado de uma consulta personalizada.
Valor de retorno: Objeto JSON.

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user - o nome de usuário do Oracle, suporta a inclusão de uma das opções de login as sysdba, as sysoper ou as sysasm no formato user as sysdba (uma opção de login não diferencia maiúsculas de minúsculas e não deve conter um espaço no final);
  
• password - a senha do Oracle;
  
• service - o nome do serviço Oracle;
  
• queryName - o nome de uma consulta personalizada, deve corresponder ao nome do arquivo SQL sem uma extensão;
• args - um ou vários argumentos separados por vírgula para passar para a consulta.

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

Retorna as estatísticas dos arquivos de dados.
Valor de retorno: Objeto JSON.

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user - o nome de usuário do Oracle, suporta a inclusão de uma das opções de login as sysdba, as sysoper ou as sysasm no formato user as sysdba (uma opção de login não diferencia maiúsculas de minúsculas e não deve conter um espaço no final);
  
• password - a senha do Oracle;
  
• service - o nome do serviço Oracle;
  
• diskgroup - o nome do grupo de discos ASM a ser consultado.

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

Retorna a lista de bancos de dados. Usado para [descoberta de baixo nível] (/manual/discovery/low_level_discovery).
Valor de retorno: Objeto JSON.

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user - o nome de usuário do Oracle, suporta a inclusão de uma das opções de login as sysdba, as sysoper ou as sysasm no formato user as sysdba (uma opção de login não diferencia maiúsculas de minúsculas e não deve conter um espaço no final);
  
• password - a senha do Oracle;
  
• service - o nome do serviço Oracle.
  

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

Retorna as estatísticas da FRA (Fast Recovery Area).
Valor de retorno: Objeto JSON.

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user - o nome de usuário do Oracle, suporta a inclusão de uma das opções de login as sysdba, as sysoper ou as sysasm no formato user as sysdba (uma opção de login não diferencia maiúsculas de minúsculas e não deve conter um espaço no final);
  
• password - a senha do Oracle;
  
• service - o nome do serviço Oracle.
  

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

As estatísticas da instância.
Valor de retorno: Objeto JSON.

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user - o nome de usuário do Oracle, suporta a inclusão de uma das opções de login as sysdba, as sysoper ou as sysasm no formato user as sysdba (uma opção de login não diferencia maiúsculas de minúsculas e não deve conter um espaço no final);
  
• password - a senha do Oracle;
  
• service - o nome do serviço Oracle.
  

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

Informações sobre os bancos de dados plugáveis (PDBs).
Valor de retorno: Objeto JSON.

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user - o nome de usuário do Oracle, suporta a inclusão de uma das opções de login as sysdba, as sysoper ou as sysasm no formato user as sysdba (uma opção de login não diferencia maiúsculas de minúsculas e não deve conter um espaço no final);
  
• password - a senha do Oracle;
  
• service - o nome do serviço Oracle;
  
• destination - o nome do banco de dados a ser consultado.

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

Retorna a lista de PDBs. Usado para [descoberta de baixo nível] (/manual/discovery/low_level_discovery).
Valor de retorno: Objeto JSON.

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user - o nome de usuário do Oracle, suporta a inclusão de uma das opções de login as sysdba, as sysoper ou as sysasm no formato user as sysdba (uma opção de login não diferencia maiúsculas de minúsculas e não deve conter um espaço no final);
  
• password - a senha do Oracle;
  
• service - o nome do serviço Oracle.
  

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

Retorna as estatísticas da Área Global do Programa (PGA).
Valor de retorno: Objeto JSON.

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user - o nome de usuário do Oracle, suporta a inclusão de uma das opções de login as sysdba, as sysoper ou as sysasm no formato user as sysdba (uma opção de login não diferencia maiúsculas de minúsculas e não deve conter um espaço no final);
  
• password - a senha do Oracle;
  
• service - o nome do serviço Oracle.
  

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

Testa se uma conexão com a Oracle pode ser estabelecida.
Valor de retorno: 1 - a conexão é bem-sucedida; 0 - a conexão é interrompida (se houver algum erro apresentado, inclusive AUTH e problemas de configuração).

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user - o nome de usuário Oracle, com suporte para anexar uma das opções de login as sysdba, as sysoper ou as sysasm no formato user as sysdba (uma opção de login não diferencia maiúsculas de minúsculas e não deve conter um espaço no final);
  
• password - a senha do Oracle;
  
• service - o nome do serviço Oracle.
  

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

Retorna as estatísticas dos processos.
Valor de retorno: Objeto JSON.

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user - o nome de usuário do Oracle, suporta a inclusão de uma das opções de login as sysdba, as sysoper ou as sysasm no formato user as sysdba (uma opção de login não diferencia maiúsculas de minúsculas e não deve conter um espaço no final);
  
• password - a senha do Oracle;
  
• service - o nome do serviço Oracle.
  

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

As informações do arquivo de log do arquivo de controle.
Valor de retorno: Objeto JSON.

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user - o nome de usuário do Oracle, suporta a inclusão de uma das opções de login as sysdba, as sysoper ou as sysasm no formato user as sysdba (uma opção de login não diferencia maiúsculas de minúsculas e não deve conter um espaço no final);
  
• password - a senha do Oracle;
  
• service - o nome do serviço Oracle.
  

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

Retorna as estatísticas da Área Global do Sistema (SGA).
Valor de retorno: Objeto JSON.

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user - o nome de usuário do Oracle, suporta a inclusão de uma das opções de login as sysdba, as sysoper ou as sysasm no formato user as sysdba (uma opção de login não diferencia maiúsculas de minúsculas e não deve conter um espaço no final);
  
• password - a senha do Oracle;
  
• service - o nome do serviço Oracle.
  

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

Retorna as estatísticas das sessões.
Valor de retorno: Objeto JSON.

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user - o nome de usuário do Oracle, suporta a inclusão de uma das opções de login as sysdba, as sysoper ou as sysasm no formato user as sysdba (uma opção de login não diferencia maiúsculas de minúsculas e não deve conter um espaço no final);
  
• password - a senha do Oracle;
  
• service - o nome do serviço Oracle;
  
• lockMaxTime - a duração máxima do bloqueio de sessão em segundos para contar a sessão como um bloqueio prolongado. Padrão: 600 segundos.

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

Retorna um conjunto de valores de métrica do sistema.
Valor de retorno: Objeto JSON.

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user - o nome de usuário do Oracle, suporta a inclusão de uma das opções de login as sysdba, as sysoper ou as sysasm no formato user as sysdba (uma opção de login não diferencia maiúsculas de minúsculas e não deve conter um espaço no final);
  
• password - a senha do Oracle;
  
• service - o nome do serviço Oracle;
  
• duration - o intervalo de captura (em segundos) dos valores de métrica do sistema. Valores possíveis: 60 - longa duração (padrão), 15 - curta duração.

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

Retorna um conjunto de valores de parâmetros do sistema.
Valor de retorno: Objeto JSON.

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user - o nome de usuário do Oracle, suporta a inclusão de uma das opções de login as sysdba, as sysoper ou as sysasm no formato user as sysdba (uma opção de login não diferencia maiúsculas de minúsculas e não deve conter um espaço no final);
  
• password - a senha do Oracle;
  
• service - o nome do serviço Oracle.
  

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

Retorna as estatísticas dos tablespaces.
Valor de retorno: Objeto JSON.

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user - o nome de usuário do Oracle, suporta a inclusão de uma das opções de login as sysdba, as sysoper ou as sysasm no formato user as sysdba (uma opção de login não diferencia maiúsculas de minúsculas e não deve conter um espaço no final);
  
• password - a senha do Oracle;
  
• service - o nome do serviço Oracle;
  
• tablespace - nome do tablespace a ser consultado. Padrão (se deixado em branco e type for definido):
  - "TEMP" (se type for definido como "TEMPORARY");
  - "USERS" (se type for definido como "PERMANENT").
• type - o tipo de tablespace a ser consultado. Padrão (se tablespace estiver definido): "PERMANENT".

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

Retorna uma lista de tablespaces. Usado para [descoberta de baixo nível] (/manual/discovery/low_level_discovery).
Valor de retorno: Objeto JSON.

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user - o nome de usuário do Oracle, suporta a inclusão de uma das opções de login as sysdba, as sysoper ou as sysasm no formato user as sysdba (uma opção de login não diferencia maiúsculas de minúsculas e não deve conter um espaço no final);
  
• password - a senha do Oracle;
  
• service - o nome do serviço Oracle.

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

Retorna informações do usuário Oracle.
Valor de retorno: Objeto JSON.

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• user - o nome de usuário do Oracle, suporta a inclusão de uma das opções de login as sysdba, as sysoper ou as sysasm no formato user as sysdba (uma opção de login não diferencia maiúsculas de minúsculas e não deve conter um espaço no final);
  
• password - a senha do Oracle;
  
• service - o nome do serviço Oracle;
  
• username - o nome de usuário para o qual as informações são necessárias. Não há suporte para nomes de usuário em minúsculas. Padrão: usuário atual.

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>]

O número de trabalhadores do autovacuum.
Valor de retorno: Integer.

Parâmetros:

• uri - o URI ou o nome da sessão;
  
• username, password - as credenciais do PostgreSQL;
  
• database name - o nome do banco de dados.
  

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

As informações sobre os arquivos arquivados.
Valor de retorno: Objeto JSON.

Parâmetros:

• uri - o URI ou o nome da sessão;
  
• username, password - as credenciais do PostgreSQL;
  
• database name - o nome do banco de dados.
  

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

O número combinado de pontos de verificação do cluster do banco de dados, discriminado por tipo de ponto de verificação.
Valor de retorno: Objeto JSON.

Parâmetros:

• uri - o URI ou o nome da sessão;
  
• username, password - as credenciais do PostgreSQL;
  
• database name - o nome do banco de dados.
  

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

A taxa de acerto do cache de buffer do PostgreSQL.
Valor de retorno: Float.

Parâmetros:

• uri - o URI ou o nome da sessão;
  
• username, password - as credenciais do PostgreSQL;
  
• database name - o nome do banco de dados.
  

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

Retorna as conexões por tipo.
Valor de retorno: Objeto JSON.

Parâmetros:

• uri - o URI ou o nome da sessão;
  
• username, password - as credenciais do PostgreSQL;
  
• database name - o nome do banco de dados.
  

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

Retorna o resultado de uma consulta personalizada.
Valor de retorno: Objeto JSON.

Parâmetros:

• uri - o URI ou o nome da sessão;
  
• username, password - as credenciais do PostgreSQL;
  
• Nome da consulta - o nome de uma consulta personalizada, que deve corresponder ao nome do arquivo SQL sem uma extensão;
  
• args - um ou vários argumentos separados por vírgulas para passar para uma consulta.

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

A idade do FrozenXID mais antigo do banco de dados.
Valor de retorno: Integer.

Parâmetros:

• uri - o URI ou o nome da sessão;
  
• username, password - as credenciais do PostgreSQL;
  
• database name - o nome do banco de dados.
  

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

O número de tabelas de inchaço por banco de dados.
Valor de retorno: Integer.

Parâmetros:

• uri - o URI ou o nome da sessão;
  
• username, password - as credenciais do PostgreSQL;
  
• database name - o nome do banco de dados.
  

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

A lista de bancos de dados PostgreSQL. Usada para [descoberta de baixo nível] (/manual/discovery/low_level_discovery).
Valor de retorno: Objeto JSON.

Parâmetros:

• uri - o URI ou o nome da sessão;
  
• username, password - as credenciais do PostgreSQL;
  
• database name - o nome do banco de dados.
  

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

O tamanho do banco de dados em bytes.
Valor de retorno: Integer.

Parâmetros:

• uri - o URI ou o nome da sessão;
  
• username, password - as credenciais do PostgreSQL;
  
• database name - o nome do banco de dados.
  

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

Coleta as estatísticas por banco de dados. Usado para [descoberta de baixo nível] (/manual/discovery/low_level_discovery).
Valor de retorno: Objeto JSON.

Parâmetros:

• uri - o URI ou o nome da sessão;
  
• username, password - as credenciais do PostgreSQL;
  
• database name - o nome do banco de dados.
  

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

Os dados resumidos de todos os bancos de dados em um cluster.
Valor de retorno: Objeto JSON.

Parâmetros:

• uri - o URI ou o nome da sessão;
  
• username, password - as credenciais do PostgreSQL;
  
• database name - o nome do banco de dados.
  

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

As informações sobre bloqueios concedidos por banco de dados. Usado para [descoberta de baixo nível] (/manual/discovery/low_level_discovery).
Valor de retorno: Objeto JSON.

Parâmetros:

• uri - o URI ou o nome da sessão;
  
• username, password - as credenciais do PostgreSQL;
  
• database name - o nome do banco de dados.
  

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

A idade do XID mais antigo.
Valor de retorno: Integer.

Parâmetros:

• uri - o URI ou o nome da sessão;
  
• username, password - as credenciais do PostgreSQL;
  
• database name - o nome do banco de dados.
  

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

Testa se uma conexão está ativa ou não.
Valor de retorno: 1 - a conexão está ativa; 0 - a conexão está interrompida (se houver algum erro apresentado, inclusive AUTH e problemas de configuração).

Parâmetros:

• uri - o URI ou o nome da sessão;
  
• nome de usuário, senha - as credenciais do PostgreSQL;
  
• database name - o nome do banco de dados.
  

pgsql.queries[uri,<username>,<password>,<database name>,<time period>]

Consulta métricas por tempo de execução.
Valor de retorno: Objeto JSON.

Parâmetros:

• uri - o URI ou o nome da sessão;
  
• username, password - as credenciais do PostgreSQL;
  
• database name - o nome do banco de dados;
  
• timePeriod - o limite de tempo de execução para a contagem de consultas lentas (deve ser um número inteiro positivo).

pgsql.replication.count[uri,<username>,<password>]

O número de servidores standby.
Valor de retorno: Integer.

Parâmetros:

• uri - o URI ou o nome da sessão;
  
• username, password - as credenciais do PostgreSQL.

pgsql.replication.process[uri,<username>,<password>]

O atraso de descarga, o atraso de gravação e o atraso de reprodução por cada processo emissor.
Valor de retorno: Objeto JSON.

Parâmetros:

• uri - o URI ou o nome da sessão;
  
• username, password - as credenciais do PostgreSQL.

pgsql.replication.process.discovery[uri,<username>,<password>]

A descoberta do nome do processo de replicação.
Valor de retorno: Objeto JSON.

Parâmetros:

• uri - o URI ou o nome da sessão;
  
• username, password - as credenciais do PostgreSQL.

pgsql.replication.recovery_role[uri,<username>,<password>]

O status de recuperação.
Valor de retorno: 0 - modo mestre; 1 - a recuperação ainda está em andamento (modo de espera).

Parâmetros:

• uri - o URI ou o nome da sessão;
  
• username, password - as credenciais do PostgreSQL.

pgsql.replication.status[uri,<username>,<password>]

O status da replicação.
Valor de retorno: 0 - o fluxo está inativo; 1 - o fluxo está ativo; 2 - modo mestre.

Parâmetros:

• uri - o URI ou o nome da sessão;
  
• username, password - as credenciais do PostgreSQL.

pgsql.replication_lag.b[uri,<username>,<password>]

O atraso de replicação em bytes.
Valor de retorno: Integer.

Parâmetros:

• uri - o URI ou o nome da sessão;
  
• username, password - as credenciais do PostgreSQL.

pgsql.replication_lag.sec[uri,<username>,<password>]

O atraso de replicação em segundos.
Valor de retorno: Integer.

Parâmetros:

• uri - o URI ou o nome da sessão;
  
• username, password - as credenciais do PostgreSQL.

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

O tempo de atividade do PostgreSQL em milissegundos.
Valor de retorno: Float.

Parâmetros:

• uri - o URI ou o nome da sessão;
  
• username, password - as credenciais do PostgreSQL;
  
• database name - o nome do banco de dados.
  

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

Retorna a versão do PostgreSQL.
Valor de retorno: String.

Parâmetros:

• uri - o URI ou o nome da sessão;
  
• username, password - as credenciais do PostgreSQL;
  
• database name - o nome do banco de dados.
  

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

As estatísticas do WAL.
Valor de retorno: Objeto JSON.

Parâmetros:

• uri - o URI ou o nome da sessão;
  
• username, password - as credenciais do PostgreSQL;
  
• database name - o nome do banco de dados.
  

redis.config[connString,<password>,<pattern>]

Obtém os parâmetros de configuração de uma instância do Redis que correspondem ao padrão.
Valor de retorno: JSON - se um padrão de estilo glob tiver sido usado; valor único - se um padrão não contiver nenhum caractere curinga.

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• password - a senha do Redis;
  
• pattern - um padrão de estilo glob (* por padrão).

redis.info[connString,<password>,<section>]

Obtém a saída do comando INFO.
Valor de retorno: JSON - a saída é serializada como JSON.

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• password - a senha do Redis;
  
• section - a seção de informações (default por padrão).
  

redis.ping[connString,<password>]

Testa se uma conexão está ativa ou não.
Valor de retorno: 1 - a conexão está ativa; 0 - a conexão está interrompida (se houver algum erro apresentado, inclusive AUTH e problemas de configuração).

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• password - a senha do Redis.
  

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

O número de entradas de registro lento desde que o Redis foi iniciado.
Valor de retorno: Integer.

Parâmetros:

• connString - o URI ou o nome da sessão;
  
• password - a senha do Redis.
  

smart.attribute.discovery

Retorna uma lista de atributos de dispositivos S.M.A.R.T..
Valor de retorno: Objeto JSON.

Comentários:

• As seguintes macros e seus valores são retornados: {#NAME}, {#DISKTYPE}, {#ID}, {#ATTRNAME}, {#THRESH};
• Há suporte para os tipos de unidade HDD, SSD e NVME. As unidades podem estar sozinhas ou combinadas em um RAID. {#NAME} terá um complemento no caso de RAID, por exemplo: {"{#NAME}": "/dev/sda cciss,2"}.

smart.disk.discovery

Retorna uma lista de dispositivos S.M.A.R.T..
Valor de retorno: Objeto JSON.

Comentários:

• As seguintes macros e seus valores são retornados: {#NAME}, {#DISKTYPE}, {#MODEL}, {#SN}, {#PATH}, {#ATTRIBUTES}, {#RAIDTYPE};
• Há suporte para os tipos de unidade HDD, SSD e NVME. Se uma unidade não pertencer a um RAID, o {#RAIDTYPE} estará vazio. O {#NAME} terá um complemento no caso de RAID, por exemplo: {"{#NAME}": "/dev/sda cciss,2"}.

smart.disk.get[<path>,<raid type>]

Retorna todas as propriedades disponíveis dos dispositivos S.M.A.R.T.
Valor de retorno: Objeto JSON.

Parâmetros:

• path - o caminho do disco, a macro {#PATH} pode ser usada como um valor;
  
• raid_type - o tipo de RAID, a macro {#RAID} pode ser usada como um valor

Comentários:

• Há suporte para os tipos de unidade HDD, SSD e NVME. As unidades podem estar sozinhas ou combinadas em um RAID;
  
• Os dados incluem a versão do smartctl e os argumentos de chamada, além de campos adicionais:
  disk_name - contém o nome com os complementos necessários para a descoberta de RAID, por exemplo: {"disk_name": "/dev/sda cciss,2"}
  disk_type - contém o tipo de disco HDD, SSD ou NVME, por exemplo: {"disk_type": "ssd"};
  
• Se nenhum parâmetro for especificado, o item retornará informações sobre todos os discos.

systemd.unit.get[nome da unidade,<interface>]

Retorna todas as propriedades de uma unidade do systemd.
Valor de retorno: Objeto JSON.

Parâmetros:

• unit name - o nome da unidade (talvez você queira usar a macro {#UNIT.NAME} no protótipo do item para descobrir o nome);
  
• interface - o tipo de interface da unidade, valores possíveis: Unit (padrão), Service, Socket, Device, Mount, Automount, Swap, Target, Path.

Comentários:

• Esse item é compatível apenas com a plataforma Linux;
• LoadState, ActiveState e UnitFileState para a interface Unit são retornados como texto e número inteiro: "ActiveState":{"state":1,"text":"active"}.

systemd.unit.info[nome da unidade,<property>,<interface>]

Informações de uma unidade do systemd.
Valor de retorno: String.

Parâmetros:

• unit name - o nome da unidade (talvez você queira usar a macro {#UNIT.NAME} no protótipo do item para descobrir o nome);
  
• property - propriedade da unidade (por exemplo, ActiveState (padrão), LoadState, Description);
• interface - o tipo de interface da unidade (por exemplo, Unit (padrão), Socket, Service).

Comentários:

• Esse item é compatível apenas com a plataforma Linux;
• Esse item permite recuperar uma propriedade específica de um tipo específico de interface, conforme descrito em dbus API.

Exemplos:

systemd.unit.info["{#UNIT.NAME}"] #coleta informações sobre o estado ativo (ativo, recarregando, inativo, com falha, ativando, desativando) das unidades descobertas do systemd
       systemd.unit.info["{#UNIT.NAME}",LoadState] #coleta informações sobre o estado de carga das unidades descobertas do systemd
       systemd.unit.info[mysqld.service,Id] #obtém o nome técnico do serviço (mysqld.service)
       systemd.unit.info[mysqld.service,Description] #obtém a descrição do serviço (MySQL Server)
       systemd.unit.info[mysqld.service,ActiveEnterTimestamp] #recupera a última vez que o serviço entrou no estado ativo (1562565036283903)
       systemd.unit.info[dbus.socket,NConnections,Socket] #coleta o número de conexões dessa unidade de soquete

systemd.unit.discovery[<type>]

Lista de unidades do systemd e seus detalhes. Usada para [descoberta de baixo nível] (/manual/discovery/low_level_discovery/examples/systemd).
Valor de retorno: Objeto JSON.

Parâmetro:

• type - valores possíveis: all, automount, device, mount, path, service (padrão), socket, swap, target.

Esse item é compatível apenas com a plataforma Linux.

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

Valida os certificados e retorna os detalhes do certificado.
Valor de retorno: Objeto JSON.

Parâmetro:

• hostname - pode ser IP ou DNS.
  Pode conter o esquema de URL (somente https), o caminho (será ignorado) e a porta.
  Se uma porta for fornecida no primeiro e no segundo parâmetros, seus valores deverão corresponder.
  Se o endereço (o terceiro parâmetro) for especificado, o nome do host será usado somente para verificação do SNI e do nome do host;
  
• port - o número da porta (o padrão é 443 para HTTPS);
  
• address - pode ser IP ou DNS. Se especificado, será usado para conexão, e o nome do host (o primeiro parâmetro) será usado para SNI e verificação do host. Caso o 1º parâmetro seja um IP e o 3º parâmetro seja DNS, o 1º parâmetro será usado para conexão e o 3º parâmetro será usado para SNI e verificação de host.

Comentários:

• Esse item se tornará incompatível se o recurso especificado em host não existir ou não estiver disponível ou se o handshake TLS falhar com qualquer erro, exceto um certificado inválido;
  
• Atualmente, não há suporte para a extensão AIA (Authority Information Access) X.509, CRLs e OCSP (incluindo grampeamento OCSP), Transparência de certificado e armazenamento de confiança de CA personalizado.