Zabbix エージェント 2

Zabbix エージェント 2 は、Unix および Windows の Zabbix エージェントでサポートされるすべてのアイテムキーをサポートします。 このページでは、Zabbix エージェント 2 でのみ使用できる追加のアイテムキーについて、属するプラグインごとに分類して説明します。

アイテムキーは、パラメータや追加情報を省略した形で一覧表示されています。 アイテムキーをクリックすると、詳細を確認できます。

Item key Description Plugin
ceph.df.details クラスタのデータ使用量とプール間の分布。 Ceph
(loadable)
ceph.osd.stats 集計された OSD ごとの統計。
ceph.osd.discovery 検出された OSD の一覧。
ceph.osd.dump OSD の使用しきい値と状態。
ceph.ping Ceph への接続を確立できるかどうかをテストします。
ceph.pool.discovery 検出されたプールの一覧。
ceph.status クラスタ全体の状態。
docker.container_info コンテナーに関する低レベル情報。 Docker
docker.container_stats コンテナーのリソース使用統計。
docker.containers コンテナーの一覧を返します。
docker.containers.discovery コンテナーの一覧を返します。低レベルディスカバリに使用します。
docker.data.usage 現在のデータ使用量に関する情報。
docker.images イメージの一覧を返します。
docker.images.discovery イメージの一覧を返します。低レベルディスカバリに使用します。
docker.info システム情報。
docker.ping Docker デーモンが稼働しているかどうかをテストします。
ember.get 必要なデバイスの結果を返します。 Ember+
(loadable)
memcached.ping 接続が有効かどうかをテストします。 Memcached
memcached.stats STATS コマンドの出力を取得します。
mongodb.cfg.discovery 検出された設定サーバーの一覧を返します。 MongoDB
(loadable)
mongodb.collection.stats 指定したコレクションのさまざまなストレージ統計を返します。
mongodb.collections.discovery 検出されたコレクションの一覧を返します。
mongodb.collections.usage コレクションの使用統計を返します。
mongodb.connpool.stats 現在のデータベースインスタンスから、シャーディングクラスタまたはレプリカセットの他のメンバーへの、開いている送信接続に関する情報を返します。
mongodb.db.stats 指定したデータベースのシステム状態を反映する統計を返します。
mongodb.db.discovery 検出されたデータベースの一覧を返します。
mongodb.jumbo_chunks.count jumbo chunk の数を返します。
mongodb.oplog.stats oplog から取得したデータを使用して、レプリカセットの状態を返します。
mongodb.ping 接続が有効かどうかをテストします。
mongodb.rs.config レプリカセットの現在の設定を返します。
mongodb.rs.status メソッドが実行されたメンバーの視点から見たレプリカセットの状態を返します。
mongodb.server.status データベースの状態を返します。
mongodb.sh.discovery クラスタ内に存在する検出済みシャードの一覧を返します。
mongodb.version データベースサーバーのバージョンを返します。
mqtt.get 指定されたブローカーの特定のトピック、またはワイルドカード付きの複数トピックを購読し、公開を待機します。 MQTT
mssql.availability.group.get 可用性グループを返します。 MSSQL
(loadable)
mssql.custom.query カスタムクエリの結果を返します。
mssql.db.get 利用可能なすべての MSSQL データベースを返します。
mssql.job.status.get ジョブの状態を返します。
mssql.last.backup.get すべてのデータベースの最新バックアップ時刻を返します。
mssql.local.db.get Always On 可用性グループとレプリカ(プライマリまたはセカンダリ)に参加しており、接続が確立されたサーバー上にあるデータベースを返します。
mssql.mirroring.get ミラーリング情報を返します。
mssql.nonlocal.db.get Always On 可用性グループとレプリカ(プライマリまたはセカンダリ)に参加しており、他のサーバー上にあるデータベースを返します(そのデータベースは、接続が確立された SQL Server インスタンス上のローカルではありません)。
mssql.perfcounter.get パフォーマンスカウンターを返します。
mssql.ping 接続が有効かどうかをテストします。
mssql.quorum.get クォーラム情報を返します。
mssql.quorum.member.get クォーラムメンバーを返します。
mssql.replica.get レプリカを返します。
mssql.version MSSQL のバージョンを返します。
mysql.custom.query カスタムクエリの結果を返します。 MySQL
mysql.db.discovery MySQL データベースの一覧を返します。
mysql.db.size データベースサイズ(バイト)。
mysql.get_status_variables グローバルステータス変数の値。
mysql.ping 接続が有効かどうかをテストします。
mysql.replication.discovery MySQL レプリケーションの一覧を返します。
mysql.replication.get_slave_status レプリケーションの状態。
mysql.version MySQL のバージョン。
net.dns.get DNS クエリを実行し、詳細な DNS レコード情報を返します。 Network
nvml.device.count GPU デバイスの数。 NVIDIA GPU
(loadable)
nvml.device.decoder.utilization GPU デバイスのデコーダー使用率。
nvml.device.ecc.mode GPU デバイスの ECC モード。
nvml.device.encoder.stats.get GPU デバイスのエンコーダー統計。
nvml.device.encoder.utilization GPU デバイスのエンコーダー使用率。
nvml.device.energy.consumption GPU デバイスの消費電力。
nvml.device.errors.memory GPU デバイスの ECC メモリエラー情報。
nvml.device.errors.register GPU デバイスの ECC レジスターエラー情報。
nvml.device.fan.speed.avg GPU デバイスのファン速度の平均。
nvml.device.get UUID と名前を含む検出済み GPU。
nvml.device.graphics.frequency GPU デバイスのグラフィックスクロック速度。
nvml.device.memory.bar1.get GPU デバイスの BAR1 メモリ情報。
nvml.device.memory.fb.get GPU デバイスのフレームバッファーメモリ情報。
nvml.device.memory.frequency GPU デバイスのメモリクロック速度。
nvml.device.pci.utilization GPU デバイスの PCI 使用率。
nvml.device.performance.state GPU デバイスのパフォーマンス状態。
nvml.device.power.limit GPU デバイスの電力制限。
nvml.device.power.usage GPU デバイスの消費電力使用量。
nvml.device.serial GPU デバイスのシリアル番号。
nvml.device.sm.frequency GPU デバイスのストリーミングマルチプロセッサーのクロック速度。
nvml.device.temperature GPU デバイスの温度。
nvml.device.utilization GPU デバイスの使用率統計。
nvml.device.video.frequency GPU デバイスのビデオクロック速度。
nvml.system.driver.version NVIDIA ドライバーバージョン。
nvml.version NVML ライブラリのバージョン。
oracle.diskgroups.stats Automatic Storage Management (ASM) ディスクグループの統計を返します。 Oracle
oracle.diskgroups.discovery ASM ディスクグループの一覧を返します。
oracle.archive.info アーカイブログの統計。
oracle.cdb.info Container Database (CDB) の情報。
oracle.custom.query カスタムクエリの結果。
oracle.datafiles.stats データファイルの統計を返します。
oracle.db.discovery データベースの一覧を返します。
oracle.fra.stats Fast Recovery Area (FRA) の統計を返します。
oracle.instance.info インスタンスの統計。
oracle.pdb.info Pluggable Database (PDB) の情報。
oracle.pdb.discovery PDB の一覧を返します。
oracle.pga.stats Program Global Area (PGA) の統計を返します。
oracle.ping Oracle への接続を確立できるかどうかをテストします。
oracle.proc.stats プロセスの統計を返します。
oracle.redolog.info 制御ファイルからのログファイル情報。
oracle.sga.stats System Global Area (SGA) の統計を返します。
oracle.sessions.stats セッションの統計を返します。
oracle.sys.metrics 一連のシステムメトリック値を返します。
oracle.sys.params 一連のシステムパラメーター値を返します。
oracle.ts.stats 表領域の統計を返します。
oracle.ts.discovery 表領域の一覧を返します。
oracle.user.info Oracle ユーザー情報を返します。
oracle.version データベースサーバーのバージョンを返します。
pgsql.autovacuum.count autovacuum ワーカーの数。 PostgreSQL
(loadable)
pgsql.archive アーカイブ済みファイルに関する情報。
pgsql.bgwriter データベースクラスタのチェックポイント総数を、チェックポイント種別ごとに分類したもの。
pgsql.cache.hit PostgreSQL バッファーキャッシュのヒット率。
pgsql.connections 種類別の接続を返します。
pgsql.custom.query カスタムクエリの結果を返します。
pgsql.db.age データベース内で最も古い FrozenXID の経過時間。
pgsql.db.bloating_tables データベースごとの bloating table の数。
pgsql.db.discovery PostgreSQL データベースの一覧。
pgsql.db.size データベースサイズ(バイト)。
pgsql.dbstat データベースごとの統計を収集します。
pgsql.dbstat.sum クラスタ内のすべてのデータベースの集計データ。
pgsql.locks データベースごとの付与済みロックに関する情報。
pgsql.oldest.xid 最も古い XID の経過時間。
pgsql.ping 接続が有効かどうかをテストします。
pgsql.queries 実行時間別のクエリメトリック。
pgsql.replication.count スタンバイサーバーの数。
pgsql.replication.process 各送信プロセスごとの flush lag、write lag、replay lag。
pgsql.replication.process.discovery レプリケーションプロセス名の検出。
pgsql.replication.recovery_role リカバリ状態。
pgsql.replication.status レプリケーションの状態。
pgsql.replication_lag.b レプリケーション遅延(バイト)。
pgsql.replication_lag.sec レプリケーション遅延(秒)。
pgsql.uptime PostgreSQL の稼働時間(ミリ秒)。
pgsql.version PostgreSQL のバージョンを返します。
pgsql.wal.stat WAL 統計。
redis.config 指定したパターンに一致する Redis インスタンスの設定パラメーターを取得します。 Redis
redis.info INFO コマンドの出力を取得します。
redis.ping 接続が有効かどうかをテストします。
redis.slowlog.count Redis の起動以降の slow log エントリ数。
smart.attribute.discovery S.M.A.R.T. デバイス属性の一覧を返します。 S.M.A.R.T.
smart.disk.discovery S.M.A.R.T. デバイスの一覧を返します。
smart.disk.get S.M.A.R.T. デバイスで利用可能なすべてのプロパティを返します。
systemd.unit.get systemd ユニットのすべてのプロパティを返します。 Systemd
systemd.unit.info systemd ユニット情報。
systemd.unit.discovery systemd ユニットとその詳細の一覧。
web.certificate.get 証明書を検証し、証明書の詳細を返します。 Web certificates

アイテムキーの詳細

山括弧のないパラメータは必須です。 山括弧 < > で囲まれたパラメータはオプションです。

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


クラスタのデータ使用量とプール間の分布。
戻り値: JSONオブジェクト

パラメータ:

  • connString - URIまたはセッション名;
  • user, apikey - Cephに接続するためのユーザー名とAPIキー。
