Obiekt pozycji
Następujące obiekty są bezpośrednio powiązane z API item.
Pozycja
Pozycji webowych nie można bezpośrednio tworzyć, aktualizować ani usuwać za pomocą Zabbix API.
Obiekt pozycji ma następujące właściwości.
| Property | Type | Description |
|---|---|---|
| itemid | ID | Identyfikator pozycji. Zachowanie właściwości: - tylko do odczytu - wymagane w operacjach aktualizacji |
| delay | string | Interwał aktualizacji pozycji. Akceptuje liczbę sekund (np. 1, 60, 300), wartość z przyrostkiem czasu (np. 30s, 1m, 2h, 1d) lub, opcjonalnie, jeden lub więcej interwałów niestandardowych, rozdzielonych średnikami. Interwały niestandardowe mogą być kombinacją interwałów elastycznych i harmonogramowych.Akceptuje makra użytkownika. Jeśli są używane, wartość musi być pojedynczym makrem. Wiele makr ani makra połączone z tekstem nie są obsługiwane. Interwały elastyczne można zapisywać jako dwa makra rozdzielone ukośnikiem (np. {$FLEX_INTERVAL}/{$FLEX_PERIOD}).Przykład: 1h;wd1-5h9-18;{$Macro1}/1-7,00:00-24:00;0/6-7,12:00-24:00;{$Macro2}/{$Macro3}Zachowanie właściwości: - wymagane, jeśli type ma wartość „Zabbix agent” (0), „Simple check” (3), „Zabbix internal” (5), „External check” (10), „Database monitor” (11), „IPMI agent” (12), „SSH agent” (13), „TELNET agent” (14), „Calculated” (15), „JMX agent” (16), „HTTP agent” (19), „SNMP agent” (20), „Script” (21), „Browser” (22), „Telemetry query” (24) lub jeśli type ma wartość „Zabbix agent (active)” (7), a key_ nie zawiera „mqtt.get” |
| hostid | ID | Identyfikator hosta lub szablonu, do którego należy pozycja. Zachowanie właściwości: - stała - wymagane w operacjach tworzenia |
| interfaceid | ID | Identyfikator interfejsu hosta pozycji. Zachowanie właściwości: - wymagane, jeśli pozycja należy do hosta, a type ma wartość „Zabbix agent”, „IPMI agent”, „JMX agent”, „SNMP trap” lub „SNMP agent”- obsługiwane, jeśli pozycja należy do hosta, a type ma wartość „Simple check”, „External check”, „SSH agent”, „TELNET agent” lub „HTTP agent”- tylko do odczytu dla obiektów wykrytych |
| key_ | string | Klucz pozycji. Zachowanie właściwości: - wymagane w operacjach tworzenia - tylko do odczytu dla obiektów dziedziczonych lub wykrytych |
| name | string | Nazwa pozycji. Obsługuje makra użytkownika. Zachowanie właściwości: - wymagane w operacjach tworzenia - tylko do odczytu dla obiektów dziedziczonych lub wykrytych |
| name_resolved | string | Nazwa pozycji z rozwiniętymi makrami użytkownika. Zachowanie właściwości: - tylko do odczytu |
| type | integer | Typ pozycji. Możliwe wartości: 0 - Zabbix agent; 2 - Zabbix trapper; 3 - Simple check; 5 - Zabbix internal; 7 - Zabbix agent (active); 9 - Web item; 10 - External check; 11 - Database monitor; 12 - IPMI agent; 13 - SSH agent; 14 - TELNET agent; 15 - Calculated; 16 - JMX agent; 17 - SNMP trap; 18 - Dependent item; 19 - HTTP agent; 20 - SNMP agent; 21 - Script; 22 - Browser; 24 - Telemetry query. Zachowanie właściwości: - wymagane w operacjach tworzenia - tylko do odczytu dla obiektów dziedziczonych lub wykrytych |
| url | string | Ciąg URL. Obsługuje makra użytkownika, {HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {HOST.PORT}, {ITEM.ID}, {ITEM.KEY}. Zachowanie właściwości: - wymagane, jeśli type ma wartość „HTTP agent”- tylko do odczytu dla obiektów dziedziczonych lub wykrytych |
| value_type | integer | Typ informacji pozycji. Możliwe wartości: 0 - liczba zmiennoprzecinkowa; 1 - znak; 2 - dziennik; 3 - liczba całkowita bez znaku; 4 - tekst; 5 - dane binarne; 6 - JSON. Zachowanie właściwości: - wymagane w operacjach tworzenia - tylko do odczytu dla obiektów dziedziczonych lub wykrytych |
| allow_traps | integer | Zezwalaj na wypełnianie wartości w sposób podobny do pozycji trappera. 0 - (domyślnie) Nie akceptuj danych przychodzących; 1 - Akceptuj dane przychodzące. Zachowanie właściwości: - obsługiwane, jeśli type ma wartość „HTTP agent”- tylko do odczytu dla obiektów wykrytych |
| authtype | integer | Metoda uwierzytelniania. Możliwe wartości, jeśli type ma wartość „SSH agent”:0 - (domyślnie) hasło; 1 - klucz publiczny. Możliwe wartości, jeśli type ma wartość „HTTP agent”:0 - (domyślnie) brak; 1 - podstawowe; 2 - NTLM; 3 - Kerberos; 4 - Digest. Zachowanie właściwości: - obsługiwane, jeśli type ma wartość „SSH agent” lub „HTTP agent”- tylko do odczytu dla obiektów dziedziczonych (jeśli type ma wartość „HTTP agent”) lub wykrytych |
| description | string | Opis pozycji. Zachowanie właściwości: - tylko do odczytu dla obiektów wykrytych |
| error | string | Tekst błędu, jeśli występują problemy z aktualizacją wartości pozycji. Zachowanie właściwości: - tylko do odczytu |
| flags | integer | Pochodzenie pozycji. Możliwe wartości: 0 - zwykła pozycja; 4 - pozycja przekonwertowana z prototypu. Zachowanie właściwości: - tylko do odczytu |
| follow_redirects | integer | Podążaj za przekierowaniami odpowiedzi podczas odpytywania danych. Możliwe wartości: 0 - Nie podążaj za przekierowaniami; 1 - (domyślnie) Podążaj za przekierowaniami. Zachowanie właściwości: - obsługiwane, jeśli type ma wartość „HTTP agent”- tylko do odczytu dla obiektów dziedziczonych lub wykrytych |
| headers | array | Tablica nagłówków, które zostaną wysłane podczas wykonywania żądania HTTP. Zachowanie właściwości: - obsługiwane, jeśli type ma wartość „HTTP agent”- tylko do odczytu dla obiektów dziedziczonych lub wykrytych |
| history | string | Jednostka czasu określająca, jak długo powinny być przechowywane dane historii. Akceptuje również makro użytkownika. Wartość domyślna: 31d. Zachowanie właściwości: - tylko do odczytu dla obiektów wykrytych |
| http_proxy | string | Ciąg połączenia proxy HTTP(S). Zachowanie właściwości: - obsługiwane, jeśli type ma wartość „HTTP agent”- tylko do odczytu dla obiektów dziedziczonych lub wykrytych |
| inventory_link | integer | Identyfikator pola inwentarza hosta wypełnianego przez pozycję. Listę obsługiwanych pól inwentarza hosta i ich identyfikatorów można znaleźć na stronie inwentarza hosta. Wartość domyślna: 0. Zachowanie właściwości: - obsługiwane, jeśli value_type ma wartość „numeric float”, „character”, „numeric unsigned” lub „text”- tylko do odczytu dla obiektów wykrytych |
| ipmi_sensor | string | Czujnik IPMI. Zachowanie właściwości: - wymagane, jeśli type ma wartość „IPMI agent”, a key_ nie ma wartości „ipmi.get”- obsługiwane, jeśli type ma wartość „IPMI agent”- tylko do odczytu dla obiektów dziedziczonych lub wykrytych |
| jmx_endpoint | string | Niestandardowy ciąg połączenia agenta JMX. Wartość domyślna: service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi Zachowanie właściwości: - obsługiwane, jeśli type ma wartość „JMX agent”- tylko do odczytu dla obiektów wykrytych |
| lastclock | timestamp | Czas ostatniej aktualizacji wartości pozycji. Domyślnie wyświetlane są tylko wartości z ostatnich 24 godzin. Ten okres można wydłużyć, zmieniając wartość parametru Max history display period w sekcji menu Administration > General. Zachowanie właściwości: - tylko do odczytu |
| lastns | integer | Nanosekundy czasu ostatniej aktualizacji wartości pozycji. Domyślnie wyświetlane są tylko wartości z ostatnich 24 godzin. Ten okres można wydłużyć, zmieniając wartość parametru Max history display period w sekcji menu Administration > General. Zachowanie właściwości: - tylko do odczytu |
| lastvalue | string | Ostatnia wartość pozycji. Domyślnie wyświetlane są tylko wartości z ostatnich 24 godzin. Ten okres można wydłużyć, zmieniając wartość parametru Max history display period w sekcji menu Administration > General. Zachowanie właściwości: - tylko do odczytu |
| logtimefmt | string | Format czasu we wpisach dziennika. Zachowanie właściwości: - obsługiwane, jeśli value_type ma wartość „log”- tylko do odczytu dla obiektów dziedziczonych lub wykrytych |
| master_itemid | ID | Identyfikator nadrzędnej pozycji. Zachowanie właściwości: - wymagane, jeśli type ma wartość „Dependent item”- tylko do odczytu dla obiektów dziedziczonych lub wykrytych |
| output_format | integer | Czy odpowiedź powinna zostać przekonwertowana do formatu JSON. 0 - (domyślnie) Przechowuj dane surowe; 1 - Konwertuj do formatu JSON. Zachowanie właściwości: - obsługiwane, jeśli type ma wartość „HTTP agent”- tylko do odczytu dla obiektów dziedziczonych lub wykrytych |
| params | string | Dodatkowe parametry zależne od typu pozycji: - wykonywany skrypt dla pozycji SSH agent i TELNET agent; - zapytanie SQL dla pozycji database monitor; - formuła dla pozycji calculated; - skrypt dla pozycji script i browser. Zachowanie właściwości: - wymagane, jeśli type ma wartość „Database monitor”, „SSH agent”, „TELNET agent”, „Calculated”, „Script” lub „Browser”- tylko do odczytu dla obiektów dziedziczonych (jeśli type ma wartość „Script” lub „Browser”) lub wykrytych |
| parameters | object/array | Dodatkowe parametry, jeśli type ma wartość „Script” lub „Browser”. Tablica obiektów z właściwościami name i value, przy czym name musi być unikatowe.Zachowanie właściwości: - obsługiwane, jeśli type ma wartość „Script” lub „Browser”- tylko do odczytu dla obiektów dziedziczonych lub wykrytych |
| password | string | Hasło do uwierzytelniania. Zachowanie właściwości: - wymagane, jeśli type ma wartość „JMX agent”, a username jest ustawione- obsługiwane, jeśli type ma wartość „Simple check”, „SSH agent”, „TELNET agent”, „Database monitor” lub „HTTP agent”- tylko do odczytu dla obiektów dziedziczonych (jeśli type ma wartość „HTTP agent”) lub wykrytych |
| post_type | integer | Typ treści danych POST przechowywanej we właściwości posts.Możliwe wartości: 0 - (domyślnie) Dane surowe; 2 - Dane JSON; 3 - Dane XML. Zachowanie właściwości: - obsługiwane, jeśli type ma wartość „HTTP agent”- tylko do odczytu dla obiektów dziedziczonych lub wykrytych |
| posts | string | Dane treści żądania HTTP(S). Zachowanie właściwości: - wymagane, jeśli type ma wartość „HTTP agent”, a post_type ma wartość „JSON data” lub „XML data”- obsługiwane, jeśli type ma wartość „HTTP agent”, a post_type ma wartość „Raw data”- tylko do odczytu dla obiektów dziedziczonych lub wykrytych |
| prevvalue | string | Poprzednia wartość pozycji. Domyślnie wyświetlane są tylko wartości z ostatnich 24 godzin. Ten okres można wydłużyć, zmieniając wartość parametru Max history display period w sekcji menu Administration > General. Zachowanie właściwości: - tylko do odczytu |
| privatekey | string | Nazwa pliku klucza prywatnego. Zachowanie właściwości: - wymagane, jeśli type ma wartość „SSH agent”, a authtype ma wartość „public key”- tylko do odczytu dla obiektów wykrytych |
| publickey | string | Nazwa pliku klucza publicznego. Zachowanie właściwości: - wymagane, jeśli type ma wartość „SSH agent”, a authtype ma wartość „public key”- tylko do odczytu dla obiektów wykrytych |
| query_fields | array | Tablica pól zapytania, które zostaną wysłane podczas wykonywania żądania HTTP. Zachowanie właściwości: - obsługiwane, jeśli type ma wartość „HTTP agent”- tylko do odczytu dla obiektów dziedziczonych lub wykrytych |
| request_method | integer | Typ metody żądania. Możliwe wartości: 0 - (domyślnie) GET; 1 - POST; 2 - PUT; 3 - HEAD. Zachowanie właściwości: - obsługiwane, jeśli type ma wartość „HTTP agent”- tylko do odczytu dla obiektów dziedziczonych lub wykrytych |
| retrieve_mode | integer | Część odpowiedzi, która powinna zostać zapisana. Możliwe wartości, jeśli request_method ma wartość „GET”, „POST” lub „PUT”:0 - (domyślnie) Treść; 1 - Nagłówki; 2 - Zostaną zapisane zarówno treść, jak i nagłówki. Możliwe wartości, jeśli request_method ma wartość „HEAD”:1 - Nagłówki. Zachowanie właściwości: - obsługiwane, jeśli type ma wartość „HTTP agent”- tylko do odczytu dla obiektów dziedziczonych lub wykrytych |
| snmp_oid | string | OID SNMP. Zachowanie właściwości: - wymagane, jeśli type ma wartość „SNMP agent”- tylko do odczytu dla obiektów dziedziczonych lub wykrytych |
| ssl_cert_file | string | Ścieżka do pliku publicznego klucza SSL. Zachowanie właściwości: - obsługiwane, jeśli type ma wartość „HTTP agent”- tylko do odczytu dla obiektów dziedziczonych lub wykrytych |
| ssl_key_file | string | Ścieżka do pliku prywatnego klucza SSL. Zachowanie właściwości: - obsługiwane, jeśli type ma wartość „HTTP agent”- tylko do odczytu dla obiektów dziedziczonych lub wykrytych |
| ssl_key_password | string | Hasło do pliku klucza SSL. Zachowanie właściwości: - obsługiwane, jeśli type ma wartość „HTTP agent”- tylko do odczytu dla obiektów dziedziczonych lub wykrytych |
| state | integer | Stan pozycji. Możliwe wartości: 0 - (domyślnie) normalny; 1 - nieobsługiwana. Zachowanie właściwości: - tylko do odczytu |
| status | integer | Stan pozycji. Możliwe wartości: 0 - (domyślnie) pozycja włączona; 1 - pozycja wyłączona. |
| status_codes | string | Zakresy wymaganych kodów stanu HTTP, rozdzielone przecinkami. Obsługuje również makra użytkownika jako część listy rozdzielanej przecinkami. Przykład: 200,200-{$M},{$M},200-400 Zachowanie właściwości: - obsługiwane, jeśli type ma wartość „HTTP agent”- tylko do odczytu dla obiektów dziedziczonych lub wykrytych |
| templateid | ID | Identyfikator pozycji nadrzędnego szablonu. Wskazówka: Użyj właściwości hostid, aby określić szablon, do którego należy pozycja.Zachowanie właściwości: - tylko do odczytu |
| timeout | string | Limit czasu żądania odpytywania danych pozycji. Akceptuje liczbę sekund (np. 1, 60, 300) lub wartość z przyrostkiem czasu (np. 300s, 1m). Akceptuje również makra użytkownika.Zakres możliwych wartości: 1-600s. Wartość domyślna: "" - użyj ustawień proxy/globalnych. Zachowanie właściwości: - obsługiwane, jeśli type ma wartość „Zabbix agent” (0), „Simple check” (3), a key_ nie zaczyna się od „vmware.” ani „icmpping”, „Zabbix agent (active)” (7), „External check” (10), „Database monitor” (11), „SSH agent” (13), „TELNET agent” (14), „HTTP agent” (19), „SNMP agent” (20), a snmp_oid zaczyna się od „walk[” lub „get[”, „Script” (21), „Browser” (22)- tylko do odczytu dla obiektów dziedziczonych i wykrytych, - jeśli zastosowana jest wartość domyślna, a pozycja należy do hosta monitorowanego przez niedostępny proxy lub grupę proxy, używany jest globalny limit czasu. |
| trapper_hosts | string | Dozwolone hosty. Zachowanie właściwości: - tylko do odczytu dla obiektów wykrytych - obsługiwane, jeśli type ma wartość „Zabbix trapper” lub jeśli type ma wartość „HTTP agent”, a allow_traps ma wartość „Allow incoming data”.Jeśli właściwość zostanie pominięta, jest automatycznie ustawiana na makro użytkownika {$TRAPPER.ALLOWED_HOSTS} (wartość domyślna). Domyślnie {$TRAPPER.ALLOWED_HOSTS} ma wartość 127.0.0.1,::1.Jeśli właściwość zostanie ustawiona na pusty ciąg, połączenia przychodzące ze wszystkich hostów będą odrzucane. |
| trends | string | Jednostka czasu określająca, jak długo powinny być przechowywane dane trendów. Akceptuje również makro użytkownika. Wartość domyślna: 365d. Zachowanie właściwości: - obsługiwane, jeśli value_type ma wartość „numeric float” lub „numeric unsigned”- tylko do odczytu dla obiektów wykrytych |
| units | string | Jednostki wartości. Zachowanie właściwości: - obsługiwane, jeśli value_type ma wartość „numeric float” lub „numeric unsigned”- tylko do odczytu dla obiektów dziedziczonych lub wykrytych |
| username | string | Nazwa użytkownika do uwierzytelniania. Zachowanie właściwości: - wymagane, jeśli type ma wartość „SSH agent”, „TELNET agent” lub jeśli type ma wartość „JMX agent”, a password jest ustawione- obsługiwane, jeśli type ma wartość „Simple check”, „Database monitor” lub „HTTP agent”- tylko do odczytu dla obiektów dziedziczonych (jeśli type ma wartość „HTTP agent”) lub wykrytych |
| uuid | string | Uniwersalny unikatowy identyfikator używany do powiązania importowanej pozycji z już istniejącymi pozycjami. Generowany automatycznie, jeśli nie zostanie podany. Zachowanie właściwości: - obsługiwane, jeśli pozycja należy do szablonu |
| valuemapid | ID | Identyfikator powiązanej mapy wartości. Zachowanie właściwości: - obsługiwane, jeśli value_type ma wartość „numeric float”, „character” lub „numeric unsigned”- tylko do odczytu dla obiektów dziedziczonych lub wykrytych |
| verify_host | integer | Czy należy sprawdzać, czy nazwa hosta używana dla połączenia jest zgodna z nazwą w certyfikacie hosta. Możliwe wartości: 0 - (domyślnie) Nie sprawdzaj; 1 - Sprawdzaj. Zachowanie właściwości: - obsługiwane, jeśli type ma wartość „HTTP agent”- tylko do odczytu dla obiektów dziedziczonych lub wykrytych |
| verify_peer | integer | Czy należy sprawdzać, czy certyfikat hosta jest autentyczny. Możliwe wartości: 0 - (domyślnie) Nie sprawdzaj; 1 - Sprawdzaj. Zachowanie właściwości: - obsługiwane, jeśli type ma wartość „HTTP agent”- tylko do odczytu dla obiektów dziedziczonych lub wykrytych |
| query | object | Konfiguracja zapytania telemetrycznego. Określa, jakie dane pozycja pobiera ze źródła danych telemetrycznych, jak je filtruje oraz jak agreguje wynik. Zachowanie właściwości: - wymagane, jeśli type ma wartość „Telemetry query”- tylko do odczytu dla obiektów dziedziczonych lub wykrytych |
| time_shift | string | Jak daleko wstecz (przed bieżącym czasem) kończy się zakres czasu, z którego pozycja pobiera dane. Akceptuje liczbę sekund (np. 1, 60, 300) lub wartość z przyrostkiem czasu (np. 30s, 1m, 2h, 1d). Akceptuje również makra użytkownika.Zakres możliwych wartości: 0-86400s. Wartość domyślna: 15s. Zachowanie właściwości: - obsługiwane, jeśli type ma wartość „Telemetry query” |
| lookback_limit | string | Jak daleko wstecz (przed bieżącym czasem) pozycja pobiera dane, gdy nie ma poprzedniego zapytania, od którego można kontynuować (np. przy pierwszym uruchomieniu pozycji), lub gdy poprzednie zapytanie jest starsze niż delay (np. z powodu niedostępności serwera Zabbix).Akceptuje liczbę sekund (np. 1, 60, 300) lub wartość z przyrostkiem czasu (np. 30s, 1m, 2h, 1d). Akceptuje również makra użytkownika.Zakres możliwych wartości: 1-259200s. Wartość domyślna: 10m. Zachowanie właściwości: - obsługiwane, jeśli type ma wartość „Telemetry query” |
| granularity | string | Długość fragmentu, na który dzielony jest pełny zakres czasu zapytania. Akceptuje liczbę sekund (np. 1, 60, 300) lub wartość z przyrostkiem czasu (np. 30s, 1m, 2h, 1d). Akceptuje również makra użytkownika.Zakres możliwych wartości: 1-86400s. Wartość domyślna: 15s. Zachowanie właściwości: - obsługiwane, jeśli type ma wartość „Telemetry query” |
Nagłówek HTTP
Obiekt nagłówka ma następujące właściwości:
| Właściwość | Typ | Opis |
|---|---|---|
| name | string | Nazwa nagłówka HTTP. Zachowanie właściwości: - wymagane |
| value | string | Wartość nagłówka. Zachowanie właściwości: - wymagane |
Pole zapytania HTTP
Obiekt pola zapytania definiuje nazwę i wartość używane do określenia parametru URL. Ma następujące właściwości:
| Właściwość | Type | Opis |
|---|---|---|
| name | string | Nazwa parametru. Zachowanie właściwości: - wymagane |
| value | string | Wartość parametru. Zachowanie właściwości: - wymagane |
Zapytanie telemetryczne
Obiekt zapytania telemetrycznego ma następujące właściwości.
| Property | Type | Description |
|---|---|---|
| signal_type | integer | Typ sygnału, którego dotyczy zapytanie pozycji. Możliwe wartości: 0 - Ślady; 1 - Metryki; 2 - Dzienniki. Zachowanie właściwości: - required |
| metric_point_type | integer | Typ punktu metryki, którego dotyczy zapytanie pozycji. Możliwe wartości: 0 - Suma; 1 - Wskaźnik; 2 - Histogram; 3 - Histogram wykładniczy. Zachowanie właściwości: - required jeśli signal_type ma wartość „Metrics” |
| columns | array | Tablica kolumn danych telemetrycznych, których dotyczy zapytanie pozycji. Może być pusta. Zachowanie właściwości: - required |
| aggregated_columns | array | Tablica zagregowanych kolumn danych telemetrycznych, których dotyczy zapytanie pozycji, oraz sposób obliczania wartości na podstawie rekordów kolumn. Zachowanie właściwości: - required |
| filter | object | Filtr zapytania telemetrycznego dla rekordów kolumn w zapytaniu. Zachowanie właściwości: - required |
Kolumny danych telemetrycznych
Obiekt kolumn danych telemetrycznych ma następujące właściwości.
| Property | Type | Description |
|---|---|---|
| column | string | Nazwa kolumny danych telemetrycznych, którą odpytuje pozycja. Patrz obsługiwane kolumny danych telemetrycznych. W przypadku wielu kolumn zawierających pojedyncze wartości każda wartość column musi być unikatowa. W przypadku wielu kolumn zawierających pary klucz-wartość każda para column i attribute_key musi być unikatowa. |
| attribute_key | string | Nazwa klucza, który odpytuje pozycja w kolumnie zawierającej pary klucz-wartość. W przypadku wielu kolumn zawierających pary klucz-wartość każda para column i attribute_key musi być unikatowa.Zachowanie właściwości: - required, jeśli column jest ustawione na kolumnę zawierającą pary klucz-wartość |
Kolumny zagregowanych danych telemetrycznych
Obiekt kolumn zagregowanych danych telemetrycznych ma następujące właściwości.
| Property | Type | Description |
|---|---|---|
| column | string | Nazwa kolumny danych telemetrycznych, którą odpytuje pozycja. Więcej informacji zawiera sekcja obsługiwane kolumny danych telemetrycznych. W przypadku wielu kolumn każda wartość column musi być unikatowa.Ta właściwość nie jest obsługiwana, jeśli function ma wartość „Count”.Zachowanie właściwości: - wymagana, jeśli function ma wartość „Min”, „Max”, „Average”, „Sum” lub „Percentile” |
| function | integer | Funkcja, którą pozycja stosuje do rekordów kolumny. Możliwe wartości: 1 - Min; 2 - Max; 3 - Average; 4 - Count; 5 - Sum; 8 - Percentile. Zachowanie właściwości: - wymagana |
| parameters | array | Percentyl obliczany przez pozycję na podstawie rekordów kolumny. Możliwa wartość: liczba od 0 do 100 podana jako ciąg znaków. Zachowanie właściwości: - wymagana, jeśli function ma wartość „Percentile” |
| alias | string | Unikatowa nazwa obliczonej wartości, używana do identyfikowania jej w wartości pozycji. Każda wartość alias musi być unikatowa.Zachowanie właściwości: - wymagana |
Filtr danych telemetrycznych
Obiekt filtru danych telemetrycznych ma następujące właściwości.
| Property | Type | Description |
|---|---|---|
| conditions | array | Warunki filtru danych telemetrycznych, które musi spełniać rekord w kolumnie danych telemetrycznych. Zachowanie właściwości: - required |
| evaltype | integer | Metoda oceny warunku filtru. Możliwe wartości: 0 - And/Or; 1 - And; 2 - Or; 3 - Wyrażenie niestandardowe. Zachowanie właściwości: - required |
| eval_formula | string | Wygenerowane wyrażenie używane do oceny warunków filtru. Wyrażenie zawiera identyfikatory odwołujące się do określonych warunków filtru za pomocą ich formulaid. Wartość eval_formula jest równa wartości formula w przypadku filtrów z wyrażeniem niestandardowym.Zachowanie właściwości: - read-only |
| formula | string | Wyrażenie zdefiniowane przez użytkownika, używane do oceny warunków filtrów z wyrażeniem niestandardowym. Wyrażenie musi zawierać identyfikatory odwołujące się do określonych warunków filtru za pomocą ich formulaid. Identyfikatory użyte w wyrażeniu muszą dokładnie odpowiadać identyfikatorom zdefiniowanym w warunkach filtru: żaden warunek nie może pozostać nieużyty ani pominięty.Zachowanie właściwości: - required jeśli evaltype ma wartość „Custom expression” |
Warunki filtrowania danych telemetrycznych
Obiekt warunków filtrowania danych telemetrycznych ma następujące właściwości.
| Property | Type | Description |
|---|---|---|
| column | string | Nazwa kolumny danych telemetrycznych, do której odnosi się warunek filtrowania. Patrz obsługiwane kolumny danych telemetrycznych. Zachowanie właściwości: - wymagana |
| attribute_key | string | Nazwa klucza, do którego odnosi się warunek, w kolumnie zawierającej pary klucz-wartość. Zachowanie właściwości: - wymagana, jeśli column jest ustawiona na kolumnę zawierającą pary klucz-wartość |
| operator | integer | Operator warunku filtrowania. Możliwe wartości dla kolumn zawierających pojedyncze wartości: 0 - Jest równe; 1 - Nie jest równe; 2 - Zawiera; 3 - Nie zawiera. Możliwe wartości dla kolumn zawierających pary klucz-wartość: 0 - Jest równe; 1 - Nie jest równe; 12 - Istnieje. Zachowanie właściwości: - wymagana |
| value | string | Wartość, z którą należy porównać. Zachowanie właściwości: - wymagana, jeśli operator ma wartość „Jest równe”, „Nie jest równe”, „Zawiera” lub „Nie zawiera” |
| formulaid | string | Dowolny unikatowy identyfikator używany do odwoływania się do warunku z wyrażenia niestandardowego. Może zawierać wyłącznie wielkie litery. Identyfikator musi zostać zdefiniowany przez użytkownika podczas modyfikowania warunków filtrowania, ale przy kolejnym żądaniu zostanie wygenerowany ponownie. Zachowanie właściwości: - wymagana, jeśli evaltype obiektu filtra zapytania telemetrycznego ma wartość „Wyrażenie niestandardowe” |
Tag pozycji
Obiekt tagu pozycji ma następujące właściwości.
| Właściwość | Type | Opis |
|---|---|---|
| tag | string | Nazwa tagu pozycji. Zachowanie właściwości: - wymagane |
| value | string | Wartość tagu pozycji. Zachowanie właściwości: - tylko do odczytu. |
| object | integer | Typ obiektu, z którego tag został odziedziczony. Możliwe wartości: 0 - szablon; 1 - host. Zachowanie właściwości: - tylko do odczytu. |
| objectid | ID | ID obiektu, z którego tag został odziedziczony. Zachowanie właściwości: - tylko do odczytu. |
Wstępne przetwarzanie pozycji
Obiekt wstępnego przetwarzania pozycji ma następujące właściwości.
| Właściwość | Typ | Opis |
|---|---|---|
| type | integer | Typ opcji wstępnego przetwarzania. Możliwe wartości: 1 - Niestandardowy mnożnik; 2 - Przycięcie z prawej; 3 - Przycięcie z lewej; 4 - Przycięcie; 5 - Wyrażenie regularne; 6 - Wartość logiczna na dziesiętną; 7 - Ósemkowa na dziesiętną; 8 - Szesnastkowa na dziesiętną; 9 - Prosta zmiana; 10 - Zmiana na sekundę; 11 - XML XPath; 12 - JSONPath; 13 - W zakresie; 14 - Pasuje do wyrażenia regularnego; 15 - Nie pasuje do wyrażenia regularnego; 16 - Sprawdzenie błędu w JSON; 17 - Sprawdzenie błędu w XML; 18 - Sprawdzenie błędu za pomocą wyrażenia regularnego; 19 - Odrzucenie niezmienionych; 20 - Odrzucenie niezmienionych z sygnałem kontrolnym; 21 - JavaScript; 22 - Wzorzec Prometheus; 23 - Prometheus do JSON; 24 - CSV do JSON; 25 - Zastąpienie; 26 - Sprawdzenie nieobsługiwania; 27 - XML do JSON; 28 - Wartość SNMP walk; 29 - SNMP walk do JSON; 30 - Wartość SNMP get. Zachowanie właściwości: - wymagana |
| params | string | Dodatkowe parametry używane przez opcję wstępnego przetwarzania. Wiele parametrów jest rozdzielanych znakiem nowego wiersza (\n). Jeśli type ma wartość „Check unsupported”, parametry mają składnię <scope>[\n<pattern>], gdzie pattern jest wyrażeniem regularnym, a scope przyjmuje jedną z wartości:-1 - dopasowanie dowolnego błędu; \ 0 - sprawdzenie, czy komunikat błędu pasuje do pattern; \ 1 - sprawdzenie, czy komunikat błędu nie pasuje do pattern. Zachowanie właściwości: - wymagana, jeśli type ma wartość „Custom multiplier” (1), „Right trim” (2), „Left trim” (3), „Trim” (4), „Regular expression” (5), „XML XPath” (11), „JSONPath” (12), „In range” (13), „Matches regular expression” (14), „Does not match regular expression” (15), „Check for error in JSON” (16), „Check for error in XML” (17), „Check for error using regular expression” (18), „Discard unchanged with heartbeat” (20), „JavaScript” (21), „Prometheus pattern” (22), „Prometheus to JSON” (23), „CSV to JSON” (24), „Replace” (25), Check unsupported (26), „SNMP walk value” (28), „SNMP walk to JSON” (29) lub „SNMP get value” (30) |
| error_handler | integer | Typ działania używanego w przypadku niepowodzenia kroku wstępnego przetwarzania. Możliwe wartości: 0 - Komunikat błędu jest ustawiany przez serwer Zabbix; 1 - Odrzucenie wartości; 2 - Ustawienie niestandardowej wartości; 3 - Ustawienie niestandardowego komunikatu błędu. Możliwe wartości, jeśli type ma wartość „Check unsupported”:1 - Odrzucenie wartości; 2 - Ustawienie niestandardowej wartości; 3 - Ustawienie niestandardowego komunikatu błędu. Zachowanie właściwości: - wymagana, jeśli type ma wartość „Custom multiplier” (1), „Regular expression” (5), „Boolean to decimal” (6), „Octal to decimal” (7), „Hexadecimal to decimal” (8), „Simple change” (9), „Change per second” (10), „XML XPath” (11), „JSONPath” (12), „In range” (13), „Matches regular expression” (14), „Does not match regular expression” (15), „Check for error in JSON” (16), „Check for error in XML” (17), „Check for error using regular expression” (18), „Prometheus pattern” (22), „Prometheus to JSON” (23), „CSV to JSON” (24), „Check unsupported” (26), „XML to JSON” (27), „SNMP walk value” (28), „SNMP walk to JSON” (29) lub „SNMP get value” (30) |
| error_handler_params | string | Parametry obsługi błędów. Zachowanie właściwości: - wymagana, jeśli error_handler ma wartość „Set custom value” lub „Set custom error message” |
Dla każdego typu wstępnego przetwarzania obsługiwane są następujące parametry i procedury obsługi błędów.
| Typ wstępnego przetwarzania | Nazwa | Parametr 1 | Parametr 2 | Parametr 3 | Obsługiwane procedury obsługi błędów |
|---|---|---|---|---|---|
| 1 | Niestandardowy mnożnik | liczba1, 6 | 0, 1, 2, 3 | ||
| 2 | Przycięcie z prawej | lista znaków2 | |||
| 3 | Przycięcie z lewej | lista znaków2 | |||
| 4 | Przycięcie | lista znaków2 | |||
| 5 | Wyrażenie regularne | wzorzec3 | wynik2 | 0, 1, 2, 3 | |
| 6 | Wartość logiczna na dziesiętną | 0, 1, 2, 3 | |||
| 7 | Ósemkowa na dziesiętną | 0, 1, 2, 3 | |||
| 8 | Szesnastkowa na dziesiętną | 0, 1, 2, 3 | |||
| 9 | Prosta zmiana | 0, 1, 2, 3 | |||
| 10 | Zmiana na sekundę | 0, 1, 2, 3 | |||
| 11 | XML XPath | ścieżka4 | 0, 1, 2, 3 | ||
| 12 | JSONPath | ścieżka4 | 0, 1, 2, 3 | ||
| 13 | W zakresie | min1, 6 | max1, 6 | 0, 1, 2, 3 | |
| 14 | Pasuje do wyrażenia regularnego | wzorzec3 | 0, 1, 2, 3 | ||
| 15 | Nie pasuje do wyrażenia regularnego | wzorzec3 | 0, 1, 2, 3 | ||
| 16 | Sprawdzenie błędu w JSON | ścieżka4 | 0, 1, 2, 3 | ||
| 17 | Sprawdzenie błędu w XML | ścieżka4 | 0, 1, 2, 3 | ||
| 18 | Sprawdzenie błędu za pomocą wyrażenia regularnego | wzorzec3 | wynik2 | 0, 1, 2, 3 | |
| 19 | Odrzucenie niezmienionych | ||||
| 20 | Odrzucenie niezmienionych z sygnałem kontrolnym | sekundy5, 6 | |||
| 21 | JavaScript | skrypt2 | |||
| 22 | Wzorzec Prometheus | wzorzec6, 7 | value, label, function |
wynik8, 9 | 0, 1, 2, 3 |
| 23 | Prometheus do JSON | wzorzec6, 7 | 0, 1, 2, 3 | ||
| 24 | CSV do JSON | znak2 | znak2 | 0,1 | 0, 1, 2, 3 |
| 25 | Zastąpienie | wyszukiwany ciąg2 | zastąpienie2 | ||
| 26 | Sprawdzenie nieobsługiwania | zakres1 | wzorzec3, 6 | 1, 2, 3 | |
| 27 | XML do JSON | 0, 1, 2, 3 | |||
| 28 | Wartość SNMP walk | OID2 | Format: 0 - Bez zmian 1 - UTF-8 z Hex-STRING 2 - MAC z Hex-STRING 3 - Liczba całkowita z BITS |
0, 1, 2, 3 | |
| 29 | SNMP walk do JSON10 | Nazwa pola2 | Prefiks OID2 | Format: 0 - Bez zmian 1 - UTF-8 z Hex-STRING 2 - MAC z Hex-STRING 3 - Liczba całkowita z BITS |
0, 1, 2, 3 |
| 30 | Wartość SNMP get | Format: 1 - UTF-8 z Hex-STRING 2 - MAC z Hex-STRING 3 - Liczba całkowita z BITS |
0, 1, 2, 3 | ||
1 liczba zmiennoprzecinkowa (liczby całkowite są niejawnie konwertowane na wartości zmiennoprzecinkowe)
2 ciąg znaków
3 wyrażenie regularne
4 JSONPath lub XML XPath
5 dodatnia liczba całkowita (z obsługą przyrostków czasu, np. 30s, 1m, 2h, 1d)
6 makro użytkownika
7 wzorzec Prometheus zgodny ze składnią: <metric name>{<label name>="<label value>", ...} == <value>.
Każdy składnik wzorca Prometheus (metryka, nazwa etykiety, wartość etykiety i wartość metryki) może być makrem użytkownika.
8 wynik Prometheus zgodny ze składnią: <label name> (może być makrem użytkownika), jeśli jako drugi parametr wybrano label.
9 Jedna z funkcji agregujących: sum, min, max, avg, count, jeśli jako drugi parametr wybrano function.
10 Obsługuje wiele rekordów „Nazwa pola,Prefiks OID,Format” rozdzielonych znakiem nowego wiersza.