This is a translation of the original English documentation page. Help us make it better.

Sidebar

Zabbix Summit 2022
Register for Zabbix Summit 2022

1 item の作成

概要

Zabbixフロントエンドでアイテムを作成するには、以下の手順で行います:

  • ConfigurationHosts に行きます。
  • ホストの行の Items をクリックします。
  • 画面右上隅の Create item をクリックします。
  • 項目のパラメータをフォームに入力します。

また、既存のアイテムを開き、Clone ボタンを押し、別名で保存することでも item を作成できます。

設定

Itemタブには、一般的なアイテムの属性が表示されます。

必須入力項目には、赤いアスタリスクが表示されています。

パラメータ 説明
Name Item name.
Type Item type. See individual item type sections.
Key Item key (up to 2048 characters).
The supported item keys can be found in individual item type sections.
The key must be unique within a single host.
If key type is 'Zabbix agent', 'Zabbix agent (active)' or 'Simple check', the key value must be supported by Zabbix agent or Zabbix server.
See also: the correct key format.
Type of information Type of data as stored in the database after performing conversions, if any.
Numeric (unsigned) - 64bit unsigned integer
Numeric (float) - 64bit floating point number
This type will allow precision of approximately 15 digits and range from approximately -1.79E+308 to 1.79E+308 (with exception of PostgreSQL 11 and earlier versions).
Receiving values in scientific notation is also supported. E.g. 1.23E+7, 1e308, 1.1E-4.
Character - short text data
Log - long text data with optional log related properties (timestamp, source, severity, logeventid)
Text - long text data. See also text data limits.
For item keys that return data only in one specific format, matching type of information is selected automatically.
Host interface Select the host interface. This field is available when editing an item on the host level.
Units If a unit symbol is set, Zabbix will add post processing to the received value and display it with the set unit postfix.
By default, if the raw value exceeds 1000, it is divided by 1000 and displayed accordingly. For example, if you set bps and receive a value of 881764, it will be displayed as 881.76 Kbps.
The JEDEC memory standard is used for processing B (byte), Bps (bytes per second) units, which are divided by 1024. Thus, if units are set to B or Bps Zabbix will display:
1 as 1B/1Bps
1024 as 1KB/1KBps
1536 as 1.5KB/1.5KBps
Special processing is used if the following time-related units are used:
unixtime - translated to "yyyy.mm.dd hh:mm:ss". To translate correctly, the received value must be a Numeric (unsigned) type of information.
uptime - translated to "hh:mm:ss" or "N days, hh:mm:ss"
For example, if you receive the value as 881764 (seconds), it will be displayed as "10 days, 04:56:04"
s - translated to "yyy mmm ddd hhh mmm sss ms"; parameter is treated as number of seconds.
For example, if you receive the value as 881764 (seconds), it will be displayed as "10d 4h 56m"
Only 3 upper major units are shown, like "1m 15d 5h" or "2h 4m 46s". If there are no days to display, only two levels are displayed - "1m 5h" (no minutes, seconds or milliseconds are shown). Will be translated to "< 1 ms" if the value is less than 0.001.
Note that if a unit is prefixed with !, then no unit prefixes/processing is applied to item values. See unit conversion.
Update interval Retrieve a new value for this item every N seconds. Maximum allowed update interval is 86400 seconds (1 day).
Time suffixes are supported, e.g. 30s, 1m, 2h, 1d.
User macros are supported.
A single macro has to fill the whole field. Multiple macros in a field or macros mixed with text are not supported.
Note: The update interval can only be set to '0' if custom intervals exist with a non-zero value. If set to '0', and a custom interval (flexible or scheduled) exists with a non-zero value, the item will be polled during the custom interval duration.
Note that the first item poll after the item became active or after update interval change might occur earlier than the configured value.
An existing passive item can be polled for value immediately by pushing the Execute now button.
Custom intervals You can create custom rules for checking the item:
Flexible - create an exception to the Update interval (interval with different frequency)
Scheduling - create a custom polling schedule.
For detailed information see Custom intervals.
Time suffixes are supported in the Interval field, e.g. 30s, 1m, 2h, 1d.
User macros are supported.
A single macro has to fill the whole field. Multiple macros in a field or macros mixed with text are not supported.
Scheduling is supported since Zabbix 3.0.0.
Note: Not available for Zabbix agent active items.
History storage period Select either:
Do not keep history - item history is not stored. Useful for master items if only dependent items need to keep history.
This setting cannot be overridden by global housekeeper settings.
Storage period - specify the duration of keeping detailed history in the database (1 hour to 25 years). Older data will be removed by the housekeeper. Stored in seconds.
Time suffixes are supported, e.g. 2h, 1d. User macros are supported.
The Storage period value can be overridden globally in Administration → General → Housekeeper.
If a global overriding setting exists, a green info icon is displayed. If you position your mouse on it, a warning message is displayed, e.g. Overridden by global housekeeper settings (1d).
It is recommended to keep the recorded values for the smallest possible time to reduce the size of value history in the database. Instead of keeping a long history of values, you can keep longer data of trends.
See also History and trends.
Trend storage period Select either:
Do not keep trends - trends are not stored.
This setting cannot be overridden by global housekeeper settings.
Storage period - specify the duration of keeping aggregated (hourly min, max, avg, count) history in the database (1 day to 25 years). Older data will be removed by the housekeeper. Stored in seconds.
Time suffixes are supported, e.g. 24h, 1d. User macros are supported.
The Storage period value can be overridden globally in Administration → General → Housekeeper.
If a global overriding setting exists, a green info icon is displayed. If you position your mouse on it, a warning message is displayed, e.g. Overridden by global housekeeper settings (7d).
Note: Keeping trends is not available for non-numeric data - character, log and text.
See also History and trends.
Value mapping Apply value mapping to this item. Value mapping does not change received values, it is for displaying data only.
It works with Numeric(unsigned), Numeric(float) and Character items.
For example, "Windows service states".
Log time format Available for items of type Log only. Supported placeholders:
* y: Year (1970-2038)
* M: Month (01-12)
* d: Day (01-31)
* h: Hour (00-23)
* m: Minute (00-59)
* s: Second (00-59)
If left blank the timestamp will not be parsed.
For example, consider the following line from the Zabbix agent log file:
" 23480:20100328:154718.045 Zabbix agent started. Zabbix 1.8.2 (revision 11211)."
It begins with six character positions for PID, followed by date, time, and the rest of the line.
Log time format for this line would be "pppppp:yyyyMMdd:hhmmss".
Note that "p" and ":" chars are just placeholders and can be anything but "yMdhms".
Populates host inventory field You can select a host inventory field that the value of item will populate. This will work if automatic inventory population is enabled for the host.
This field is not available if Type of information is set to 'Log'.
Description Enter an item description.
Enabled Mark the checkbox to enable the item so it will be processed.
Latest data Click on the link to view the latest data for the item.
This link is only available when editing an already existing item.

