1 Zabbixエージェント2
Zabbix agent 2は、UnixおよびWindowsのZabbix agentでサポートされているすべてのアイテムキーをサポートしています。 このページでは、Zabbix agent 2でのみ使用できる追加のアイテムキーについて、プラグインごとにグループ化して説明します。
アイテムキーはパラメータや追加情報なしで一覧表示されています。 アイテムキーをクリックすると、詳細が表示されます。
| アイテムキー | 説明 | プラグイン |
|---|---|---|
| ceph.df.details | クラスタのデータ使用量とプール間の分布。 | Ceph |
| 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+ |
| memcached.ping | 接続が生きているかどうかをテストします。 | Memcached |
| memcached.stats | STATSコマンドの出力を取得します。 | |
| mongodb.collection.stats | 指定したコレクションのさまざまなストレージ統計を返します。 | MongoDB |
| mongodb.cfg.discovery | 検出された構成サーバーのリストを返します。 | MongoDB |
| mongodb.collections.discovery | 検出されたコレクションのリストを返します。 | |
| mongodb.collections.usage | コレクションの使用統計を返します。 | |
| mongodb.connpool.stats | 現在のデータベースインスタンスからシャードクラスタまたはレプリカセットの他のメンバーへのオープンアウトゴーイング接続に関する情報を返します。 | |
| mongodb.db.stats | 指定したデータベースシステムの状態を反映した統計を返します。 | |
| mongodb.db.discovery | 検出されたデータベースのリストを返します。 | |
| mongodb.jumbo_chunks.count | ジャンボチャンクの数を返します。 | |
| 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 |
| 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 |
| 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 | 自動ストレージ管理(ASM)ディスクグループの統計を返します。 | Oracle |
| oracle.diskgroups.discovery | ASMディスクグループのリストを返します。 | |
| oracle.archive.info | アーカイブログの統計。 | |
| oracle.cdb.info | コンテナデータベース(CDB)の情報。 | |
| oracle.custom.query | カスタムクエリの結果。 | |
| oracle.datafiles.stats | データファイルの統計を返します。 | |
| oracle.db.discovery | データベースのリストを返します。 | |
| oracle.fra.stats | 高速リカバリア(FRA)の統計を返します。 | |
| oracle.instance.info | インスタンスの統計。 | |
| oracle.pdb.info | プラガブルデータベース(PDB)の情報。 | |
| oracle.pdb.discovery | PDBのリストを返します。 | |
| oracle.pga.stats | プログラムグローバルエリア(PGA)の統計を返します。 | |
| oracle.ping | Oracleへの接続が確立できるかどうかをテストします。 | |
| oracle.proc.stats | プロセスの統計を返します。 | |
| oracle.redolog.info | 制御ファイルからのログファイル情報。 | |
| oracle.sga.stats | システムグローバルエリア(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 |
| pgsql.archive | アーカイブされたファイルに関する情報。 | |
| pgsql.bgwriter | データベースクラスタのチェックポイントの合計数(チェックポイントタイプ別)。 | |
| pgsql.cache.hit | PostgreSQLバッファキャッシュヒット率。 | |
| pgsql.connections | タイプ別の接続数を返します。 | |
| pgsql.custom.query | カスタムクエリの結果を返します。 | |
| pgsql.db.age | データベースの最も古いFrozenXIDの経過時間。 | |
| pgsql.db.bloating_tables | データベースごとの膨張テーブル数。 | |
| 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 | 各送信プロセスごとのフラッシュラグ、書き込みラグ、リプレイラグ。 | |
| 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の起動以降のスローログエントリ数。 | |
| 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 - 返される統計情報のタイプ: items、sizes、slabs、settings(デフォルトは空、一般的な統計情報を返します)。
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 - クエリパラメータなしの
protocol://host:port形式のMQTTブローカーURL(サポートされているプロトコル:tcp,ssl,ws)。 値が指定されていない場合、エージェントはtcp://localhost:1883を使用します。 プロトコルまたはポートが省略された場合、デフォルトのプロトコル(tcp)またはポート(1883)が使用されます。 - topic - MQTTトピック(必須)。
ワイルドカード(+、#)がサポートされています。
- user, password - 認証情報(必要な場合)。
コメント:
- アイテムはアクティブチェック(「Zabbixエージェント(アクティブ)」アイテムタイプ)として設定する必要があります。
- 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オブジェクト
パラメータ:
- 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ルックアップ(
typeがPTRの場合)では、DNS名を逆順および非逆順の両方の形式で指定できます(下記の例を参照)。 PTRレコードが要求される場合、DNS名は実際にはIPアドレスであることに注意してください。 flagsの可能な値は、cdflagまたはnocdflag(デフォルト)、rdflag(デフォルト)またはnordflag、dnssecまたはnodnssec(デフォルト)、nsidまたはnonsid(デフォルト)、edns0(デフォルト)またはnoedns0、aaflagまたはnoaaflag(デフォルト)、adflagまたはnoadflag(デフォルト)です。flagsのdnssecおよびnsidはnoedns0と同時に使用できません。両方ともedns0を必要とします。 値は小文字のみでなければならないことに注意してください。大文字や混在した値はサポートされていません。- 国際化ドメイン名はサポートされていません。代わりにIDNAエンコードされた名前を使用してください。
- 出力は、指定されたパラメータに基づくDNSレコード情報を含むオブジェクトです(詳細はこちらを参照)。
例:
net.dns.get[192.0.2.0,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>]
ASM(Automatic Storage Management)ディスクグループの統計情報を返します。
戻り値:JSONオブジェクト。
パラメータ:
- connString - 以下のいずれかになります。
- URI - 指定された名前のセッションが見つからず、
Plugins.Oracle.ResolveTNSがfalseに設定されている場合。 スキーマ(例:"tcp://")、ポート(例:1521)、またはその両方が含まれている場合、ResolveTNSオプションは考慮されず、URIとして扱われます。 - セッション名 - プラグイン設定ファイルでそのような名前が見つかった場合。
- TNSキー - ResolveTNSオプションがtrueに設定され、上記の条件がいずれも該当しない場合。
- TNS値 - 開き括弧“(“で始まる場合(先頭のスペースは無視されます)。
この場合、ResolveTNSオプションは考慮されません。
- URI - 指定された名前のセッションが見つからず、
- user - Oracleユーザー名。ログインオプション
as sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm、as sysracのいずれかをuser as sysdbaの形式で追加できます(ログインオプションは大文字・小文字を区別せず、末尾にスペースを含めてはいけません)。 - password - Oracleパスワード。
- service - Oracleサービス名。
- diskgroup - 問い合わせるASMディスクグループの名前。
oracle.diskgroups.discovery[connString,<user>,<password>,<service>]
ASMディスクグループのリストを返します。
ローレベルディスカバリで使用されます。
戻り値: JSONオブジェクト。
パラメータ:
- connString - 以下のいずれか:
- URI - 指定された名前のセッションが見つからず、
Plugins.Oracle.ResolveTNSがfalseに設定されている場合。 スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方が含まれている場合、ResolveTNSオプションは考慮されず、URIとして扱われます; - セッション名 - プラグイン設定ファイルでその名前が見つかった場合;
- TNSキー - ResolveTNSオプションがtrueに設定されており、上記の条件がいずれも該当しない場合;
- TNS値 - 開き括弧“(“で始まる場合(先頭のスペースは無視されます)。
この場合、ResolveTNSオプションは考慮されません。
- URI - 指定された名前のセッションが見つからず、
- user - Oracleユーザー名。ログインオプション
as sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm、as sysracのいずれかをuser as sysdbaの形式で追加することができます(ログインオプションは大文字小文字を区別せず、末尾にスペースを含めてはいけません)。 - password - Oracleパスワード;
- service - Oracleサービス名。
oracle.archive.info[connString,<user>,<password>,<service>,<destination>]
アーカイブログの統計情報。
戻り値:JSONオブジェクト。
パラメータ:
- connString - 以下のいずれかを指定できます。
- URI - 指定された名前のセッションが見つからず、
Plugins.Oracle.ResolveTNSがfalseに設定されている場合。 スキーマ(例:"tcp://")、ポート(例:1521)、またはその両方が含まれている場合、ResolveTNSオプションは考慮されず、URIとして扱われます。 - セッション名 - プラグイン設定ファイルでその名前が見つかった場合;
- TNSキー - ResolveTNSオプションがtrueに設定されており、上記の条件がいずれも該当しない場合;
- TNS値 - 先頭が開き括弧“(“で始まる場合(先頭のスペースは無視されます)。
この場合、ResolveTNSオプションは考慮されません。
- URI - 指定された名前のセッションが見つからず、
- user - Oracleのユーザー名。ログインオプション
as sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm、as sysracのいずれかをuser as sysdbaの形式で追加できます(ログインオプションは大文字小文字を区別せず、末尾にスペースを含めてはいけません)。 - password - Oracleのパスワード;
- service - Oracleのサービス名;
- destination - 問い合わせる宛先の名前。
oracle.cdb.info[connString,<user>,<password>,<service>,<database>]
コンテナデータベース(CDB)の情報。
戻り値:JSONオブジェクト。
パラメータ:
- connString - 以下のいずれかを指定可能:
- URI - 指定された名前のセッションが見つからず、
Plugins.Oracle.ResolveTNSがfalseに設定されている場合。 スキーマ(例:"tcp://")、ポート(例:1521)、またはその両方が含まれている場合、ResolveTNSオプションは考慮されず、URIとして扱われます。 - セッション名 - プラグイン設定ファイルでその名前が見つかった場合。
- TNSキー - ResolveTNSオプションがtrueに設定され、上記の条件がいずれも該当しない場合。
- TNS値 - 先頭が開き括弧“(“で始まる場合(先頭のスペースは無視されます)。
この場合、ResolveTNSオプションは考慮されません。
- URI - 指定された名前のセッションが見つからず、
- user - Oracleユーザー名。ログインオプション
as sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm、as sysracのいずれかをuser as sysdbaの形式で追加可能(ログインオプションは大文字小文字を区別せず、末尾にスペースを含めてはいけません)。 - password - Oracleパスワード。
- service - Oracleサービス名。
- database - クエリを実行するデータベース名。
oracle.custom.query[connString,<user>,<password>,<service>,queryName,<args...>]
カスタムクエリの結果。
戻り値: JSONオブジェクト。
パラメータ:
- connString - 以下のいずれか:
- URI - 指定された名前のセッションが見つからず、
Plugins.Oracle.ResolveTNSがfalseに設定されている場合。 スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方が含まれている場合、ResolveTNSオプションは考慮されず、URIとして扱われます; - セッション名 - プラグイン設定ファイルでその名前が見つかった場合;
- TNSキー - ResolveTNSオプションがtrueに設定されていて、上記の条件がいずれも該当しない場合;
- TNS値 - 先頭が開き括弧“(“で始まる場合(先頭のスペースは無視)。
この場合、ResolveTNSオプションは考慮されません。
- URI - 指定された名前のセッションが見つからず、
- user - Oracleユーザー名。ログインオプション
as sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm、as sysracのいずれかをuser as sysdbaの形式で追加可能(ログインオプションは大文字小文字を区別せず、末尾にスペースを含めてはいけません)。 - password - Oracleパスワード;
- service - Oracleサービス名;
- queryName - カスタムクエリの名前。SQLファイル名(拡張子なし)と一致する必要があります;
- args - クエリに渡す1つまたは複数のカンマ区切りの引数。
コメント:
- 返されるデータは自動的にJSONに変換されます。
- クエリから直接JSONを返すことは避けてください。プラグインが再度JSONに変換しようとすると破損します。
oracle.datafiles.stats[connString,<user>,<password>,<service>]
データファイルの統計情報を返します。
戻り値: JSONオブジェクト。
パラメータ:
- connString - 以下のいずれか:
- URI - 指定された名前のセッションが見つからず、
Plugins.Oracle.ResolveTNSがfalseに設定されている場合。 スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方が含まれている場合、ResolveTNSオプションは考慮されず、URIとして扱われます; - セッション名 - プラグイン設定ファイルでそのような名前が見つかった場合;
- TNSキー - ResolveTNSオプションがtrueに設定され、上記の条件がいずれも該当しない場合;
- TNS値 - 先頭が開き括弧“(“で始まる場合(先頭のスペースは無視されます)。
この場合、ResolveTNSオプションは考慮されません。
- URI - 指定された名前のセッションが見つからず、
- user - Oracleのユーザー名。ログインオプション
as sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm、as sysracのいずれかをuser as sysdbaの形式で追加することができます(ログインオプションは大文字小文字を区別せず、末尾にスペースを含めてはいけません)。 - password - Oracleのパスワード;
- service - Oracleのサービス名。
oracle.db.discovery[connString,<user>,<password>,<service>]
データベースのリストを返します。
ローレベルディスカバリで使用されます。
戻り値: JSONオブジェクト。
パラメータ:
- connString - 以下のいずれかを指定できます:
- URI - 指定された名前のセッションが見つからず、
Plugins.Oracle.ResolveTNSがfalseに設定されている場合。 スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方が含まれている場合、ResolveTNSオプションは考慮されず、URIとして扱われます; - セッション名 - プラグイン設定ファイルでそのような名前が見つかった場合;
- TNSキー - ResolveTNSオプションがtrueに設定され、上記のいずれの条件にも該当しない場合;
- TNS値 - 開き括弧“(“で始まる場合(先頭のスペースは無視されます)。
この場合、ResolveTNSオプションは考慮されません。
- URI - 指定された名前のセッションが見つからず、
- user - Oracleのユーザー名。ログインオプション
as sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm、as sysracのいずれかをuser as sysdbaの形式で追加することができます(ログインオプションは大文字小文字を区別せず、末尾にスペースを含めてはいけません)。 - password - Oracleのパスワード;
- service - Oracleのサービス名。
oracle.fra.stats[connString,<user>,<password>,<service>]
Fast Recovery Area (FRA) の統計情報を返します。
戻り値:JSON オブジェクト。
パラメータ:
- connString - 以下のいずれかになります。
- URI - 指定された名前のセッションが見つからず、
Plugins.Oracle.ResolveTNSが false に設定されている場合。 スキーマ(例:"tcp://")、ポート(例:1521)、またはその両方が含まれている場合、ResolveTNS オプションは考慮されず、URI として扱われます。 - セッション名 - プラグイン設定ファイルでそのような名前が見つかった場合。
- TNS キー - ResolveTNS オプションが true に設定されていて、上記のいずれにも該当しない場合。
- TNS 値 - 開き括弧 “(“ で始まる場合(先頭のスペースは無視されます)。
この場合、ResolveTNS オプションは考慮されません。
- URI - 指定された名前のセッションが見つからず、
- user - Oracle ユーザー名。ログインオプション
as sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm、as sysracのいずれかをuser as sysdbaの形式で追加できます(ログインオプションは大文字・小文字を区別せず、末尾にスペースを含めてはいけません)。 - password - Oracle パスワード。
- service - Oracle サービス名。
oracle.instance.info[connString,<user>,<password>,<service>]
インスタンスの統計情報。
戻り値:JSONオブジェクト。
パラメータ:
- connString - 以下のいずれかを指定できます。
- URI - 指定された名前のセッションが見つからず、
Plugins.Oracle.ResolveTNSがfalseに設定されている場合。 スキーマ(例:"tcp://")、ポート(例:1521)、またはその両方が含まれている場合、ResolveTNSオプションは考慮されず、URIとして扱われます。 - セッション名 - プラグイン設定ファイルでそのような名前が見つかった場合;
- TNSキー - ResolveTNSオプションがtrueに設定されており、上記の条件がいずれも該当しない場合;
- TNS値 - 先頭が開き括弧“(“で始まる場合(先頭のスペースは無視されます)。
この場合、ResolveTNSオプションは考慮されません。
- URI - 指定された名前のセッションが見つからず、
- user - Oracleユーザー名。ログインオプション
as sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm、as sysracのいずれかをuser as sysdbaの形式で追加することができます(ログインオプションは大文字小文字を区別せず、末尾にスペースを含めてはいけません)。 - password - Oracleパスワード;
- service - Oracleサービス名。
oracle.pdb.info[connString,<user>,<password>,<service>,<database>]
Pluggable Databases (PDBs)の情報。
戻り値: JSONオブジェクト。
パラメータ:
- connString - 以下のいずれか:
- URI - 指定された名前のセッションが見つからず、
Plugins.Oracle.ResolveTNSがfalseに設定されている場合。 スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方が含まれている場合、ResolveTNSオプションは考慮されず、URIとして扱われます; - セッション名 - プラグイン設定ファイルでそのような名前が見つかった場合;
- TNSキー - ResolveTNSオプションがtrueに設定されており、上記の条件がいずれも該当しない場合;
- TNS値 - 先頭が開き括弧“(“で始まる場合(先頭のスペースは無視)。
この場合、ResolveTNSオプションは考慮されません。
- URI - 指定された名前のセッションが見つからず、
- user - Oracleのユーザー名。ログインオプション
as sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm、as sysracのいずれかをuser as sysdbaの形式で追加することができます(ログインオプションは大文字小文字を区別せず、末尾にスペースを含めてはいけません)。 - password - Oracleのパスワード;
- service - Oracleのサービス名;
- database - クエリを実行するデータベース名。
oracle.pdb.discovery[connString,<user>,<password>,<service>]
PDBのリストを返します。
ローレベルディスカバリで使用されます。
戻り値:JSONオブジェクト。
パラメータ:
- connString - 以下のいずれかになります。
- URI - 指定された名前のセッションが見つからず、
Plugins.Oracle.ResolveTNSがfalseに設定されている場合。 スキーマ(例:"tcp://")、ポート(例:1521)、またはその両方が含まれている場合、ResolveTNSオプションは考慮されず、URIとして扱われます。 - セッション名 - プラグイン設定ファイルにそのような名前が見つかった場合;
- TNSキー - ResolveTNSオプションがtrueに設定されていて、上記の条件がいずれも該当しない場合;
- TNS値 - 先頭が開き括弧“(“で始まる場合(先頭のスペースは無視されます)。
この場合、ResolveTNSオプションは考慮されません。
- URI - 指定された名前のセッションが見つからず、
- user - Oracleのユーザー名。ログインオプション
as sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm、as sysracのいずれかをuser as sysdbaの形式で追加できます(ログインオプションは大文字小文字を区別せず、末尾にスペースを含めてはいけません)。 - password - Oracleのパスワード;
- service - Oracleのサービス名。
oracle.pga.stats[connString,<user>,<password>,<service>]
プログラム・グローバル・エリア(PGA)の統計情報を返します。
戻り値:JSONオブジェクト。
パラメータ:
- connString - 以下のいずれかになります。
- URI - 指定された名前のセッションが見つからず、
Plugins.Oracle.ResolveTNSがfalseに設定されている場合。 スキーマ(例:"tcp://")、ポート(例:1521)、またはその両方が含まれている場合、ResolveTNSオプションは考慮されず、URIとして扱われます。 - セッション名 - プラグイン設定ファイルでその名前が見つかった場合。
- TNSキー - ResolveTNSオプションがtrueに設定されていて、上記の条件がいずれも該当しない場合。
- TNS値 - 開き括弧“(“で始まる場合(先頭のスペースは無視されます)。
この場合、ResolveTNSオプションは考慮されません。
- URI - 指定された名前のセッションが見つからず、
- user - Oracleユーザー名。ログインオプション
as sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm、as sysracのいずれかをuser as sysdbaの形式で追加することができます(ログインオプションは大文字・小文字を区別せず、末尾にスペースを含めてはいけません)。 - password - Oracleパスワード。
- service - Oracleサービス名。
oracle.ping[connString,<user>,<password>,<service>]
Oracleへの接続が確立できるかどうかをテストします。
戻り値: 1 - 接続に成功した場合; 0 - 接続が失敗した場合(認証や設定の問題を含む、何らかのエラーが発生した場合)。
パラメータ:
- connString - 以下のいずれかを指定できます:
- URI - 指定された名前のセッションが見つからず、
Plugins.Oracle.ResolveTNSがfalseに設定されている場合。 スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方が含まれている場合、ResolveTNSオプションは考慮されず、URIとして扱われます; - セッション名 - プラグイン設定ファイルでその名前が見つかった場合;
- TNSキー - ResolveTNSオプションがtrueに設定され、上記の条件がいずれも該当しない場合;
- TNS値 - 先頭が開き括弧“(“(先頭のスペースは無視)で始まる場合。
この場合、ResolveTNSオプションは考慮されません。
- URI - 指定された名前のセッションが見つからず、
- user - Oracleのユーザー名。ログインオプション
as sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as 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オブジェクト。
パラメータ:
- connString - 以下のいずれか:
- URI - 指定された名前のセッションが見つからず、
Plugins.Oracle.ResolveTNSがfalseに設定されている場合。 スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方が含まれている場合、ResolveTNSオプションは考慮されず、URIとして扱われます; - セッション名 - プラグイン設定ファイルでそのような名前が見つかった場合;
- TNSキー - ResolveTNSオプションがtrueに設定されており、上記のいずれの条件にも該当しない場合;
- TNS値 - 先頭が開き括弧“(“で始まる場合(先頭のスペースは無視されます)。
この場合、ResolveTNSオプションは考慮されません。
- URI - 指定された名前のセッションが見つからず、
- user - Oracleユーザー名。ログインオプション
as sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm、as sysracのいずれかをuser as sysdbaの形式で追加できます(ログインオプションは大文字小文字を区別せず、末尾にスペースを含めてはいけません)。 - password - Oracleパスワード;
- service - Oracleサービス名。
oracle.redolog.info[connString,<user>,<password>,<service>]
制御ファイルからのログファイル情報。
戻り値: JSONオブジェクト。
パラメータ:
- connString - 以下のいずれか:
- URI - 指定された名前のセッションが見つからず、
Plugins.Oracle.ResolveTNSがfalseに設定されている場合。 スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方が含まれている場合、ResolveTNSオプションは考慮されず、URIとして扱われます; - セッション名 - プラグイン設定ファイルでそのような名前が見つかった場合;
- TNSキー - ResolveTNSオプションがtrueに設定され、上記の条件がいずれも該当しない場合;
- TNS値 - 先頭に開き括弧“(“(先頭のスペースは無視)がある場合。
この場合、ResolveTNSオプションは考慮されません。
- URI - 指定された名前のセッションが見つからず、
- user - Oracleユーザー名。ログインオプション
as sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm、as sysracのいずれかをuser as sysdbaの形式で追加することができます(ログインオプションは大文字小文字を区別せず、末尾にスペースを含めてはいけません)。 - password - Oracleパスワード;
- service - Oracleサービス名。
oracle.sga.stats[connString,<user>,<password>,<service>]
システムグローバル領域(SGA)の統計情報を返します。
戻り値:JSONオブジェクト
パラメータ:
- connString - 以下のいずれかになります。
- URI - 指定された名前のセッションが見つからず、
Plugins.Oracle.ResolveTNSがfalseに設定されている場合。スキーマ(例:"tcp://")、ポート(例:1521)、またはその両方が含まれている場合、ResolveTNSオプションは考慮されず、URIとして扱われます。 - セッション名 - プラグイン設定ファイルでそのような名前が見つかった場合。
- TNSキー - ResolveTNSオプションがtrueに設定されており、上記の条件がいずれも該当しない場合。
- TNS値 - 開き括弧“(“で始まる場合(先頭のスペースは無視されます)。この場合、ResolveTNSオプションは考慮されません。
- URI - 指定された名前のセッションが見つからず、
- user - Oracleのユーザー名。ログインオプション
as sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm、as sysracのいずれかをuser as sysdbaの形式で追加することができます(ログインオプションは大文字・小文字を区別せず、末尾にスペースを含めてはいけません)。 - password - Oracleのパスワード。
- service - Oracleのサービス名。
oracle.sessions.stats[connString,<user>,<password>,<service>,<lockMaxTime>]
セッション統計を返します。
戻り値:JSONオブジェクト。
パラメータ:
- connString - 以下のいずれかになります。
- URI - 指定された名前のセッションが見つからず、
Plugins.Oracle.ResolveTNSがfalseに設定されている場合。 スキーマ(例:"tcp://")、ポート(例:1521)、またはその両方が含まれている場合、ResolveTNSオプションは考慮されず、URIとして扱われます。 - セッション名 - プラグイン設定ファイルでそのような名前が見つかった場合。
- TNSキー - ResolveTNSオプションがtrueに設定され、上記の条件がいずれも該当しない場合。
- TNS値 - 開き括弧“(“で始まる場合(先頭のスペースは無視されます)。
この場合、ResolveTNSオプションは考慮されません。
- URI - 指定された名前のセッションが見つからず、
- user - Oracleのユーザー名。ログインオプション
as sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm、as sysracのいずれかをuser as sysdbaの形式で追加することができます(ログインオプションは大文字・小文字を区別せず、末尾にスペースを含めてはいけません)。 - password - Oracleのパスワード。
- service - Oracleのサービス名。
- lockMaxTime - セッションを長時間ロックされたと見なす最大ロック時間(秒)。 デフォルト:600秒。
oracle.sys.metrics[connString,<user>,<password>,<service>,<duration>]
システムメトリック値のセットを返します。
戻り値: JSONオブジェクト。
パラメータ:
- connString - 以下のいずれかになります:
- URI - 指定された名前のセッションが見つからず、
Plugins.Oracle.ResolveTNSがfalseに設定されている場合。 スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方が含まれている場合、ResolveTNSオプションは考慮されず、URIとして扱われます; - セッション名 - プラグイン設定ファイルでそのような名前が見つかった場合;
- TNSキー - ResolveTNSオプションがtrueに設定され、上記の条件がいずれも該当しない場合;
- TNS値 - 開き括弧“(“で始まる場合(先頭のスペースは無視)。
この場合、ResolveTNSオプションは考慮されません。
- URI - 指定された名前のセッションが見つからず、
- user - Oracleユーザー名。ログインオプション
as sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm、as sysracのいずれかをuser as sysdbaの形式で追加できます(ログインオプションは大文字小文字を区別せず、末尾にスペースを含めてはいけません)。 - password - Oracleパスワード;
- service - Oracleサービス名;
- duration - システムメトリック値の取得間隔(秒)。 可能な値: 60 — 長い間隔(デフォルト)、15 — 短い間隔。
oracle.sys.params[connString,<user>,<password>,<service>]
システムパラメータ値のセットを返します。
戻り値: JSONオブジェクト。
パラメータ:
- connString - 以下のいずれか:
- URI - 指定された名前のセッションが見つからず、
Plugins.Oracle.ResolveTNSがfalseに設定されている場合。 スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方が含まれている場合、ResolveTNSオプションは考慮されず、URIとして扱われます; - セッション名 - プラグイン設定ファイルでそのような名前が見つかった場合;
- TNSキー - ResolveTNSオプションがtrueに設定され、上記の条件がいずれも該当しない場合;
- TNS値 - 開き括弧“(“で始まる場合(先頭のスペースは無視されます)。
この場合、ResolveTNSオプションは考慮されません。
- URI - 指定された名前のセッションが見つからず、
- user - Oracleユーザー名。ログインオプション
as sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm、as sysracのいずれかをuser as sysdbaの形式で追加できます(ログインオプションは大文字小文字を区別せず、末尾にスペースを含めてはいけません)。 - password - Oracleパスワード;
- service - Oracleサービス名。
oracle.ts.stats[connString,<user>,<password>,<service>,<tablespace>,<type>,<conname>]
表領域の統計情報を返します。
戻り値: JSONオブジェクト。
パラメータ:
- connString - 以下のいずれかになります:
- URI - 指定された名前のセッションが見つからず、
Plugins.Oracle.ResolveTNSがfalseに設定されている場合。 スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方が含まれている場合、ResolveTNSオプションは考慮されず、URIとして扱われます; - セッション名 - プラグイン設定ファイルでそのような名前が見つかった場合;
- TNSキー - ResolveTNSオプションがtrueに設定され、上記の条件がいずれも該当しない場合;
- TNS値 - 開き括弧“(“で始まる場合(先頭のスペースは無視されます)。
この場合、ResolveTNSオプションは考慮されません。
- URI - 指定された名前のセッションが見つからず、
- user - Oracleのユーザー名。ログインオプション
as sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm、as sysracのいずれかをuser as sysdbaの形式で追加できます(ログインオプションは大文字小文字を区別せず、末尾にスペースを含めてはいけません)。 - password - Oracleのパスワード;
- service - Oracleのサービス名;
- tablespace - 問い合わせる表領域の名前。
デフォルト(空欄で
typeが設定されている場合):- "TEMP"(
typeが"TEMPORARY"の場合); - "USERS"(
typeが"PERMANENT"の場合)。
- "TEMP"(
- type - 問い合わせる表領域のタイプ。
デフォルト(
tablespaceが設定されている場合): "PERMANENT"。 - conname - 情報が必要なコンテナの名前。
tablespace、type、connameのいずれかが省略された場合、アイテムは一致するすべてのコンテナ(PDBおよびCDBを含む)の表領域統計情報を返します。
oracle.ts.discovery[connString,<user>,<password>,<service>]
表領域のリストを返します。
ローレベルディスカバリで使用されます。
戻り値: JSONオブジェクト。
パラメータ:
- connString - 以下のいずれかを指定できます:
- URI - 指定された名前のセッションが見つからず、
Plugins.Oracle.ResolveTNSがfalseに設定されている場合。 スキーマ(例: "tcp://")、ポート(例: 1521)、またはその両方が含まれている場合、ResolveTNSオプションは考慮されず、URIとして扱われます; - セッション名 - プラグイン設定ファイルでその名前が見つかった場合;
- TNSキー - ResolveTNSオプションがtrueに設定され、上記の条件がいずれも該当しない場合;
- TNS値 - 開き括弧“(“で始まる場合(先頭のスペースは無視)。
この場合、ResolveTNSオプションは考慮されません。
- URI - 指定された名前のセッションが見つからず、
- user - Oracleユーザー名。ログインオプション
as sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm、as sysracのいずれかをuser as sysdbaの形式で追加できます(ログインオプションは大文字小文字を区別せず、末尾にスペースを含めてはいけません)。 - password - Oracleのパスワード;
- service - Oracleサービス名。
oracle.user.info[connString,<user>,<password>,<service>,<username>]
Oracleユーザー情報を返します。
戻り値:JSONオブジェクト。
パラメータ:
- connString - 以下のいずれかを指定できます:
- URI - 指定された名前のセッションが見つからず、
Plugins.Oracle.ResolveTNSがfalseに設定されている場合。 スキーマ(例:"tcp://")、ポート(例:1521)、またはその両方が含まれている場合、ResolveTNSオプションは考慮されず、URIとして扱われます; - セッション名 - プラグイン設定ファイルでそのような名前が見つかった場合;
- TNSキー - ResolveTNSオプションがtrueに設定されており、上記の条件がいずれも該当しない場合;
- TNS値 - 先頭が開き括弧“(“で始まる場合(先頭のスペースは無視されます)。
この場合、ResolveTNSオプションは考慮されません。
- URI - 指定された名前のセッションが見つからず、
- user - Oracleユーザー名。ログインオプション
as sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm、as sysracのいずれかをuser as sysdbaの形式で追加することができます(ログインオプションは大文字小文字を区別せず、末尾にスペースを含めてはいけません)。 - 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ユーザー名。ログインオプションas sysdba、as sysoper、as sysasm、as sysbackup、as sysdg、as syskm、as sysracのいずれかをuser as sysdbaの形式で追加することができます(ログインオプションは大文字小文字を区別せず、末尾にスペースを含めてはいけません)。
- URI - 指定された名前のセッションが見つからず、
- password - Oracleパスワード;
- service - Oracleサービス名。
pgsql.autovacuum.count[uri,<username>,<password>,<database name>]
autovacuumワーカーの数。
戻り値:整数。
パラメータ:
- uri - URIまたはセッション名;
- username, password - PostgreSQLの認証情報;
- database name - データベース名(省略した場合は、postgresql.confのPlugins.PostgreSQL.Default.Databaseの値が使用されます)。
pgsql.archive[uri,<username>,<password>,<database name>]
アーカイブされたファイルに関する情報。
戻り値: JSONオブジェクト。
パラメータ:
- uri - URIまたはセッション名;
- username, password - PostgreSQLの認証情報;
- database name - データベース名(省略した場合は、postgresql.confのPlugins.PostgreSQL.Default.Databaseの値が使用されます)。
pgsql.bgwriter[uri,<username>,<password>,<database name>]
チェックポイントのタイプごとに分類された、データベースクラスタのチェックポイントの合計数。
戻り値: JSONオブジェクト。
パラメータ:
- uri - URIまたはセッション名;
- username, password - PostgreSQLの認証情報;
- database name - データベース名(省略した場合は、postgresql.confのPlugins.PostgreSQL.Default.Databaseの値が使用されます)。
pgsql.cache.hit[uri,<username>,<password>,<database name>]
PostgreSQLバッファキャッシュヒット率。
戻り値: Float。
パラメータ:
- uri - URIまたはセッション名;
- username, password - PostgreSQLの認証情報;
- database name - データベース名(省略した場合は、postgresql.confのPlugins.PostgreSQL.Default.Databaseの値が使用されます)。
pgsql.connections[uri,<username>,<password>,<database name>]
タイプ別の接続数を返します。
戻り値:JSONオブジェクト。
パラメータ:
- uri - URIまたはセッション名;
- username, password - PostgreSQLの認証情報;
- database name - データベース名(省略した場合は、postgresql.confのPlugins.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の経過時間。
戻り値: 整数。
パラメータ:
- uri - URIまたはセッション名;
- username, password - PostgreSQLの認証情報;
- database name - データベース名(省略した場合はpostgresql.confのPlugins.PostgreSQL.Default.Databaseの値が使用されます)。
pgsql.db.bloating_tables[uri,<username>,<password>,<database name>]
データベースごとの膨張テーブル数。
戻り値: 整数。
パラメータ:
- uri - URIまたはセッション名;
- username, password - PostgreSQLの認証情報;
- database name - データベース名(省略した場合は、postgresql.confのPlugins.PostgreSQL.Default.Databaseの値が使用されます)。
pgsql.db.discovery[uri,<username>,<password>,<database name>]
PostgreSQLデータベースのリスト。
ローレベルディスカバリで使用されます。
戻り値: JSONオブジェクト。
パラメータ:
- uri - URIまたはセッション名;
- username, password - PostgreSQLの認証情報;
- database name - データベース名(省略した場合は、postgresql.confのPlugins.PostgreSQL.Default.Databaseの値が使用されます)。
pgsql.db.size[uri,<username>,<password>,<database name>]
データベースのサイズ(バイト単位)。
戻り値: 整数。
パラメータ:
- uri - URIまたはセッション名;
- username, password - PostgreSQLの認証情報;
- database name - データベース名(省略した場合は、postgresql.confのPlugins.PostgreSQL.Default.Databaseの値が使用されます)。
pgsql.dbstat[uri,<username>,<password>,<database name>]
データベースごとの統計情報を収集します。
ローレベルディスカバリで使用されます。
戻り値: JSONオブジェクト
パラメータ:
- uri - URIまたはセッション名;
- username, password - PostgreSQLの認証情報;
- database name - データベース名 (省略した場合は、postgresql.confのPlugins.PostgreSQL.Default.Databaseの値が使用されます)。
pgsql.dbstat.sum[uri,<username>,<password>,<database name>]
クラスタ内のすべてのデータベースの集計データ。
戻り値: JSONオブジェクト。
パラメータ:
- uri - URIまたはセッション名;
- username, password - PostgreSQLの認証情報;
- database name - データベース名 (省略した場合は、postgresql.confのPlugins.PostgreSQL.Default.Databaseの値が使用されます)。
pgsql.locks[uri,<username>,<password>,<database name>]
データベースごとに付与されたロックに関する情報です。
ローレベルディスカバリで使用されます。
戻り値:JSONオブジェクト
パラメータ:
- uri - URIまたはセッション名;
- username, password - PostgreSQLの認証情報;
- database name - データベース名(省略した場合はpostgresql.confのPlugins.PostgreSQL.Default.Databaseの値が使用されます)。
pgsql.oldest.xid[uri,<username>,<password>,<database name>]
最も古いXIDのエイジ。
戻り値: 整数。
パラメータ:
- uri - URIまたはセッション名;
- username, password - PostgreSQLの認証情報;
- database name - データベース名(省略した場合はpostgresql.confのPlugins.PostgreSQL.Default.Databaseの値が使用されます)。
pgsql.ping[uri,<username>,<password>,<database name>]
接続が生きているかどうかをテストします。
戻り値: 1 - 接続が生きている; 0 - 接続が切断されている (AUTHや設定の問題を含むエラーが発生した場合)。
パラメータ:
- uri - URIまたはセッション名;
- username, password - PostgreSQLの認証情報;
- database name - データベース名 (省略した場合はpostgresql.confのPlugins.PostgreSQL.Default.Databaseの値が使用されます)。
pgsql.queries[uri,<username>,<password>,<database name>,time period]
実行時間によるクエリのメトリクス。
戻り値: JSONオブジェクト。
パラメータ:
- uri - URIまたはセッション名;
- username, password - PostgreSQLの認証情報;
- database name - データベース名(省略した場合はpostgresql.confのPlugins.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.confのPlugins.PostgreSQL.Default.Databaseの値が使用されます)。
pgsql.version[uri,<username>,<password>,<database name>]
PostgreSQLのバージョンを返します。
戻り値: String。
パラメータ:
- uri - URIまたはセッション名;
- username, password - PostgreSQLの認証情報;
- database name - データベース名(省略した場合は、postgresql.confのPlugins.PostgreSQL.Default.Databaseの値が使用されます)。
pgsql.wal.stat[uri,<username>,<password>,<database name>]
WAL統計情報。
戻り値:JSONオブジェクト。
パラメータ:
- uri - URIまたはセッション名;
- username, password - PostgreSQLの認証情報;
- database name - データベース名(省略した場合はpostgresql.confのPlugins.PostgreSQL.Default.Databaseの値が使用されます)。
redis.config[connString,<password>,<pattern>]
パターンに一致するRedisインスタンスの設定パラメータを取得します。
戻り値: JSON - グロブスタイルのパターンが使用された場合; パターンにワイルドカード文字が含まれていない場合は単一の値。
パラメータ:
- connString - URIまたはセッション名;
- password - Redisのパスワード;
- pattern - グロブスタイルのパターン(デフォルトは\)。
コメント:
- セキュリティ警告:
redis.configはRedisのCONFIG GETコマンドを実行し、機密性の高い設定パラメータ(例えばrequirepass、masterauth、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オブジェクト。
コメント:
- 次のマクロとその値が返されます: {#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オブジェクト。
パラメータ:
- type - ディスクをスキャンする値を指定します。 指定可能な値: id, name (デフォルト)。 idはWindowsではサポートされておらず、選択した場合はエラーを返します
コメント:
- 以下のマクロとその値が返されます: {#NAME}, {#DISKTYPE}, {#MODEL}, {#SN}, {#PATH}, {#ATTRIBUTES}, {#RAIDTYPE};
- HDD、SSD、NVMEドライブタイプがサポートされています。 ドライブがRAIDに属していない場合、{#RAIDTYPE}は空になります。 RAIDの場合、{#NAME}にはアドオンが付きます。例: {"{#NAME}": "/dev/sda cciss,2"}。
smart.disk.get[<path>,<raid type>]
S.M.A.R.T.デバイスの利用可能なすべてのプロパティを返します。
戻り値:JSONオブジェクト。
パラメータ:
- 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オブジェクト。
パラメータ:
- unit name - ユニット名(アイテムプロトタイプで{#UNIT.NAME}マクロを使用して名前を検出することもできます);
- interface - ユニットインターフェースのタイプ。可能な値: Unit(デフォルト)、Service、Socket、Device、Mount、Automount、Swap、Target、Path。
コメント:
- このアイテムはLinuxプラットフォームでのみサポートされています;
- UnitインターフェースのLoadState、ActiveState、UnitFileStateはテキストと整数の両方で返されます:
"ActiveState":{"state":1,"text":"active"}。
systemd.unit.info[unit name,<property>,<interface>]
systemdユニット情報。
戻り値:文字列。
パラメータ:
- 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オブジェクト。
パラメータ:
- hostname - IPまたはDNSのいずれかを指定できます。
URLスキーム(httpsのみ)、パス(無視されます)、ポートを含めることができます。
最初と2番目のパラメータの両方でポートが指定されている場合、それらの値は一致している必要があります。
3番目のパラメータ(address)が指定されている場合、hostnameはSNIおよびホスト名検証のみに使用されます; - port - ポート番号(HTTPSのデフォルトは443);
- address - IPまたはDNSのいずれかを指定できます。 指定した場合、接続にはこの値が使用され、hostname(1番目のパラメータ)はSNIおよびホスト検証に使用されます。 1番目のパラメータがIPで3番目のパラメータがDNSの場合、1番目のパラメータが接続に使用され、3番目のパラメータがSNIおよびホスト検証に使用されます。
コメント:
- ホスト設定で指定された宛先が存在しない、利用できない、またはTLSハンドシェイクが無効な証明書以外のエラーで失敗した場合、このアイテムはサポート外になります;
- 現在、AIA(Authority Information Access)X.509拡張、CRLおよびOCSP(OCSPスタップリングを含む)、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。
- version: X.509バージョン(例:
- result: 検証結果を含みます。
- value: 検証ステータス(下記の値を参照)。
- message: 詳細な検証メッセージ(例:
"certificate verified successfully")。
- sha1_fingerprint: 証明書のSHA-1フィンガープリント。
- sha256_fingerprint: 証明書のSHA-256フィンガープリント。
- x509: X.509証明書の詳細を含みます。
$.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"
}