16 Historia pozycji

Opis

Te parametry oraz możliwe wartości właściwości dla odpowiednich obiektów pól widgetu umożliwiają skonfigurowanie widgetu Historia pozycji w metodach dashboard.create i dashboard.update.

Właściwości fields widgetu nie są walidowane podczas tworzenia ani aktualizacji pulpitu. Pozwala to użytkownikom modyfikować wbudowane widgety i tworzyć własne widgety, ale jednocześnie wprowadza ryzyko nieprawidłowego tworzenia lub aktualizowania widgetów. Aby zapewnić pomyślne utworzenie lub zaktualizowanie widgetu Historia pozycji, zapoznaj się z zachowaniem parametrów opisanym w poniższych tabelach.

Parametry

Następujące parametry są obsługiwane dla widżetu Historia pozycji.

Parametr type name value
Interwał odświeżania 0 rf_rate 0 - Bez odświeżania;
10 - 10 sekund;
30 - 30 sekund;
60 - (domyślnie) 1 minuta;
120 - 2 minuty;
600 - 10 minut;
900 - 15 minut.
Układ 0 layout 0 - (domyślnie) Poziomy;
1 - Pionowy.
Kolumny (zobacz poniżej)
Pokaż wiersze 0 show_lines Możliwe wartości mieszczą się w zakresie 1-100.