アイテムタイプ固有のフィールドは、corresponding pagesに記述されています。

既存のtemplateレベルの項目を編集する場合、ホストレベルでは、
いくつかのフィールドが読み取り専用になります。フォームのヘッダーにあるリンクを使って、
テンプレートレベルに移動し、そこで編集することができます。
テンプレート・レベルでの変更は、そのテンプレートがリンクされているすべてのホストの項目を変更することに留意してください。

タブでは、アイテムレベルのtagsを定義することができます。

item 値の前処理

Preprocessing タブでは、受け取った値に対してtransformation rulesを定義することができます。

テスト

ある項目をテストし、正しく設定されれば、実際の値を得ることができます。 テストは、item が保存される前でも行うことができます。

テストは、ホスト item 、テンプレート item 、item プロトタイプ、およびローレベルディスカバリールールで利用できます。 アクティブな item では、テストは利用できません。

item テストは、以下のパッシブ item タイプに対応しています。

  • Zabbix agent
  • SNMP agent (v1, v2, v3)
  • IPMI agent
  • SSH checks
  • Telnet checks
  • JMX agent
  • Simple checks (except icmpping*, vmware.* items)
  • Zabbix internal
  • Calculated items
  • External checks
  • Database monitor
  • HTTP agent
  • Script

項目をテストするには、項目設定フォームの下部にある Test ボタンをクリックします。
Test ボタンは、テストできない項目(アクティブチェックや除外されたシンプルチェックなど)については、無効になります。