ceph.osd.stats[connString,<user>,<apikey>]


集約およびOSDごとの統計情報。
戻り値: JSONオブジェクト

パラメータ:

  • connString - URIまたはセッション名;
  • user, apikey - Cephに接続するためのユーザー名とAPIキー。
ceph.osd.discovery[connString,<user>,<apikey>]


検出されたOSDのリスト。
ローレベルディスカバリで使用されます。
戻り値: JSONオブジェクト

パラメータ:

  • connString - URIまたはセッション名;
  • user, apikey - Cephに接続するためのユーザー名とAPIキー。
ceph.osd.dump[connString,<user>,<apikey>]


OSDの使用率のしきい値とステータス。
戻り値: JSONオブジェクト

パラメータ:

  • connString - URIまたはセッション名;
  • user, apikey - Cephに接続するためのユーザー名とAPIキー。
ceph.ping[connString,<user>,<apikey>]


Cephへの接続が確立できるかどうかをテストします。
戻り値: 0 - 接続が切断されています (認証や設定の問題を含むエラーが発生した場合); 1 - 接続が成功しました。

パラメータ:

  • connString - URIまたはセッション名;
  • user, apikey - Cephに接続するためのユーザー名とAPIキー。
ceph.pool.discovery[connString,<user>,<apikey>]


検出されたプールのリスト。
ローレベルディスカバリで使用されます。
戻り値: JSONオブジェクト

パラメータ:

  • connString - URIまたはセッション名;
  • user, apikey - Cephに接続するためのユーザー名とAPIキー。
ceph.status[connString,<user>,<apikey>]


クラスタ全体のステータス。
戻り値: JSONオブジェクト

パラメータ:

  • connString - URIまたはセッション名;
  • user, apikey - Cephに接続するためのユーザー名とAPIキー。
docker.container_info[<ID>,<info>]


コンテナのローレベル情報。
戻り値: ContainerInspect API呼び出しの出力をJSONとしてシリアライズしたもの。

パラメータ:

  • ID - コンテナのIDまたは名前;
  • info - 返される情報の量。 サポートされる値: short (デフォルト) または full

十分な権限を得るために、Agent 2のユーザー('zabbix')を 'docker' グループに追加する必要があります。 そうしないと、チェックは失敗します。

docker.container_stats[<ID>]


コンテナのリソース使用状況の統計情報です。
戻り値: ContainerStats API呼び出しの出力とCPU使用率のパーセンテージをJSONとしてシリアライズしたもの。

パラメータ:

  • ID - コンテナのIDまたは名前

Agent 2のユーザー('zabbix')は、十分な権限を得るために'docker' グループに追加する必要があります。 そうしないと、チェックは失敗します。

docker.containers


コンテナのリスト。
戻り値: ContainerList API呼び出しの出力をJSONとしてシリアライズしたもの。

十分な権限を得るために、Agent 2のユーザー('zabbix')を'docker' グループに追加する必要があります。 そうしないと、チェックは失敗します。

docker.containers.discovery[<options>]


コンテナのリストを返します。 ローレベルディスカバリで使用されます。
戻り値: JSONオブジェクト

パラメータ:

  • options - すべてのコンテナまたは実行中のコンテナのみをディスカバリするかどうかを指定します。 サポートされる値: true - すべてのコンテナを返す; false - 実行中のコンテナのみを返す(デフォルト)。

十分な権限を得るために、Agent 2のユーザー('zabbix')を'docker' グループに追加する必要があります。 そうしないと、チェックは失敗します。

docker.data.usage


現在のデータ使用量に関する情報。
戻り値: SystemDataUsage API呼び出しの出力をJSONとしてシリアル化したもの。

十分な権限を得るために、Agent 2のユーザー('zabbix')を'docker' グループに追加する必要があります。 そうしないと、チェックは失敗します。

docker.images


イメージのリストを返します。
戻り値: ImageList API呼び出しの出力をJSONとしてシリアライズしたもの。

十分な権限を得るために、Agent 2のユーザー('zabbix')を'docker' グループに追加する必要があります。 そうしないと、チェックは失敗します。

docker.images.discovery


イメージのリストを返します。 ローレベルディスカバリで使用されます。
戻り値:JSONオブジェクト

Agent 2のユーザー('zabbix')は、十分な権限を持つために'docker' グループに追加する必要があります。 そうしないと、チェックは失敗します。

docker.info


システム情報。
戻り値: SystemInfo API呼び出しの出力をJSONとしてシリアライズしたもの。

十分な権限を得るために、Agent 2のユーザー('zabbix')を'docker' グループに追加する必要があります。 そうしないと、チェックは失敗します。

docker.ping


Dockerデーモンが生きているかどうかをテストします。
戻り値: 1 - 接続が生きている; 0 - 接続が切れている。

十分な権限を得るために、Agent 2のユーザー('zabbix')を'docker' グループに追加する必要があります。 そうしないと、チェックは失敗します。

ember.get[<uri>,<path>]


要求されたデバイスの結果を返します。
戻り値: JSONオブジェクト

パラメータ:

  • uri - Ember+デバイスのURI。 デフォルト: 127.0.0.1:9998;
  • path - デバイスのOIDパス。 デフォルトは空で、ルートコレクションデータを返します。
memcached.ping[connString,<user>,<password>]


接続が生きているかどうかをテストします。
戻り値: 1 - 接続が生きている; 0 - 接続が切断されている (AUTHや設定の問題を含むエラーが発生した場合)。

パラメータ:

  • connString - URIまたはセッション名;
  • user, password - Memcachedのログイン認証情報。
memcached.stats[connString,<user>,<password>,<type>]


STATSコマンドの出力を取得します。
戻り値: JSON - 出力はJSONとしてシリアライズされます。

パラメータ:

  • connString - URIまたはセッション名;
  • user, password - Memcachedのログイン認証情報;
  • type - 返される統計情報のタイプ: itemssizesslabssettings(デフォルトは空、一般的な統計情報を返します)。
mongodb.collection.stats[connString,<user>,<password>,<database>,collection]


指定したコレクションのさまざまなストレージ統計情報を返します。
戻り値: JSONオブジェクト

パラメータ:

  • connString - URIまたはセッション名;
  • user, password - MongoDBのログイン認証情報;
  • database - データベース名(デフォルト: admin);
  • collection - コレクション名。
mongodb.cfg.discovery[connString,<user>,<password>]


検出された構成サーバーのリストを返します。
戻り値: JSONオブジェクト

パラメーター:

  • connString - URIまたはセッション名;
  • user, password - MongoDBのログイン認証情報。
mongodb.collections.discovery[connString,<user>,<password>]


検出されたコレクションのリストを返します。 ローレベルディスカバリで使用されます。
戻り値: JSONオブジェクト

パラメータ:

  • connString - URIまたはセッション名;
  • user, password - MongoDBのログイン認証情報。
mongodb.collections.usage[connString,<user>,<password>]


コレクションの使用統計を返します。
戻り値:JSONオブジェクト

パラメータ:

  • connString - URIまたはセッション名;
  • user, password - MongoDBのログイン認証情報。
mongodb.connpool.stats[connString,<user>,<password>]


現在のデータベースインスタンスからシャードクラスタまたはレプリカセットの他のメンバーへの開いているアウトゴーイング接続に関する情報を返します。
戻り値: JSONオブジェクト

パラメータ:

  • connString - URIまたはセッション名;
  • user, password - MongoDBのログイン認証情報。
mongodb.db.stats[connString,<user>,<password>,<database>]


指定したデータベースのシステム状態を反映する統計情報を返します。
戻り値: JSONオブジェクト

パラメータ:

  • connString - URIまたはセッション名;
  • user, password - MongoDBのログイン認証情報;
  • database - データベース名(デフォルト: admin)。
mongodb.db.discovery[connString,<user>,<password>]


検出されたデータベースのリストを返します。 ローレベルディスカバリで使用されます。
戻り値: JSONオブジェクト

パラメータ:

  • connString - URIまたはセッション名;
  • user, password - MongoDBのログイン認証情報。
mongodb.jumbo_chunks.count[connString,<user>,<password>]


ジャンボチャンクの数を返します。
戻り値:JSONオブジェクト

パラメータ:

  • connString - URIまたはセッション名;
  • user, password - MongoDBのログイン認証情報。
mongodb.oplog.stats[connString,<user>,<password>]


oplogから取得したデータを使用して、レプリカセットのステータスを返します。
戻り値:JSONオブジェクト

パラメータ:

  • connString - URIまたはセッション名;
  • user, password - MongoDBのログイン認証情報。
mongodb.ping[connString,<user>,<password>]


接続が生きているかどうかをテストします。
戻り値: 1 - 接続が生きている; 0 - 接続が切れている (AUTHや設定の問題を含むエラーが発生した場合)。

パラメータ:

  • connString - URIまたはセッション名;
  • user, password - MongoDBのログイン認証情報。
mongodb.rs.config[connString,<user>,<password>]


レプリカセットの現在の構成を返します。
戻り値: JSONオブジェクト

パラメータ:

  • connString - URIまたはセッション名;
  • user, password - MongoDBのログイン認証情報。
mongodb.rs.status[connString,<user>,<password>]


このメソッドが実行されるメンバーの観点からレプリカセットのステータスを返します。
戻り値: JSONオブジェクト

パラメータ:

  • connString - URIまたはセッション名;
  • user, password - MongoDBのログイン認証情報。
mongodb.server.status[connString,<user>,<password>]


データベースの状態を返します。
戻り値: JSONオブジェクト

パラメータ:

  • connString - URIまたはセッション名;
  • user, password - MongoDBのログイン認証情報。
mongodb.sh.discovery[connString,<user>,<password>]


クラスタ内に存在する検出されたシャードのリストを返します。
戻り値: JSONオブジェクト

パラメータ:

  • connString - URIまたはセッション名;
  • user, password - MongoDBのログイン認証情報。
mongodb.version[connString,<user>,<password>]


データベースサーバーのバージョンを返します。
戻り値: String

パラメータ:

  • connString - URIまたはセッション名;
  • user, password - MongoDBのログイン認証情報。
mqtt.get[<broker url>,topic,<user>,<password>]


指定したブローカーの特定のトピック、またはワイルドカードを含むトピックにサブスクライブし、公開を待機します。
戻り値: トピックの内容に応じて異なります。 ワイルドカードが使用されている場合は、トピックの内容を JSON として返します。