Domyślnie: 25.
Nadpisz host 1 override_hostid._reference ABCDE._hostid - ustaw kompatybilny widżet (z parametrem Reference ustawionym na "ABCDE") jako źródło danych dla hostów;
DASHBOARD._hostid - ustaw [selektor hosta](/manual/web_interface/frontend_sections/dashboards/widgets#override-host na pulpicie) jako źródło danych dla hostów.

Ten parametr nie jest obsługiwany podczas konfigurowania widżetu na pulpicie szablonu.
Konfiguracja zaawansowana (zobacz poniżej)
Reference 1 reference Dowolna wartość tekstowa składająca się z 5 znaków (na przykład ABCDE lub JBPNL). Ta wartość musi być unikalna w obrębie pulpitu, do którego należy widżet.

Zachowanie parametru:
- wymagany

Kolumny

Kolumny mają wspólne parametry oraz dodatkowe parametry zależne od konfiguracji parametru Pozycja.

Dla wszystkich parametrów związanych z kolumnami liczba w nazwie właściwości (np. columns.0.name) odnosi się do kolumny, dla której parametr jest skonfigurowany.

Następujące parametry są obsługiwane dla wszystkich kolumn.

Parametr type name value
Nazwa 1 columns.0.name Dowolna wartość tekstowa.

Zachowanie parametru:
- wymagane
Pozycja 4 columns.0.itemid ID pozycji.

Podczas konfigurowania widżetu na pulpicie szablonu należy ustawić tylko pozycje skonfigurowane w szablonie.

Zachowanie parametru:
- wymagane
Kolor bazowy 1 columns.0.base_color Szesnastkowy kod koloru (np. FF0000).

Domyślnie: "" (puste).

Następujące parametry kolumn są obsługiwane, jeśli skonfigurowana pozycja jest pozycją typu numerycznego.

Parametr type name value
Wyświetlanie 0 columns.0.display 1 - (domyślnie) Bez zmian;
2 - Pasek;
3 - Wskaźniki.
Min 1 columns.0.min Dowolna wartość liczbowa.

Zachowanie parametru:
- obsługiwane, jeśli Wyświetlanie jest ustawione na „Pasek” lub „Wskaźniki”
Max 1 columns.0.max Dowolna wartość liczbowa.

Zachowanie parametru:
- obsługiwane, jeśli Wyświetlanie jest ustawione na „Pasek” lub „Wskaźniki”
Progi
Kolor 1 columns.0.thresholds.0.color Szesnastkowy kod koloru (np. FF0000).
Próg 1 columns.0.thresholds.0.threshold Dowolna wartość liczbowa. Sufiksy (np. „1d”, „2w”, „4K”, „8G”) są obsługiwane.
Dane historyczne 0 columns.0.history 0 - (domyślnie) Auto;
1 - Historia;
2 - Trendy.

Następujące parametry kolumn są obsługiwane, jeśli skonfigurowana pozycja jest pozycją typu znakowego, tekstowego lub log.

Parametr type name value
Wyróżnienia
Wyróżnienie 1 columns.0.highlights.0.color Szesnastkowy kod koloru (np. FF0000).
Próg 1 columns.0.highlights.0.pattern Dowolne wyrażenie regularne.
Wyświetlanie 0 columns.0.display 1 - (domyślnie) Bez zmian;
4 - HTML;
5 - Pojedyncza linia.
Pojedyncza linia 0 columns.0.max_length Możliwe wartości mieszczą się w zakresie 1-500.

Domyślnie: 100.

Zachowanie parametru:
- obsługiwane, jeśli Wyświetlanie jest ustawione na „Pojedyncza linia”
Użyj czcionki o stałej szerokości 0 columns.0.monospace_font 0 - (domyślnie) Użyj domyślnej czcionki;
1 - Użyj czcionki o stałej szerokości.
Wyświetl czas lokalny 0 columns.0.local_time 0 - (domyślnie) Wyświetl znacznik czasu;
1 - Wyświetl czas lokalny.

Zachowanie parametru:
- obsługiwane, jeśli pozycja jest ustawiona jako pozycja typu log, a Pokaż znacznik czasu jest ustawione na „Włączone”

Następujące parametry kolumn są obsługiwane, jeśli skonfigurowana pozycja jest pozycją typu binarnego.

Parametr type nazwa wartość
Pokaż miniaturę 1 columns.0.show_thumbnail 0 - (domyślnie) Wyłączone;
1 - Włączone.

Konfiguracja zaawansowana

Poniższe zaawansowane parametry konfiguracji są obsługiwane przez widżet Historia pozycji.

Parametr type name value
Nowe wartości 0 sortorder 0 - (domyślnie) U góry;
1 - Na dole.
Pokaż znacznik czasu 0 show_timestamp 0 - (domyślnie) Wyłączone;
1 - Włączone.
Pokaż nagłówek kolumny 0 show_column_header 0 - Wył.;
1 - Poziomo;
2 - (domyślnie) Pionowo.
Okres czasu 1 time_period._reference DASHBOARD._timeperiod - ustaw selektor okresu czasu pulpitu jako źródło danych;
ABCDE._timeperiod - ustaw kompatybilny widżet (z parametrem Reference ustawionym na "ABCDE") jako źródło danych.

Domyślnie: DASHBOARD._timeperiod

Alternatywnie można ustawić okres czasu tylko w parametrach Od i Do.
Od 1 time_period.from Prawidłowy ciąg czasu w składni bezwzględnej (YYYY-MM-DD hh:mm:ss) lub względnej (now, now/d, now/w-1w itd.).

Zachowanie parametru:
- obsługiwany, jeśli Okres czasu nie jest ustawiony
- wymagany, jeśli ustawiono time_period.to
Do 1 time_period.to Prawidłowy ciąg czasu w składni bezwzględnej (YYYY-MM-DD hh:mm:ss) lub względnej (now, now/d, now/w-1w itd.).

Zachowanie parametru:
- obsługiwany, jeśli Okres czasu nie jest ustawiony
- wymagany, jeśli ustawiono time_period.from

Przykłady

Poniższe przykłady mają na celu jedynie opisanie konfiguracji obiektów pól widżetu pulpitu dla widżetu Item history. Więcej informacji na temat konfiguracji pulpitu można znaleźć w dashboard.create.

Konfigurowanie widżetu Historia pozycji

Skonfiguruj widżet Historia pozycji, który wyświetla najnowsze dane dla dwóch numerycznych pozycji „42269” i „42270”. Dodatkowo skonfiguruj kolumny pozycji tak, aby były wyświetlane pionowo, z nazwami kolumn wyświetlanymi poziomo; ogranicz widok do 15 wierszy danych i uwzględnij osobną kolumnę znacznika czasu.

Żądanie:

{
    "jsonrpc": "2.0",
    "method": "dashboard.create",
    "params": {
        "name": "My dashboard",
        "display_period": 30,
        "auto_start": 1,
        "pages": [
            {
                "widgets": [
                    {
                        "type": "itemhistory",
                        "name": "Item history",
                        "x": "0",
                        "y": "0",
                        "width": "18",
                        "height": "6",
                        "view_mode": "0",
                        "fields": [
                            {
                                "type": "0",
                                "name": "layout",
                                "value": "1"
                            },
                            {
                                "type": "1",
                                "name": "columns.0.name",
                                "value": "CPU utilization"
                            },
                            {
                                "type": "4",
                                "name": "columns.0.itemid",
                                "value": "42269"
                            },
                            {
                                "type": "1",
                                "name": "columns.1.name",
                                "value": "Memory utilization"
                            },
                            {
                                "type": "4",
                                "name": "columns.1.itemid",
                                "value": "42270"
                            },
                            {
                                "type": "0",
                                "name": "show_lines",
                                "value": "15"
                            },
                            {
                                "type": "0",
                                "name": "show_timestamp",
                                "value": "1"
                            },
                            {
                                "type": "0",
                                "name": "show_column_header",
                                "value": "1"
                            },
                            {
                                "type": "1",
                                "name": "reference",
                                "value": "KIVKD"
                            }
                        ]
                    }
                ]
            }
        ],
        "userGroups": [
            {
                "usrgrpid": 7,
                "permission": 2
            }
        ],
        "users": [
            {
                "userid": 1,
                "permission": 3
            }
        ]
    },
    "id": 1
}

Odpowiedź:

{
    "jsonrpc": "2.0",
    "result": {
        "dashboardids": [
            "3"
        ]
    },
    "id": 1
}

Zobacz także