item テストフォームには、必要なホスト パラメータ (ホストアドレス、ポート、プロキシ名/プロキシなし)、
およびアイテム固有の詳細(SNMPv2コミュニティやSNMPv3セキュリティ認証など)のフィールドがあります。
これらのフィールドはコンテキストを認識します:

  • 値は、可能な限り事前に入力されています。
    エージェントが必要な項目については、ホストで選択されたエージェントインタフェースから情報を取得します。
  • テンプレートアイテムの値は、手動で入力する必要があります。
  • プレーンテキストのマクロ値は展開されます。
  • 値(または値の一部)がシークレットまたはVaultマクロであるフィールドは空であり
    手動で入力する必要があります。item パラメータにシークレットマクロ値が含まれている場合、
    "item にシークレット値を持つユーザー定義マクロが含まれています。
    これらのマクロの値は手動で入力してください。" という警告メッセージが表示されます。
  • フィールドは、item の種類によって必要ない場合は無効になります。
    (たとえば、ホストアドレスのフィールドとプロキシのフィールドは、計算項目で無効になります)

item をテストするには、Get valueをクリックします。 値の取得に成功すると、Valueフィールドが満たされ、現在の値がPrevious valueフィールドに移動し、 同時にPrev.timeフィールド、すなわち2つの値の時間差(クリック数)を計算します。 そしてEOLシーケンスを検出し、"\n\r"を検出した場合、CRLFに置き換えようとします。

設定に誤りがある場合、考えられる原因を説明するエラーメッセージが表示されます。

ホストから正常に取得された値は、preprocessing steps のテストに使用することも可能です。

フォームのボタン

フォームの下部にあるボタンで、いくつかの操作を行うことができます。

Add an item. This button is only available for new items.
Update the properties of an item.
Create another item based on the properties of the current item.
Execute a check for a new item value immediately. Supported for passive checks only (see more details).
Note that when checking for a value immediately, configuration cache is not updated, thus the value will not reflect very recent changes to item configuration.
Test if item configuration is correct by getting a value.
Delete the item history and trends.
Delete the item.
Cancel the editing of item properties.

テキストデータの制限

テキストデータの制限は、データベースのバックエンドに依存します。
テキストデータをデータベースに格納する前に、データベースの定義と一致するように切り捨てられます。

DBMS 情報の種類
Character Log Text
MySQL 255 characters 65536 bytes 65536 bytes
PostgreSQL 255 characters 65536 characters 65536 characters
Oracle 255 characters 65536 characters 65536 characters

単位変換

デフォルトでは、項目の単位を指定すると、乗数の接頭辞が追加されます。
例えば、入力値 '2048' に単位 'B' を指定した場合、'2KB' と表示されます。

単位を変換しないようにするには、!という接頭語を使用します。例えば !B のように。
感嘆符の有無にかかわらず,変換がどのように行われるかを理解するために,次の値と単位の例を参照してください。

1024 !B → 1024 B
       1024 B → 1 KB
       61 !s → 61 s
       61 s → 1m 1s
       0 !uptime → 0 uptime
       0 uptime → 00:00:00
       0 !! → 0 !
       0 ! → 0

Zabbix4.0以前は、ハードコードされたユニットストップリストがありました。
ms,rpm,RPM,%から構成されていました。このストップリストは廃止されました。
このような単位の変換を防ぐ正しい表記方法はms
, !rpm, !RPM, !% です。

カスタムスクリプトの制限

使用可能なカスタムスクリプトの長さは、使用するデータベースによって異なります。

DBMS 文字数の上限 byte数の上限
MySQL 65535 65535
Oracle Database 2048 4000
PostgreSQL 65535 not limited
SQLite (only Zabbix proxy) 65535 not limited

サポート対象外の項目

何らかの理由で値が取得できない項目は、サポート対象外になることがあります。 このような項目は、標準的な Update intervalで再チェックされます。

サポートされていない項目は、NOT SUPPORTED ステータスで報告されます。