パラメーター:

  • broker url - MQTT ブローカーの URL。形式は protocol://host:port で、クエリパラメーターは含めません(サポートされるプロトコル: tcp, ssl, ws)。 値が指定されていない場合、エージェントは tcp://localhost:1883 を使用します。 プロトコルまたはポートが省略された場合は、既定のプロトコル (tcp) またはポート (1883) が使用されます;
  • topic - MQTT トピック(必須)。 ワイルドカード (+,#) がサポートされています;
  • user, password - 認証情報(必要な場合)。

コメント:

  • アイテムは active check('Zabbix agent (active)' アイテムタイプ)として設定する必要があります;
  • TLS 暗号化証明書は、既定の場所(例: Ubuntu では /etc/ssl/certs/ ディレクトリ)に保存することで使用できます。 TLS では tls:// スキームを使用してください。
mssql.availability.group.get[URI,<user>,<password>]


可用性グループを返します。
戻り値: JSONオブジェクト

パラメータ:

  • URI - MSSQLサーバーのURI(サポートされているスキーマはsqlserver://のみ)。 埋め込み認証情報は無視されます。 URIの一部としてインスタンス名を指定することができます。例: sqlserver://localhost/InstanceName(ポートなし)。 ポートが指定されている場合、インスタンス名は無視されます;
  • user, password - 保護されたMSSQLサーバーに送信するユーザー名、パスワード。

詳細については、MSSQLプラグインのreadmeを参照してください。

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


カスタムクエリの結果を返します。
戻り値: JSONオブジェクト

パラメータ:

  • URI - MSSQLサーバーのURI(サポートされているスキーマはsqlserver://のみ)。 埋め込まれた認証情報は無視されます。 URIの一部としてインスタンス名を指定することができます。例: sqlserver://localhost/InstanceName(ポートなし)。 ポートが指定されている場合、インスタンス名は無視されます;
  • user, password - 保護されたMSSQLサーバーに送信するユーザー名、パスワード;
  • queryName - .sql拡張子なしでPlugins.MSSQL.CustomQueriesDirに設定されたカスタムクエリの名前;
  • args - クエリに渡す1つまたは複数のカンマ区切りの引数。

詳細はMSSQLプラグインのreadmeを参照してください。

mssql.db.get


利用可能なすべてのMSSQLデータベースを返します。
戻り値:JSONオブジェクト

詳細については、MSSQLプラグインのreadmeを参照してください。

mssql.job.status.get


ジョブのステータスを返します。
戻り値: JSONオブジェクト

詳細については、MSSQLプラグインのreadmeを参照してください。

mssql.last.backup.get


すべてのデータベースの最終バックアップ時刻を返します。
戻り値: JSONオブジェクト

詳細については、MSSQLプラグインのreadmeを参照してください。

mssql.local.db.get


Always On 可用性グループおよびレプリカ (プライマリまたはセカンダリ) に参加しており、接続が確立されたサーバーに存在するデータベースを返します。
戻り値: JSON オブジェクト

詳細については、MSSQL プラグイン の readme を参照してください。

mssql.mirroring.get


ミラーリング情報を返します。
戻り値: JSONオブジェクト

詳細は MSSQLプラグイン のreadmeを参照してください。

mssql.nonlocal.db.get


Always On 可用性グループに参加しているデータベースおよび他のサーバーにあるレプリカ (プライマリまたはセカンダリ) を返します (接続が確立された SQL Server インスタンスにローカルではないデータベース)。
戻り値: JSON オブジェクト

詳細については、MSSQL プラグイン の readme を参照してください。

mssql.perfcounter.get


パフォーマンスカウンターを返します。
戻り値: JSONオブジェクト

詳細は MSSQLプラグイン のreadmeを参照してください。

mssql.ping


データベースにpingを送信します。 接続が正しく設定されているかテストします。
戻り値: 1 - 生存, 0 - 非生存。

詳細については、MSSQLプラグインのreadmeを参照してください。

mssql.quorum.get


クォーラム情報を返します。
戻り値:JSONオブジェクト

詳細については、MSSQLプラグインのreadmeを参照してください。

mssql.quorum.member.get


クォーラムメンバーを返します。
戻り値: JSONオブジェクト

詳細については、MSSQLプラグインのreadmeを参照してください。

mssql.replica.get


レプリカを返します。
戻り値:JSONオブジェクト

詳細については、MSSQLプラグインのreadmeを参照してください。

mssql.version


MSSQLのバージョンを返します。
戻り値: 文字列

詳細については、MSSQLプラグインのreadmeを参照してください。

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


カスタムクエリの結果を返します。
戻り値: JSONオブジェクト

パラメータ:

  • connString - URIまたはセッション名;
  • user, password - MySQLのログイン認証情報;
  • queryName - カスタムクエリの名前。SQLファイル名(拡張子なし)と一致する必要があります;
  • args - クエリに渡す1つまたは複数のカンマ区切りの引数。

詳細はMySQLプラグインのreadmeのCustom queriesセクションを参照してください。

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


MySQLデータベースのリストを返します。 ローレベルディスカバリで使用されます。
戻り値: LLD JSON形式の"show databases" SQLクエリの結果。

パラメータ:

  • connString - URIまたはセッション名;
  • user, password - MySQLのログイン認証情報。
mysql.db.size[connString,<user>,<password>,<database name>]


バイト単位のデータベースサイズ。
戻り値: バイト単位で特定のデータベースに対して "select coalesce(sum(data_length + index_length),0) as size from information_schema.tables where table_schema=?" SQL クエリの結果。

パラメータ:

  • connString - URI またはセッション名;
  • user, password - MySQL のログイン認証情報;
  • database name - データベース名。
mysql.get_status_variables[connString,<user>,<password>]


グローバルステータス変数の値。
戻り値: "show global status" SQLクエリの結果をJSON形式で返します。

パラメータ:

  • connString - URIまたはセッション名;
  • user, password - MySQLのログイン認証情報。
mysql.ping[connString,<user>,<password>]


接続が生きているかどうかをテストします。
戻り値: 1 - 接続が生きている; 0 - 接続が切断されている(AUTHや設定の問題を含むエラーが発生した場合)。

パラメータ:

  • connString - URIまたはセッション名;
  • user, password - MySQLのログイン認証情報。
mysql.replication.discovery[connString,<user>,<password>]


MySQLレプリケーションのリストを返します。 ローレベルディスカバリで使用されます。
戻り値: SHOW SLAVE STATUSまたはSHOW REPLICA STATUS SQLクエリの結果をLLD JSON形式で返します。

パラメータ:

  • connString - URIまたはセッション名;
  • user, password - MySQLのログイン認証情報。
mysql.replication.get_slave_status[connString,<user>,<password>,<master host>]


レプリケーションのステータス。
戻り値: SHOW SLAVE STATUS または SHOW REPLICA STATUS SQLクエリの結果をJSON形式で返します。

パラメータ:

  • connString - URIまたはセッション名;
  • user, password - MySQLのログイン認証情報;
  • master host - レプリケーションマスターホスト名。 見つからない場合はエラーを返します。 このパラメータが指定されていない場合は、すべてのホストが返されます。
mysql.version[connString,<user>,<password>]


MySQLのバージョン。
戻り値: String (MySQLインスタンスのバージョン)。

パラメータ:

  • connString - URIまたはセッション名;
  • user, password - MySQLのログイン認証情報。
net.dns.get[<ip>,name,<type>,<timeout>,<count>,<protocol>,"<flags>"]

DNS クエリを実行し、詳細な DNS レコード情報を返します。
このアイテムは、net.dns.record Zabbix エージェント アイテムの拡張版で、より多くのレコードタイプと、カスタマイズ可能なフラグをサポートします。
戻り値: JSON object

パラメーター:

  • ip - DNS サーバーの IP アドレス(空欄の場合はデフォルトの DNS サーバーを使用);
  • name - クエリ対象の DNS 名;
  • type - クエリするレコードタイプ(デフォルトは SOA);
  • timeout - リクエストのタイムアウト(秒単位、デフォルトは 1 秒);
  • count - リクエストの試行回数(デフォルトは 2);
  • protocol - DNS クエリの実行に使用するプロトコル: udp(デフォルト)または tcp;
  • flags - クエリに渡す、カンマ区切りの 1 つ以上の引数。

コメント:

  • type に指定できる値は次のとおりです: A, NS, MD, MF, CNAME, SOA, MB, MG, MR, NULL, PTR, HINFO, MINFO, MX, TXT, RP, AFSDB, X25, ISDN, RT, NSAPPTR, SIG, KEY, PX, GPOS, AAAA, LOC, NXT, EID, NIMLOC, SRV, ATMA, NAPTR, KX, CERT, DNAME, OPT, APL, DS, SSHFP, IPSECKEY, RRSIG, NSEC, DNSKEY, DHCID, NSEC3, NSEC3PARAM, TLSA, SMIMEA, HIP, NINFO, RKEY, TALINK, CDS, CDNSKEY, OPENPGPKEY, CSYNC, ZONEMD, SVCB, HTTPS, SPF, UINFO, UID, GID, UNSPEC, NID, L32, L64, LP, EUI48, EUI64, URI, CAA, AVC, AMTRELAY。 値は大文字のみで指定する必要があります。小文字または大文字小文字混在の値はサポートされません。
  • 逆引き DNS ルックアップ(typePTR に設定されている場合)では、DNS 名を逆順形式と非逆順形式の両方で指定できます(以下の例を参照)。 PTR レコードが要求される場合、DNS 名は実際には IP アドレスです。
  • flags に指定できる値は次のとおりです:
    • cdflag または nocdflag(デフォルト);
    • rdflag(デフォルト)または nordflag;
    • dnssec または nodnssec(デフォルト);
    • nsid または nonsid(デフォルト);
    • edns0(デフォルト)または noedns0;
    • aaflag または noaaflag(デフォルト);
    • adflag または noadflag(デフォルト)。 flagsdnssecnsid は、どちらも edns0 を必要とするため、noedns0 と組み合わせて使用することはできません。 値は小文字のみで指定する必要があります。大文字または大文字小文字混在の値はサポートされません。
  • 国際化ドメイン名はサポートされていません。代わりに IDNA エンコードされた名前を使用してください。
  • 出力は、指定されたパラメーターに基づく DNS レコード情報を含むオブジェクトです(詳細はこちらを参照)。

例:

net.dns.get[192.0.2.1,example.com,DNSKEY,3,3,tcp,"cdflag,rdflag,nsid"]

net.dns.get[,198.51.100.1,PTR,,,,"cdflag,rdflag,nsid"]
net.dns.get[,1.100.51.198.in-addr.arpa,PTR,,,,"cdflag,rdflag,nsid"]

net.dns.get[,2a00:1450:400f:800::200e,PTR,,,,"cdflag,rdflag,nsid"]
net.dns.get[,e.0.0.2.0.0.0.0.0.0.0.0.0.0.0.0.0.0.8.0.f.0.0.4.0.5.4.1.0.0.a.2.ip6.arpa,PTR,,,,"cdflag,rdflag,nsid"]
nvml.device.count


GPUデバイスの数。
戻り値: 整数

詳細については、NVIDIA GPUプラグインのreadmeを参照してください。

nvml.device.decoder.utilization[<deviceUUID>]


GPUデバイスのデコーダー使用率(%)。
戻り値: 整数

パラメータ:

  • deviceUUID - GPUデバイスのUUID。

詳細はNVIDIA GPUプラグインのreadmeを参照してください。

nvml.device.ecc.mode[<deviceUUID>]


GPUデバイスのECCモード情報(現在、保留中)。
戻り値: JSON

パラメータ:

  • deviceUUID - GPUデバイスのUUID。

詳細については、NVIDIA GPUプラグインのreadmeを参照してください。

nvml.device.encoder.stats.get[<deviceUUID>]


GPUデバイスのエンコーダ統計情報。
戻り値: JSON

パラメータ:

  • deviceUUID - GPUデバイスのUUID。

詳細については、NVIDIA GPUプラグインのreadmeを参照してください。

nvml.device.encoder.utilization[<deviceUUID>]


GPUデバイスエンコーダの使用率(%)。
戻り値: 整数

パラメータ:

  • deviceUUID - GPUデバイスのUUID。

詳細はNVIDIA GPUプラグインのreadmeを参照してください。

nvml.device.energy.consumption[<deviceUUID>]


ドライバが最後にリロードされてからの、ミリジュール(mJ)単位でのGPUデバイスの総エネルギー消費量。
戻り値: 整数

パラメータ:

  • deviceUUID - GPUデバイスのUUID。

詳細については、NVIDIA GPUプラグインのREADMEを参照してください。

nvml.device.errors.memory[<deviceUUID>]


GPUデバイスのECCメモリエラー情報(修正済み、未修正)。
戻り値: JSON

パラメータ:

  • deviceUUID - GPUデバイスのUUID。

詳細はNVIDIA GPUプラグインのreadmeを参照してください。

nvml.device.errors.register[<deviceUUID>]


GPUデバイスのECCレジスタエラー情報(修正済み、未修正)。
戻り値:JSON

パラメータ:

  • deviceUUID - GPUデバイスのUUID。

詳細については、NVIDIA GPUプラグインのreadmeを参照してください。

nvml.device.fan.speed.avg[<deviceUUID>]


GPUデバイスの最大速度に対する平均ファン速度の割合。
戻り値: 整数

パラメータ:

  • deviceUUID - GPUデバイスのUUID。

詳細はNVIDIA GPUプラグインのreadmeを参照してください。

nvml.device.get


UUIDと名前で検出されたGPU。
戻り値:JSON

詳細については、NVIDIA GPUプラグインのreadmeを参照してください。

nvml.device.graphics.frequency[<deviceUUID>]


GPUデバイスのグラフィックスクロック速度(MHz単位)。
戻り値: 整数

パラメータ:

  • deviceUUID - GPUデバイスのUUID。

詳細はNVIDIA GPUプラグインのreadmeを参照してください。

nvml.device.memory.fb.get[<deviceUUID>]


GPUデバイスのフレームバッファメモリ統計情報 (total, reserved, free, used)。
戻り値: JSON

パラメータ:

  • deviceUUID - GPUデバイスのUUID。

詳細はNVIDIA GPUプラグインのreadmeを参照してください。

nvml.device.memory.bar1.get[<deviceUUID>]


GPUデバイスのBAR1メモリ統計情報 (total, free, used)。
戻り値: JSON

パラメータ:

  • deviceUUID - GPUデバイスのUUID。

詳細はNVIDIA GPUプラグインのreadmeを参照してください。

nvml.device.memory.frequency[<deviceUUID>]


GPUデバイスのメモリクロック速度(MHz単位)。
戻り値: 整数

パラメータ:

  • deviceUUID - GPUデバイスのUUID。

詳細はNVIDIA GPUプラグインのreadmeを参照してください。

nvml.device.pci.utilization[<deviceUUID>]


GPUデバイスのPCI使用率(送信/受信スループット、KBps単位)。
戻り値:JSON

パラメータ:

  • deviceUUID - GPUデバイスのUUID。

詳細については、NVIDIA GPUプラグインのreadmeを参照してください。

nvml.device.performance.state[<deviceUUID>]


GPUデバイスのパフォーマンス状態。
戻り値:整数

パラメータ:

  • deviceUUID - GPUデバイスのUUID。

詳細については、NVIDIA GPUプラグインのreadmeを参照してください。

nvml.device.power.limit[<deviceUUID>]


ミリワット単位のGPUデバイスの電力制限。
戻り値: 整数

パラメータ:

  • deviceUUID - GPUデバイスのUUID。

詳細については、NVIDIA GPUプラグインのreadmeを参照してください。

nvml.device.power.usage[<deviceUUID>]


GPUデバイスの現在の消費電力(ミリワット単位)。
戻り値: 整数

パラメータ:

  • deviceUUID - GPUデバイスのUUID。

詳細はNVIDIA GPUプラグインのreadmeを参照してください。

nvml.device.serial[<deviceUUID>]


GPUデバイスのシリアル番号。
戻り値:文字列

パラメータ:

  • deviceUUID - GPUデバイスのUUID。

詳細については、NVIDIA GPUプラグインのreadmeを参照してください。

nvml.device.sm.frequency[<deviceUUID>]


GPUデバイスのストリーミングマルチプロセッサのクロック速度(MHz単位)。
戻り値: 整数

パラメータ:

  • deviceUUID - GPUデバイスのUUID。

詳細はNVIDIA GPUプラグインのreadmeを参照してください。

nvml.device.temperature[<deviceUUID>]


GPUデバイスの温度(摂氏)。
戻り値: 整数

パラメータ:

  • deviceUUID - GPUデバイスのUUID。

詳細はNVIDIA GPUプラグインのreadmeを参照してください。

nvml.device.utilization[<deviceUUID>]


GPUデバイスの使用率統計(GPU/メモリの使用率、パーセンテージ)。
戻り値:JSON

パラメータ:

  • deviceUUID - GPUデバイスのUUID。

詳細については、NVIDIA GPUプラグインのreadmeを参照してください。

nvml.device.video.frequency[<deviceUUID>]


GPUデバイスのビデオクロック速度(MHz単位)。
戻り値: 整数

パラメータ:

  • deviceUUID - GPUデバイスのUUID。

詳細はNVIDIA GPUプラグインのreadmeを参照してください。

nvml.system.driver.version


NVIDIAドライバーのバージョン。
戻り値: 文字列

詳細については、NVIDIA GPUプラグインのreadmeを参照してください。

nvml.version


NVMLライブラリのバージョン。
戻り値: 文字列

詳細については、NVIDIA GPUプラグインのreadmeを参照してください。

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


Automatic Storage Management (ASM) ディスクグループの統計情報を返します。
戻り値: JSON object

パラメータ:

  • connString - 次のいずれかを指定できます:
    • URI - 指定された名前のセッションが見つからず、Plugins.Oracle.ResolveTNS が false に設定されている場合。
      スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方を含む場合、ResolveTNS オプションは考慮されず、いずれにしても URI として扱われます;
    • セッション名 - プラグイン設定ファイル内にその名前が見つかった場合;
    • TNS キー - ResolveTNS オプションが true に設定されており、上記のいずれの条件にも該当しない場合;
    • TNS 値 - 開き括弧 "(" で始まる場合(先頭の空白は無視されます)。
      この場合、ResolveTNS オプションは考慮されません。
  • user - Oracle ユーザー名。user as sysdba の形式で、ログインオプション as sysdbaas sysoperas sysasmas sysbackupas sysdgas syskm、または as sysrac のいずれかを末尾に追加できます(ログインオプションは大文字・小文字を区別せず、末尾にスペースを含めてはいけません)。
  • password - Oracle パスワード;
  • service - Oracle サービス名;
  • diskgroup - 問い合わせ対象の ASM ディスクグループ名。
oracle.diskgroups.discovery[connString,<user>,<password>,<service>]


ASMディスクグループの一覧を返します。 ローレベルディスカバリで使用されます。
戻り値: JSON object

パラメータ:

  • connString - 以下のいずれかを指定できます:
    • URI - 指定された名前のセッションが見つからず、Plugins.Oracle.ResolveTNS が false に設定されている場合。 スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方を含む場合、ResolveTNS オプションは考慮されず、いずれにしても URI として扱われます;
    • セッション名 - プラグイン設定ファイル内でその名前が見つかった場合;
    • TNSキー - ResolveTNS オプションが true に設定されており、かつ上記のいずれの条件にも該当しない場合;
    • TNS値 - 開き括弧 "(" で始まる場合(先頭の空白は無視されます)。 この場合、ResolveTNS オプションは考慮されません。
  • user - Oracleユーザー名。user as sysdba の形式で、ログインオプション as sysdbaas sysoperas sysasmas sysbackupas sysdgas syskm、または as sysrac のいずれかを末尾に追加できます(ログインオプションは大文字・小文字を区別せず、末尾にスペースを含めてはいけません)。
  • password - Oracleパスワード;
  • service - Oracleサービス名。
oracle.archive.info[connString,<user>,<password>,<service>,<destination>]


アーカイブログの統計情報です。
戻り値: JSON object

パラメータ:

  • connString - 次のいずれかを指定できます:
    • URI - 指定された名前のセッションが見つからず、Plugins.Oracle.ResolveTNS が false に設定されている場合。
      スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方が含まれている場合、ResolveTNS オプションは考慮されず、いずれにしても URI として扱われます;
    • セッション名 - その名前がプラグイン設定ファイル内で見つかった場合;
    • TNSキー - ResolveTNS オプションが true に設定されており、かつ上記のいずれの条件にも該当しない場合;
    • TNS値 - 先頭が開き括弧 "(" の場合(先頭の空白は無視されます)。
      この場合、ResolveTNS オプションは考慮されません。
  • user - Oracle のユーザー名。user as sysdba の形式で、ログインオプション as sysdbaas sysoperas sysasmas sysbackupas sysdgas syskm、または as sysrac のいずれかを末尾に追加できます(ログインオプションは大文字・小文字を区別せず、末尾にスペースを含めてはいけません)。
  • password - Oracle のパスワード;
  • service - Oracle のサービス名;
  • destination - 問い合わせる宛先の名前。
oracle.cdb.info[connString,<user>,<password>,<service>,<database>]


コンテナデータベース(CDB)の情報です。
戻り値: JSON object

パラメータ:

  • connString - 次のいずれかを指定できます:
    • URI - 指定された名前のセッションが見つからず、Plugins.Oracle.ResolveTNS が false に設定されている場合。
      スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方を含む場合、ResolveTNS オプションは考慮されず、いずれにしても URI として扱われます。
    • セッション名 - その名前がプラグイン設定ファイル内に存在する場合。
    • TNSキー - ResolveTNS オプションが true に設定されており、かつ上記のいずれの条件にも該当しない場合。
    • TNS値 - 開き括弧 "(" で始まる場合(先頭の空白は無視されます)。
      この場合、ResolveTNS オプションは考慮されません。
  • user - Oracleのユーザー名。user as sysdba の形式で、ログインオプション as sysdbaas sysoperas sysasmas sysbackupas sysdgas syskm、または as sysrac のいずれかを末尾に追加できます(ログインオプションでは大文字と小文字は区別されず、末尾にスペースを含めてはいけません)。
  • password - Oracleのパスワード。
  • service - Oracleのサービス名。
  • database - 問い合わせ対象のデータベース名。
oracle.custom.query[connString,<user>,<password>,<service>,queryName,<args...>]


カスタムクエリの結果です。
戻り値: JSON object

パラメータ:

  • connString - 以下のいずれかを指定できます:
    • URI - 指定された名前のセッションが見つからず、かつ Plugins.Oracle.ResolveTNS が false に設定されている場合。
      スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方を含む場合、ResolveTNS オプションは考慮されず、いずれにしても URI として扱われます。
    • セッション名 - その名前がプラグイン設定ファイル内で見つかった場合。
    • TNSキー - ResolveTNS オプションが true に設定されており、かつ上記のいずれの条件にも該当しない場合。
    • TNS値 - 開き括弧 "(" で始まる場合(先頭の空白は無視されます)。 この場合、ResolveTNS オプションは考慮されません。
  • user - Oracleのユーザー名。ログインオプション as sysdbaas sysoperas sysasmas sysbackupas sysdgas syskmas sysrac のいずれかを user as sysdba の形式で末尾に追加できます(ログインオプションは大文字・小文字を区別せず、末尾に空白を含めてはいけません)。
  • password - Oracleのパスワード。
  • service - Oracleのサービス名。
  • queryName - カスタムクエリの名前。拡張子を除いたSQLファイル名と一致する必要があります。
  • args - クエリに渡す、カンマ区切りの1つまたは複数の引数。

コメント:

  • 返されたデータは自動的にJSONに変換されます。
  • クエリから直接JSONを返すことは避けてください。プラグインが再度JSONに変換しようとする際に破損するためです。
oracle.datafiles.stats[connString,<user>,<password>,<service>]


データファイルの統計情報を返します。
戻り値: JSON object

パラメータ:

  • connString - 以下のいずれかを指定できます:
    • URI - 指定された名前のセッションが見つからず、Plugins.Oracle.ResolveTNS が false に設定されている場合。
      これにスキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方が含まれている場合、ResolveTNS オプションは考慮されず、いずれにしても URI として扱われます;
    • セッション名 - その名前がプラグイン設定ファイル内で見つかった場合;
    • TNSキー - ResolveTNS オプションが true に設定されており、かつ上記のいずれの条件にも該当しない場合;
    • TNS値 - 開き括弧 "(" で始まる場合(先頭の空白は無視されます)。
      この場合、ResolveTNS オプションは考慮されません。
  • user - Oracle のユーザー名。user as sysdba の形式で、ログインオプション as sysdbaas sysoperas sysasmas sysbackupas sysdgas syskm、または as sysrac のいずれかを末尾に追加できます(ログインオプションは大文字・小文字を区別せず、末尾にスペースを含めてはいけません)。
  • password - Oracle のパスワード;
  • service - Oracle のサービス名。
oracle.db.discovery[connString,<user>,<password>,<service>]


データベースの一覧を返します。 ローレベルディスカバリで使用されます。
戻り値: JSON object

パラメータ:

  • connString - 次のいずれかを指定できます:
    • URI - 指定された名前のセッションが見つからず、Plugins.Oracle.ResolveTNS が false に設定されている場合。 スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方が含まれている場合、ResolveTNS オプションは考慮されず、いずれにしても URI として扱われます;
    • セッション名 - その名前がプラグイン設定ファイル内で見つかった場合;
    • TNSキー - ResolveTNS オプションが true に設定されており、かつ上記のいずれの条件にも該当しない場合;
    • TNS値 - 開き括弧 "(" で始まる場合(先頭の空白は無視されます)。 この場合、ResolveTNS オプションは考慮されません。
  • user - Oracleのユーザー名。user as sysdba の形式で、ログインオプション as sysdbaas sysoperas sysasmas sysbackupas sysdgas syskm、または as sysrac のいずれかを追加できます(ログインオプションでは大文字と小文字は区別されず、末尾にスペースを含めてはいけません)。
  • password - Oracleのパスワード;
  • service - Oracleのサービス名。
oracle.fra.stats[connString,<user>,<password>,<service>]


Fast Recovery Area(FRA)の統計情報を返します。
戻り値: JSON object

パラメータ:

  • connString - 以下のいずれかを指定できます:
    • URI - 指定された名前のセッションが見つからず、Plugins.Oracle.ResolveTNS が false に設定されている場合。
      スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方を含む場合、ResolveTNS オプションは考慮されず、いずれにしても URI として扱われます;
    • セッション名 - その名前がプラグイン設定ファイル内で見つかった場合;
    • TNSキー - ResolveTNS オプションが true に設定されており、かつ上記のいずれの条件にも該当しない場合;
    • TNS値 - 開き括弧 "(" で始まる場合(先頭の空白は無視されます)。
      この場合、ResolveTNS オプションは考慮されません。
  • user - Oracleユーザー名。user as sysdba の形式で、ログインオプション as sysdbaas sysoperas sysasmas sysbackupas sysdgas syskm、または as sysrac のいずれかを末尾に追加できます(ログインオプションでは大文字と小文字は区別されず、末尾にスペースを含めてはいけません)。
  • password - Oracleパスワード;
  • service - Oracleサービス名。
oracle.instance.info[connString,<user>,<password>,<service>]


インスタンスの統計情報です。
戻り値: JSON object

パラメータ:

  • connString - 次のいずれかを指定できます:
    • URI - 指定された名前のセッションが見つからず、Plugins.Oracle.ResolveTNS が false に設定されている場合。
      スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方を含む場合、ResolveTNS オプションは考慮されず、いずれにしても URI として扱われます。
    • セッション名 - その名前がプラグイン設定ファイル内で見つかった場合。
    • TNSキー - ResolveTNS オプションが true に設定されており、かつ上記のいずれの条件にも該当しない場合。
    • TNS値 - 開き括弧 "(" で始まる場合(先頭の空白は無視されます)。
      この場合、ResolveTNS オプションは考慮されません。
  • user - Oracleユーザー名。user as sysdba の形式で、ログインオプション as sysdbaas sysoperas sysasmas sysbackupas sysdgas syskm、または as sysrac のいずれかを末尾に追加できます(ログインオプションでは大文字と小文字は区別されず、末尾にスペースを含めてはいけません)。
  • password - Oracleパスワード。
  • service - Oracleサービス名。
oracle.pdb.info[connString,<user>,<password>,<service>,<database>]


プラガブルデータベース(PDB)の情報です。
戻り値: JSON object

パラメータ:

  • connString - 次のいずれかを指定できます:
    • URI - 指定された名前のセッションが見つからず、Plugins.Oracle.ResolveTNS が false に設定されている場合。
      スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方を含む場合、ResolveTNS オプションは考慮されず、いずれにしても URI として扱われます。
    • セッション名 - その名前がプラグイン設定ファイル内で見つかった場合。
    • TNSキー - ResolveTNS オプションが true に設定されており、かつ上記のいずれの条件にも該当しない場合。
    • TNS値 - 開き括弧 "(" で始まる場合(先頭の空白は無視されます)。 この場合、ResolveTNS オプションは考慮されません。
  • user - Oracleのユーザー名。user as sysdba の形式で、ログインオプション as sysdbaas sysoperas sysasmas sysbackupas sysdgas syskm、または as sysrac のいずれかを末尾に追加できます(ログインオプションでは大文字・小文字は区別されず、末尾にスペースを含めてはいけません)。
  • password - Oracleのパスワード。
  • service - Oracleのサービス名。
  • database - 問い合わせ対象のデータベース名。
oracle.pdb.discovery[connString,<user>,<password>,<service>]


PDBのリストを返します。 ローレベルディスカバリで使用されます。
戻り値: JSON object

パラメータ:

  • connString - 以下のいずれかを指定できます:
    • URI - 指定された名前のセッションが見つからず、Plugins.Oracle.ResolveTNS が false に設定されている場合。
      スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方が含まれている場合、ResolveTNS オプションは考慮されず、いずれにしても URI として扱われます;
    • セッション名 - その名前がプラグイン設定ファイル内で見つかった場合;
    • TNSキー - ResolveTNS オプションが true に設定されており、かつ上記のいずれの条件にも該当しない場合;
    • TNS値 - 先頭が開き括弧 "(" で始まる場合(先頭の空白は無視されます)。 この場合、ResolveTNS オプションは考慮されません。
  • user - Oracleのユーザー名。user as sysdba の形式で、ログインオプション as sysdbaas sysoperas sysasmas sysbackupas sysdgas syskm、または as sysrac のいずれかを末尾に追加できます(ログインオプションは大文字・小文字を区別せず、末尾に空白を含めてはいけません)。
  • password - Oracleのパスワード;
  • service - Oracleのサービス名。
oracle.pga.stats[connString,<user>,<password>,<service>]


Program Global Area (PGA) の統計情報を返します。
戻り値: JSON object

パラメータ:

  • connString - 以下のいずれかを指定できます:
    • URI - 指定された名前のセッションが見つからず、Plugins.Oracle.ResolveTNS が false に設定されている場合。
      スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方を含む場合、ResolveTNS オプションは考慮されず、いずれにしても URI として扱われます。
    • セッション名 - その名前がプラグイン設定ファイル内に存在する場合。
    • TNS キー - ResolveTNS オプションが true に設定されており、かつ上記のいずれの条件にも該当しない場合。
    • TNS 値 - 先頭が開き括弧 "(" の場合(先頭の空白は無視されます)。
      この場合、ResolveTNS オプションは考慮されません。
  • user - Oracle のユーザー名。user as sysdba の形式で、ログインオプション as sysdbaas sysoperas sysasmas sysbackupas sysdgas syskm、または as sysrac のいずれかを末尾に追加できます(ログインオプションは大文字・小文字を区別せず、末尾にスペースを含めてはいけません)。
  • password - Oracle のパスワード。
  • service - Oracle のサービス名。
oracle.ping[connString,<user>,<password>,<service>]


Oracleへの接続を確立できるかどうかをテストします。
戻り値: 1 - 接続成功; 0 - 接続切断(AUTHおよび設定の問題を含む、何らかのエラーが発生した場合)。

パラメータ:

  • connString - 以下のいずれかを指定できます:
    • URI - 指定された名前のセッションが見つからず、Plugins.Oracle.ResolveTNS が false に設定されている場合。 スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方が含まれている場合、ResolveTNS オプションは考慮されず、いずれにしてもURIとして扱われます;
    • セッション名 - プラグイン設定ファイル内にその名前が見つかった場合;
    • TNSキー - ResolveTNS オプションが true に設定されており、かつ上記のいずれの条件にも該当しない場合;
    • TNS値 - 開き括弧 "(" で始まる場合(先頭の空白は無視されます)。 この場合、ResolveTNS オプションは考慮されません。
  • user - Oracleユーザー名。ログインオプション as sysdbaas sysoperas sysasmas sysbackupas sysdgas syskm、または as sysrac のいずれかを user as sysdba の形式で末尾に追加できます(ログインオプションは大文字小文字を区別せず、末尾にスペースを含めてはいけません)。
  • password - Oracleパスワード;
  • service - Oracleサービス名。

例:

oracle.ping[tcp://127.0.0.1:1521,ZABBIX_MON,zabbix,xe]
oracle.ping[localhost,ZABBIX_MON,zabbix,xe]
oracle.ping[zbx_tns_example,ZABBIX_MON,zabbix,xe]
oracle.ping["(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=localhost)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=xe)))",ZABBIX_MON,zabbix]
oracle.proc.stats[connString,<user>,<password>,<service>]


プロセスの統計情報を返します。
戻り値: JSON object

パラメータ:

  • connString - 次のいずれかを指定できます:
    • URI - 指定された名前のセッションが見つからず、Plugins.Oracle.ResolveTNS が false に設定されている場合。
      スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方を含む場合、ResolveTNS オプションは考慮されず、いずれにしても URI として扱われます。
    • セッション名 - その名前がプラグイン設定ファイル内で見つかった場合。
    • TNSキー - ResolveTNS オプションが true に設定されており、かつ上記のいずれの条件にも該当しない場合。
    • TNS値 - 開き括弧 "(" で始まる場合(先頭の空白は無視されます)。
      この場合、ResolveTNS オプションは考慮されません。
  • user - Oracleユーザー名。ログインオプション as sysdbaas sysoperas sysasmas sysbackupas sysdgas syskmas sysrac のいずれかを user as sysdba の形式で末尾に追加できます(ログインオプションは大文字小文字を区別せず、末尾に空白を含めてはいけません)。
  • password - Oracleパスワード。
  • service - Oracleサービス名。
oracle.redolog.info[connString,<user>,<password>,<service>]


制御ファイルから取得したログファイル情報です。
戻り値: JSON object

パラメータ:

  • connString - 以下のいずれかを指定できます:
    • URI - 指定された名前のセッションが見つからず、かつ Plugins.Oracle.ResolveTNS が false に設定されている場合。
      スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方が含まれている場合、ResolveTNS オプションは考慮されず、いずれにしても URI として扱われます。
    • セッション名 - その名前がプラグイン設定ファイル内で見つかった場合。
    • TNSキー - ResolveTNS オプションが true に設定されており、かつ上記のいずれの条件にも該当しない場合。
    • TNS値 - 開き括弧 "(" で始まる場合(先頭の空白は無視されます)。
      この場合、ResolveTNS オプションは考慮されません。
  • user - Oracleユーザー名。user as sysdba の形式で、ログインオプション as sysdbaas sysoperas sysasmas sysbackupas sysdgas syskm、または as sysrac のいずれかを末尾に追加できます(ログインオプションは大文字・小文字を区別せず、末尾に空白を含めてはいけません)。
  • password - Oracleパスワード。
  • service - Oracleサービス名。
oracle.sga.stats[connString,<user>,<password>,<service>]


システムグローバル領域(SGA)の統計情報を返します。
戻り値: JSON object

パラメータ:

  • connString - 次のいずれかを指定できます:
    • URI - 指定された名前のセッションが見つからず、Plugins.Oracle.ResolveTNS が false に設定されている場合。 スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方が含まれている場合、ResolveTNS オプションは考慮されず、いずれにしても URI として扱われます;
    • セッション名 - その名前がプラグイン設定ファイル内で見つかった場合;
    • TNSキー - ResolveTNS オプションが true に設定されており、かつ上記のいずれの条件にも該当しない場合;
    • TNS値 - 開き括弧 "(" で始まる場合(先頭の空白は無視されます)。 この場合、ResolveTNS オプションは考慮されません。
  • user - Oracleのユーザー名。user as sysdba の形式で、ログインオプション as sysdbaas sysoperas sysasmas sysbackupas sysdgas syskm、または as sysrac のいずれかを付加できます(ログインオプションでは大文字と小文字は区別されず、末尾にスペースを含めてはいけません)。
  • password - Oracleのパスワード;
  • service - Oracleのサービス名。
oracle.sessions.stats[connString,<user>,<password>,<service>,<lockMaxTime>]


セッションの統計情報を返します。
戻り値: JSON object

パラメータ:

  • connString - 次のいずれかを指定できます:
    • URI - 指定された名前のセッションが見つからず、Plugins.Oracle.ResolveTNS が false に設定されている場合。
      スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方を含む場合、ResolveTNS オプションは考慮されず、いずれにしても URI として扱われます;
    • セッション名 - その名前がプラグイン設定ファイル内で見つかった場合;
    • TNSキー - ResolveTNS オプションが true に設定されており、かつ上記のいずれの条件にも該当しない場合;
    • TNS値 - 開き括弧 "(" で始まる場合(先頭の空白は無視されます)。
      この場合、ResolveTNS オプションは考慮されません。
  • user - Oracle のユーザー名。user as sysdba の形式で、ログインオプション as sysdbaas sysoperas sysasmas sysbackupas sysdgas syskm、または as sysrac のいずれかを末尾に追加できます(ログインオプションは大文字小文字を区別せず、末尾にスペースを含めてはいけません)。
  • password - Oracle のパスワード;
  • service - Oracle のサービス名;
  • lockMaxTime - セッションを長時間ロックされているものとしてカウントするための、セッションロックの最大継続時間(秒)。 デフォルト: 600 秒。
oracle.sys.metrics[connString,<user>,<password>,<service>,<duration>]


システムメトリクス値のセットを返します。
戻り値: JSON object

パラメータ:

  • connString - 次のいずれかを指定できます:
    • URI - 指定された名前のセッションが見つからず、かつ Plugins.Oracle.ResolveTNS が false に設定されている場合。
      スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方を含む場合、ResolveTNS オプションは考慮されず、いずれにしても URI として扱われます;
    • セッション名 - プラグイン設定ファイル内にその名前が見つかった場合;
    • TNSキー - ResolveTNS オプションが true に設定されており、かつ上記のいずれの条件にも該当しない場合;
    • TNS値 - 開き括弧 "(" で始まる場合(先頭の空白は無視されます)。 この場合、ResolveTNS オプションは考慮されません。
  • user - Oracleユーザー名。user as sysdba の形式で、ログインオプション as sysdbaas sysoperas sysasmas sysbackupas sysdgas syskm、または as sysrac のいずれかを末尾に追加できます(ログインオプションでは大文字と小文字は区別されず、末尾に空白を含めてはいけません)。
  • password - Oracleパスワード;
  • service - Oracleサービス名;
  • duration - システムメトリクス値の取得間隔(秒単位)。 指定可能な値: 60 — 長い期間(デフォルト)、15 — 短い期間。
oracle.sys.params[connString,<user>,<password>,<service>]


システムパラメータ値のセットを返します。
戻り値: JSON object

パラメータ:

  • connString - 次のいずれかを指定できます:
    • URI - 指定された名前のセッションが見つからず、Plugins.Oracle.ResolveTNS が false に設定されている場合。 スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方を含む場合、ResolveTNS オプションは考慮されず、いずれにしても URI として扱われます;
    • セッション名 - その名前がプラグイン設定ファイル内で見つかった場合;
    • TNSキー - ResolveTNS オプションが true に設定されており、かつ上記のいずれの条件にも該当しない場合;
    • TNS値 - 開き括弧 "(" で始まる場合(先頭の空白は無視されます)。 この場合、ResolveTNS オプションは考慮されません。
  • user - Oracleユーザー名。user as sysdba の形式で、ログインオプション as sysdbaas sysoperas sysasmas sysbackupas sysdgas syskm、または as sysrac のいずれかを末尾に追加できます(ログインオプションでは大文字と小文字は区別されず、末尾にスペースを含めてはいけません)。
  • password - Oracleパスワード;
  • service - Oracleサービス名。
oracle.ts.stats[connString,<user>,<password>,<service>,<tablespace>,<type>,<conname>]


表領域の統計情報を返します。
戻り値: JSON object

パラメータ:

  • connString - 次のいずれかを指定できます:
    • URI - 指定された名前のセッションが見つからず、Plugins.Oracle.ResolveTNS が false に設定されている場合。
      スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方を含む場合、ResolveTNS オプションは考慮されず、いずれにしても URI として扱われます。
    • セッション名 - その名前がプラグイン設定ファイル内に存在する場合。
    • TNSキー - ResolveTNS オプションが true に設定されており、かつ上記のいずれの条件にも該当しない場合。
    • TNS値 - 開き括弧 "(" で始まる場合(先頭の空白は無視されます)。
      この場合、ResolveTNS オプションは考慮されません。
  • user - Oracle のユーザー名。user as sysdba の形式で、ログインオプション as sysdbaas sysoperas sysasmas sysbackupas sysdgas syskm、または as sysrac のいずれかを末尾に追加できます(ログインオプションは大文字・小文字を区別せず、末尾に空白を含めてはいけません)。
  • password - Oracle のパスワード。
  • service - Oracle のサービス名。
  • tablespace - 問い合わせ対象の表領域名。
    デフォルト(空のままで type が設定されている場合):
    • "TEMP"(type が "TEMPORARY" に設定されている場合)
    • "USERS"(type が "PERMANENT" に設定されている場合)
  • type - 問い合わせ対象の表領域のタイプ。
    デフォルト(tablespace が設定されている場合): "PERMANENT"。
  • conname - 情報が必要なコンテナ名。

tablespacetype、または conname が省略された場合、このアイテムは一致するすべてのコンテナ(PDB および CDB を含む)の表領域統計情報を返します。

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


表領域のリストを返します。 ローレベルディスカバリで使用されます。
戻り値: JSON object

パラメータ:

  • connString - 以下のいずれかを指定できます:
    • URI - 指定された名前のセッションが見つからず、Plugins.Oracle.ResolveTNS が false に設定されている場合。 スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方が含まれている場合、ResolveTNS オプションは考慮されず、いずれにしても URI として扱われます。
    • セッション名 - その名前がプラグイン設定ファイル内で見つかった場合。
    • TNSキー - ResolveTNS オプションが true に設定されており、かつ上記のいずれの条件にも該当しない場合。
    • TNS値 - 先頭が開き括弧 "(" の場合(先頭の空白は無視されます)。 この場合、ResolveTNS オプションは考慮されません。
  • user - Oracleユーザー名。user as sysdba の形式で、ログインオプション as sysdbaas sysoperas sysasmas sysbackupas sysdgas syskm、または as sysrac のいずれかを末尾に追加できます(ログインオプションは大文字・小文字を区別せず、末尾に空白を含めてはいけません)。
  • password - Oracleパスワード。
  • service - Oracleサービス名。
oracle.user.info[connString,<user>,<password>,<service>,<username>]


Oracleユーザー情報を返します。
戻り値: JSON object

パラメータ:

  • connString - 以下のいずれかを指定できます:
    • URI - 指定された名前のセッションが見つからず、Plugins.Oracle.ResolveTNS が false に設定されている場合。
      スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方を含む場合、ResolveTNS オプションは考慮されず、いずれにしても URI として扱われます;
    • セッション名 - その名前がプラグイン設定ファイル内で見つかった場合;
    • TNSキー - ResolveTNS オプションが true に設定されており、かつ上記のいずれの条件にも該当しない場合;
    • TNS値 - 開き括弧 "(" で始まる場合(先頭の空白は無視されます)。 この場合、ResolveTNS オプションは考慮されません。
  • user - Oracleユーザー名。user as sysdba の形式で、ログインオプション as sysdbaas sysoperas sysasmas sysbackupas sysdgas syskm、または as sysrac のいずれかを末尾に追加できます(ログインオプションは大文字・小文字を区別せず、末尾にスペースを含めてはいけません)。
  • password - Oracleパスワード;
  • service - Oracleサービス名;
  • username - 情報が必要なユーザー名。 小文字のユーザー名はサポートされていません。 デフォルト: 現在のユーザー。
oracle.version[connString,<user>,<password>,<service>]


データベースサーバーのバージョンを返します。
戻り値: String

パラメータ:

  • connString - 次のいずれかを指定できます:
    • URI - 指定された名前のセッションが見つからず、Plugins.Oracle.ResolveTNS が false に設定されている場合。 スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方が含まれている場合、ResolveTNS オプションは考慮されず、いずれにしても URI として扱われます;
    • セッション名 - その名前がプラグイン設定ファイル内で見つかった場合;
    • TNSキー - ResolveTNS オプションが true に設定されており、かつ上記のいずれの条件にも該当しない場合;
    • TNS値 - 開き括弧 "(" で始まる場合(先頭の空白は無視されます)。 この場合、ResolveTNS オプションは考慮されません。
      - user - Oracleユーザー名。user as sysdba の形式で、ログインオプション as sysdbaas sysoperas sysasmas sysbackupas sysdgas syskm、または as sysrac のいずれかを末尾に追加できます(ログインオプションは大文字小文字を区別せず、末尾に空白を含めてはいけません)。
  • password - Oracleパスワード;
  • service - Oracleサービス名。
pgsql.autovacuum.count[uri,<username>,<password>,<database name>]


autovacuum ワーカーの数。
戻り値: Integer

パラメーター:

  • uri - URI またはセッション名;
  • username, password - PostgreSQL の認証情報;
  • database name - データベース名(省略した場合は、postgresql.confPlugins.PostgreSQL.Default.Database の値が使用されます)。
pgsql.archive[uri,<username>,<password>,<database name>]


アーカイブされたファイルに関する情報。
戻り値: JSON object

パラメーター:

  • uri - URI またはセッション名;
  • username, password - PostgreSQL の認証情報;
  • database name - データベース名(省略した場合は、postgresql.confPlugins.PostgreSQL.Default.Database の値が使用されます)。
pgsql.bgwriter[uri,<username>,<password>,<database name>]


データベースクラスタのチェックポイント総数を、チェックポイントの種類ごとに分類して示します。
戻り値: JSON object

パラメーター:

  • uri - URI またはセッション名;
  • username, password - PostgreSQL の認証情報;
  • database name - データベース名(省略した場合は、postgresql.confPlugins.PostgreSQL.Default.Database の値が使用されます)。
pgsql.cache.hit[uri,<username>,<password>,<database name>]


PostgreSQL のバッファキャッシュヒット率。
戻り値: Float

パラメーター:

  • uri - URI またはセッション名。
  • username, password - PostgreSQL の認証情報。
  • database name - データベース名(省略した場合は、postgresql.confPlugins.PostgreSQL.Default.Database の値が使用されます)。
pgsql.connections[uri,<username>,<password>,<database name>]


種類ごとの接続を返します。
戻り値: JSON object

パラメーター:

  • uri - URI またはセッション名;
  • username, password - PostgreSQL の認証情報;
  • database name - データベース名(省略した場合は、postgresql.confPlugins.PostgreSQL.Default.Database の値が使用されます)。
pgsql.custom.query[uri,<username>,<password>,queryName,<args...>]


カスタムクエリの結果を返します。
戻り値: JSONオブジェクト

パラメータ:

  • uri - URIまたはセッション名;
  • username, password - PostgreSQLの認証情報;
  • queryName - カスタムクエリの名前。SQLファイル名(拡張子なし)と一致する必要があります;
  • args - クエリに渡す1つまたは複数のカンマ区切りの引数。
pgsql.db.age[uri,<username>,<password>,<database name>]


データベース内で最も古い FrozenXID の経過時間(トランザクション数)。
戻り値: Integer

パラメーター:

  • uri - URI またはセッション名;
  • username, password - PostgreSQL の認証情報;
  • database name - データベース名(省略した場合は、postgresql.confPlugins.PostgreSQL.Default.Database の値が使用されます)。
pgsql.db.bloating_tables[uri,<username>,<password>,<database name>]


各データベースごとの肥大化したテーブル数。
戻り値: Integer

パラメーター:

  • uri - URI またはセッション名;
  • username, password - PostgreSQL の認証情報;
  • database name - データベース名(省略した場合は、postgresql.confPlugins.PostgreSQL.Default.Database の値が使用されます)。
pgsql.db.discovery[uri,<username>,<password>,<database name>]


PostgreSQLデータベースの一覧です。 low-level discovery に使用されます。
戻り値: JSON object

パラメーター:

  • uri - URI またはセッション名;
  • username, password - PostgreSQL の認証情報;
  • database name - データベース名(省略した場合は、postgresql.confPlugins.PostgreSQL.Default.Database の値が使用されます)。
pgsql.db.size[uri,<username>,<password>,<database name>]


データベースサイズをバイト単位で返します。
戻り値: Integer

パラメーター:

  • uri - URI またはセッション名;
  • username, password - PostgreSQL の認証情報;
  • database name - データベース名(省略した場合は、postgresql.confPlugins.PostgreSQL.Default.Database の値が使用されます)。
pgsql.dbstat[uri,<username>,<password>,<database name>]


データベースごとの統計情報を収集します。 低レベルディスカバリで使用されます。
戻り値: JSON object

パラメーター:

  • uri - URI またはセッション名;
  • username, password - PostgreSQL の認証情報;
  • database name - データベース名(省略した場合は、postgresql.confPlugins.PostgreSQL.Default.Database の値が使用されます)。
pgsql.dbstat.sum[uri,<username>,<password>,<database name>]


クラスター内のすべてのデータベースの集計データ。
戻り値: JSON object

パラメーター:

  • uri - URIまたはセッション名。
  • username, password - PostgreSQLの認証情報。
  • database name - データベース名(省略した場合は、postgresql.confPlugins.PostgreSQL.Default.Database の値が使用されます)。
pgsql.locks[uri,<username>,<password>,<database name>]


データベースごとの付与済みロックに関する情報です。 低レベルディスカバリに使用されます。
戻り値: JSON object

パラメーター:

  • uri - URI またはセッション名;
  • username, password - PostgreSQL の認証情報;
  • database name - データベース名 (省略した場合は、postgresql.confPlugins.PostgreSQL.Default.Database の値が使用されます)。
pgsql.oldest.xid[uri,<username>,<password>,<database name>]


最も古い XID の経過時間(トランザクション数)。
戻り値: Integer

パラメーター:

  • uri - URI またはセッション名;
  • username, password - PostgreSQL の認証情報;
  • database name - データベース名(省略した場合は、postgresql.confPlugins.PostgreSQL.Default.Database の値が使用されます)。
pgsql.ping[uri,<username>,<password>,<database name>]


接続が生きているかどうかをテストします。
戻り値: 1 - 接続は生きています; 0 - 接続は切断されています (AUTH や設定の問題を含む、何らかのエラーが発生した場合)。

パラメーター:

  • uri - URI またはセッション名;
  • username, password - PostgreSQL の認証情報;
  • database name - データベース名 (省略した場合は、postgresql.confPlugins.PostgreSQL.Default.Database の値が使用されます)。
pgsql.queries[uri,<username>,<password>,<database name>,time period]


実行時間でクエリのメトリクスを取得します。
戻り値: JSON object

パラメーター:

  • uri - URI またはセッション名;
  • username, password - PostgreSQL の認証情報;
  • database name - データベース名(省略した場合は、postgresql.confPlugins.PostgreSQL.Default.Database の値が使用されます);
  • time period - スロークエリ数の実行時間しきい値(正の整数である必要があります)。
pgsql.replication.count[uri,<username>,<password>]


スタンバイサーバーの数。
戻り値:整数

パラメータ:

  • uri - URIまたはセッション名;
  • username, password - PostgreSQLの認証情報。
pgsql.replication.process[uri,<username>,<password>]


各送信プロセスごとのフラッシュラグ、書き込みラグ、リプレイラグ。
戻り値:JSONオブジェクト

パラメータ:

  • uri - URIまたはセッション名;
  • username, password - PostgreSQLの認証情報。
pgsql.replication.process.discovery[uri,<username>,<password>]


レプリケーションプロセス名のディスカバリ。
戻り値: JSONオブジェクト

パラメータ:

  • uri - URIまたはセッション名;
  • username, password - PostgreSQLの認証情報。
pgsql.replication.recovery_role[uri,<username>,<password>]


リカバリーステータス。
戻り値: 0 - マスターモード; 1 - リカバリーがまだ進行中 (スタンバイモード)。

パラメータ:

  • uri - URIまたはセッション名;
  • username, password - PostgreSQLの認証情報。
pgsql.replication.status[uri,<username>,<password>]


レプリケーションのステータス。
戻り値: 0 - ストリーミングがダウン; 1 - ストリーミングがアップ; 2 - マスターモード。

パラメータ:

  • uri - URIまたはセッション名;
  • username, password - PostgreSQLの認証情報。
pgsql.replication_lag.b[uri,<username>,<password>]


レプリケーションラグ(バイト単位)
戻り値:整数

パラメータ:

  • uri - URIまたはセッション名
  • username, password - PostgreSQLの認証情報
pgsql.replication_lag.sec[uri,<username>,<password>]


レプリケーションラグ(秒単位)
戻り値:整数

パラメータ:

  • uri - URIまたはセッション名
  • username, password - PostgreSQLの認証情報
pgsql.uptime[uri,<username>,<password>,<database name>]


PostgreSQL の稼働時間をミリ秒単位で返します。
戻り値: Float

パラメーター:

  • uri - URI またはセッション名;
  • username, password - PostgreSQL の認証情報;
  • database name - データベース名(省略した場合は、postgresql.confPlugins.PostgreSQL.Default.Database の値が使用されます)。
pgsql.version[uri,<username>,<password>,<database name>]


PostgreSQLのバージョンを返します。
戻り値: String

パラメーター:

  • uri - URIまたはセッション名。
  • username, password - PostgreSQLの認証情報。
  • database name - データベース名(省略した場合は、postgresql.confPlugins.PostgreSQL.Default.Database の値が使用されます)。
pgsql.wal.stat[uri,<username>,<password>,<database name>]


WAL統計情報。
戻り値: JSON object

パラメーター:

  • uri - URIまたはセッション名;
  • username, password - PostgreSQLの認証情報;
  • database name - データベース名(省略した場合は、postgresql.confPlugins.PostgreSQL.Default.Database の値が使用されます)。
redis.config[connString,<password>,<pattern>]


パターンに一致するRedisインスタンスの設定パラメータを取得します。
戻り値: JSON - グロブスタイルのパターンが使用された場合; パターンにワイルドカード文字が含まれていない場合は単一の値。

パラメータ:

  • connString - URIまたはセッション名;
  • password - Redisのパスワード;
  • pattern - グロブスタイルのパターン(デフォルトは\)。

コメント:

  • セキュリティ警告: redis.configはRedisのCONFIG GETコマンドを実行し、機密性の高い設定パラメータ(例えばrequirepassmasterauth、TLS関連の設定、その他のシークレット)を返す場合があります。 デフォルトパターン(*)や広範なパターンを使用すると、Zabbixでアイテム値の表示権限を持つ誰にでもこれらのシークレットが公開される可能性があります。
redis.info[connString,<password>,<section>]


INFOコマンドの出力を取得します。
戻り値: JSON - 出力はJSONとしてシリアライズされます。

パラメータ:

  • connString - URIまたはセッション名;
  • password - Redisのパスワード;
  • section - 情報のセクション(デフォルトはdefault)。
redis.ping[connString,<password>]


接続が生きているかどうかをテストします。
戻り値: 1 - 接続が生きている; 0 - 接続が切れている (AUTHや設定の問題を含むエラーが発生した場合)。

パラメータ:

  • connString - URIまたはセッション名;
  • password - Redisのパスワード。
redis.slowlog.count[connString,<password>]


Redisが起動してからのスローログエントリの数。
戻り値: 整数

パラメータ:

  • connString - URIまたはセッション名;
  • password - Redisのパスワード。
smart.attribute.discovery


S.M.A.R.T. デバイス属性の一覧を返します。
戻り値: JSON object

コメント:

  • 次のマクロとその値が返されます: {#NAME}{#DISKTYPE}{#ID}{#ATTRNAME}{#THRESH};
  • HDD、SSD、NVME のドライブタイプがサポートされています。 ドライブは単体でも RAID で組み合わせても使用できます。 RAID の場合、{#NAME} には追加情報が付与されます。例: {"{#NAME}": "/dev/sda cciss,2"}
smart.disk.discovery[<type>]


S.M.A.R.T. デバイスの一覧を返します。
戻り値: JSON object

パラメーター:

  • type - ディスクをスキャンするための値を指定します。 使用可能な値: id, name (デフォルト)。 id は Windows ではサポートされておらず、選択するとエラーを返します

コメント:

  • 次のマクロとその値が返されます: {#NAME}, {#DISKTYPE}, {#MODEL}, {#SN}, {#PATH}, {#ATTRIBUTES}, {#RAIDTYPE};
  • HDD、SSD、NVME ドライブタイプがサポートされています。 ドライブが RAID に属していない場合、{#RAIDTYPE} は空になります。 {#NAME} には RAID の場合に追加情報が付きます。例: {"{#NAME}": "/dev/sda cciss,2"}
smart.disk.get[<path>,<raid type>]


S.M.A.R.T. デバイスで利用可能なすべてのプロパティを返します。
戻り値: JSON object

パラメーター:

  • path - ディスクのパス。値として {#PATH} マクロを使用できます;
  • raid_type - RAID の種類。値として {#RAID} マクロを使用できます

コメント:

  • HDD、SSD、NVME ドライブタイプがサポートされています。 ドライブは単体でも RAID に組み合わせても使用できます;
  • データには smartctl のバージョンと呼び出し引数、および追加フィールドが含まれます:
    disk_name - RAID 検出に必要な追加情報を含む名前を保持します。例: {"disk_name": "/dev/sda cciss,2"}
    disk_type - HDD、SSD、または NVME のディスクタイプを保持します。例: {"disk_type": "ssd"};
  • パラメーターが指定されていない場合、このアイテムはすべてのディスクに関する情報を返します。
systemd.unit.get[unit name,<interface>]


systemd ユニットのすべてのプロパティを返します。
戻り値: JSON object

パラメーター:

  • unit name - ユニット名(名前を取得するには、アイテムプロトタイプで {#UNIT.NAME} マクロを使用するとよいでしょう);
  • interface - ユニットのインターフェース種別。指定可能な値: Unit(デフォルト)、ServiceSocketDeviceMountAutomountSwapTargetPath

コメント:

  • このアイテムは Linux プラットフォームでのみサポートされます;
  • Unit インターフェースの LoadState、ActiveState、UnitFileState はテキストと整数で返されます: "ActiveState":{"state":1,"text":"active"}
systemd.unit.info[unit name,<property>,<interface>]


systemdユニットの情報。
戻り値: String

パラメーター:

  • unit name - ユニット名(名前の検出には、アイテムプロトタイプで {#UNIT.NAME} マクロを使用するとよいでしょう);
  • property - ユニットのプロパティ(例: ActiveState(デフォルト), LoadState, Description);
  • interface - ユニットのインターフェース種別(例: Unit(デフォルト), Socket, Service)。

コメント:

  • このアイテムは Linux プラットフォームでのみサポートされます;
  • このアイテムでは、dbus API に記載されているように、特定のインターフェース種別から特定のプロパティを取得できます。

例:

systemd.unit.info["{#UNIT.NAME}"] #検出された systemd ユニットのアクティブ状態(active, reloading, inactive, failed, activating, deactivating)情報を収集
systemd.unit.info["{#UNIT.NAME}",LoadState] #検出された systemd ユニットのロード状態情報を収集
systemd.unit.info[mysqld.service,Id] #サービスの技術名(mysqld.service)を取得
systemd.unit.info[mysqld.service,Description] #サービスの説明(MySQL Server)を取得
systemd.unit.info[mysqld.service,ActiveEnterTimestamp] #サービスが最後にアクティブ状態に入った時刻(1562565036283903)を取得
systemd.unit.info[dbus.socket,NConnections,Socket] #このソケットユニットから接続数を収集
systemd.unit.discovery[<type>]


systemdユニットとその詳細のリスト。 ローレベルディスカバリで使用されます。
戻り値: JSONオブジェクト

パラメータ:

  • type - 可能な値: all, automount, device, mount, path, service (デフォルト), socket, swap, target

このアイテムはLinuxプラットフォームでのみサポートされています。

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


証明書を検証し、証明書の詳細を返します。
戻り値: JSON object

パラメーター:

  • hostname - IP または DNS のいずれかを指定できます。
    URL スキーム(https のみ)、パス(無視されます)、およびポートを含めることができます。
    最初のパラメーターと 2 番目のパラメーターの両方でポートが指定されている場合、それらの値は一致している必要があります。
    address(3 番目のパラメーター)が指定されている場合、hostname は SNI と hostname 検証にのみ使用されます。
  • port - ポート番号(HTTPS のデフォルトは 443);
  • address - IP または DNS のいずれかを指定できます。 指定されている場合、接続にはこれが使用され、hostname(1 番目のパラメーター)は SNI と host 検証に使用されます。 1 番目のパラメーターが IP で 3 番目のパラメーターが DNS の場合、1 番目のパラメーターは接続に使用され、3 番目のパラメーターは SNI と host 検証に使用されます。

コメント:

  • このアイテムは、host 設定で指定された宛先が存在しない、利用できない、または TLS ハンドシェイクが無効な証明書以外のエラーで失敗した場合、サポート対象外になります。
  • 現在、AIA(Authority Information Access)X.509 拡張、CRL および OCSP(OCSP stapling を含む)、Certificate Transparency はサポートされていません。
  • JSON 応答フィールド:
    • x509: X.509 証明書の詳細を含みます。
      • version: X.509 のバージョン(例: 3)。
      • serial_number: 証明書のシリアル番号。
      • signature_algorithm: 証明書の署名に使用されたアルゴリズム(例: SHA256-RSA)。
      • issuer: 証明書の発行者。
      • not_before: 証明書の有効開始日。
      • not_after: 証明書の有効期限。
      • subject: 証明書のサブジェクト。
      • public_key_algorithm: 公開鍵に使用されたアルゴリズム(例: RSA)。
      • alternative_names: サブジェクト代替名(存在する場合)。存在しない場合は null
    • result: 検証結果を含みます。
      • value: 検証ステータス(以下の可能な値を参照)。
      • message: 詳細な検証メッセージ(例: "certificate verified successfully")。
    • sha1_fingerprint: 証明書の SHA-1 フィンガープリント。
    • sha256_fingerprint: 証明書の SHA-256 フィンガープリント。
  • $.result.value フィールドは証明書の検証結果を示します。 可能な値は次のとおりです。
    • valid - 証明書は有効で、信頼されています。
    • valid-but-self-signed - 証明書は有効ですが自己署名です。つまり、サブジェクトが発行者と一致します。
    • invalid - 有効期限切れ、ホスト名の不一致、または不明な署名機関などの問題により、証明書は無効です。

例:

web.certificate.get[example.com,443]

JSON 応答:

{
  "x509": {
    "version": 3,
    "serial_number": "0ad893bafa68b0b7fb7a404f06ecaf9a",
    "signature_algorithm": "ECDSA-SHA384",
    "issuer": "CN=DigiCert Global G3 TLS ECC SHA384 2020 CA1,O=DigiCert Inc,C=US",
    "not_before": {
      "value": "Jan 15 00:00:00 2025 GMT",
      "timestamp": 1736899200
    },
    "not_after": {
      "value": "Jan 15 23:59:59 2026 GMT",
      "timestamp": 1768521599
    },
    "subject": "CN=*.example.com,O=Internet Corporation for Assigned Names and Numbers,L=Los Angeles,ST=California,C=US",
    "public_key_algorithm": "ECDSA",
    "alternative_names": [
      "*.example.com",
      "example.com"
    ]
  },
  "result": {
    "value": "valid",
    "message": "certificate verified successfully"
  },
  "sha1_fingerprint": "310db7af4b2bc9040c8344701aca08d0c69381e3",
  "sha256_fingerprint": "455943cf819425761d1f950263ebf54755d8d684c25535943976f488bc79d23b"
}