Dashboards

Dashboards jsou vizualizace příchozích logových dat. Zatímco TeskaLabs LogMan.io přichází s knihovnou přednastavených dashboardů, můžete si také vytvořit vlastní. Zobrazte přednastavené dashboardy v webové aplikaci LogMan.io v Dashboards.

Abychom vytvořili dashboard, musíte napsat nebo zkopírovat soubor dashboardu do Library.

Vytvoření souboru dashboardu

Napište dashboardy v JSON.

Vytvoření prázdného dashboardu

1. V TeskaLabs LogMan.io přejděte do Library.
2. Klikněte na Dashboards.
3. Klikněte na Create new item in Dashboards.
4. Pojmenujte položku a klikněte na Create. Pokud se nová položka ihned nezobrazí, obnovte stránku.

Kopírování existujícího dashboardu

1. V TeskaLabs LogMan.io přejděte do Library.
2. Klikněte na Dashboards.
3. Klikněte na položku, kterou chcete duplikovat, a poté klikněte na ikonu blízko horní části. Klikněte na Copy.
4. Zvolte nové jméno pro položku a klikněte na Copy. Pokud se nová položka ihned nezobrazí, obnovte stránku.

Struktura dashboardu

Napište dashboardy v JSON a mějte na paměti, že jsou citlivé na velikost písmen.

Dashboardy mají dvě části:

1. Základ dashboardu: Panel dotazu, výběr času, tlačítko pro obnovení a tlačítko pro možnosti
2. Widgety: Vizualizace (graf, tabulka, seznam atd.)

Základ dashboardu

Zahrňte tuto sekci přesně tak, jak je, abyste zahrnuli panel dotazu, výběr času, tlačítko pro obnovení a možnosti.

{
    "Prompts": {
        "dateRangePicker": true,
        "filterInput": true,
        "submitButton": true

Panel dotazu vykreslený:

Widgety

Widgety se skládají z párů datasource a widget. Když píšete widget, musíte zahrnout jak sekci datasource, tak sekci widget.

Tipy pro formátování JSON:

• Oddělte každou sekci datasource a widget složenou závorkou a čárkou }, kromě posledního widgetu v dashboardu, který čárku nepotřebuje (viz celý příklad)
• Ukončete každý řádek čárkou , kromě poslední položky v sekci

Umístění widgetu

Každý widget má rozvrhové řádky, které určují velikost a umístění widgetu. Pokud při psaní widgetu nezahrnete rozvrhové řádky, dashboard je vygeneruje automaticky.

1. Zahrňte rozvrhové řádky s doporučenými hodnotami z každé šablony widgetu, NEBO nezahrnujte žádné rozvrhové řádky. (Pokud nezahrnete žádné rozvrhové řádky, ujistěte se, že poslední položka v každé sekci nekončí čárkou.)
2. Přejděte na Dashboards v LogMan.io a změňte velikost a umístění widgetu.
3. Když přesunete widget na stránce Dashboards, soubor dashboardu v Knihovně automaticky generuje nebo upravuje rozvrhové řádky podle potřeby. Pokud pracujete v souboru dashboardu v Knihovně a současně měníte umístění widgetů na Dashboards, ujistěte se, že uložíte a obnovíte obě stránky po provedení změn na kterékoliv stránce.

Pořadí widgetů ve vašem souboru dashboardu neurčuje umístění widgetu a pořadí se nemění, pokud widgety přemístíte na Dashboards.

Pojmenování

Doporučujeme se dohodnout na konvencích pojmenování pro dashboardy a widgety ve vaší organizaci, abyste se vyhnuli zmatku.

matchPhrase filtr

Pro datové zdroje Elasticsearch použijte Lucene dotazovou syntaxi pro hodnotu matchPhrase.

Barvy

Ve výchozím nastavení widgety koláčového grafu a sloupcového grafu používají modrou barevnou paletu. Chcete-li změnit barevnou paletu, vložte "color":"(barevná paleta)" přímo před rozvrhové řádky.

• Modrá: Není třeba žádné další řádky
• Fialová: "color":"sunset"
• Žlutá: "color":"warning"
• Červená: "color":"danger"

Odstraňování problémů s JSON

Pokud při pokusu o uložení souboru dostanete chybovou zprávu o formátování JSON:

• Řiďte se doporučením chybové zprávy, která specifikuje, co JSON "očekává" - může to znamenat, že vám chybí povinný pár klíč-hodnota, nebo je interpunkce nesprávná.
• Pokud nemůžete najít chybu, zkontrolujte, zda je vaše formátování konzistentní s ostatními funkčními dashboardy.

Pokud se váš widget nezobrazuje správně:

• Ujistěte se, že hodnota datasource se shoduje v sekcích datového zdroje a widgetu.
• Zkontrolujte pravopisné chyby nebo problémy se strukturou dotazu v jakýchkoli odkazovaných polích a v polích uvedených v dotazu matchphrase.
• Zkontrolujte jakékoli další překlepy nebo nesrovnalosti.
• Zkontrolujte, že zdroj logů, na který odkazujete, je připojen.

Použijte tyto příklady jako vodítka. Klikněte na ikony , abyste se dozvěděli, co každá řádka znamená.

Sloupcové grafy

Sloupcový graf zobrazuje hodnoty s vertikálními sloupci na ose x a y. Délka každého sloupce je úměrná datům, která představuje.

Příklad JSON pro sloupcový graf:

    "datasource:office365-email-aggregated": { #(1)
        "type": "elasticsearch", #(2)
        "datetimeField": "@timestamp", #(3)
        "specification": "lmio-{{ tenant }}-events*", #(4)
        "aggregateResult": true, #(5)
        "matchPhrase": "event.dataset:microsoft-office-365 AND event.action:MessageTrace" #(6)
    },
    "widget:office365-email-aggregated": { #(7)
        "datasource": "datasource:office365-email-aggregated", #(8)
        "title": "Odeslané a přijaté e-maily", #(9)
        "type": "BarChart", #(10)
        "xaxis": "@timestamp", #(11)
        "yaxis": "o365.message.status", #(12)
        "ylabel": "Počet", #(13)
        "table": true, #(14)
        "layout:w": 6, #(15)
        "layout:h": 4,
        "layout:x": 0,
        "layout:y": 0,
        "layout:moved": false,
        "layout:static": true,
        "layout:isResizable": false
    },

1. datasource označuje začátek sekce datového zdroje a také název datového zdroje. Název neovlivňuje funkci dashboardu, ale musíte na něj správně odkazovat v sekci widgetu.
2. Typ datového zdroje. Pokud používáte Elasticsearch, hodnota je "elasticsearch"
3. Indikuje, které pole v logech je polem s datem a časem. Například v logech Elasticsearch, které jsou parsovány Elastic Common Schema (ECS), je pole s datem a časem @timestamp.
4. Odkazuje na index, ze kterého se načítají data v Elasticsearch. Hodnota lmio-{{ tenant}}-events* odpovídá našim názvovým konvencím indexů v Elasticsearch a {{ tenant }} je místo pro aktivního tenanta. Hvězdička * umožňuje neupřesněné další znaky v názvu indexu za events. Výsledek: Widget zobrazuje data z aktivního tenanta.
5. aggregateResult nastaveno na true provádí agregaci na datech před jejich zobrazením v dashboardu. V tomto případě se počítají odeslané a přijaté e-maily (vypočítává se součet).
6. Dotaz, který filtruje konkrétní logy pomocí Lucene dotazové syntaxi. V tomto případě musí být jakákoli data zobrazená v dashboardu z datasetu Microsoft Office 365 a mít hodnotu MessageTrace v poli event.action.
7. widget označuje začátek sekce widgetu a také název widgetu. Název neovlivňuje funkci dashboardu.
8. Odkazuje na sekci datového zdroje výše, která ji naplňuje. Ujistěte se, že hodnota zde přesně odpovídá názvu příslušného datového zdroje. (Tímto se widget dozví, odkud získá data.)
9. Název widgetu, který se bude zobrazovat v dashboardu
10. Typ widgetu
11. Pole z logů, jehož hodnoty budou reprezentovány na ose x
12. Pole z logů, jehož hodnoty budou reprezentovány na ose y
13. Popis pro osu y, který se bude zobrazovat v dashboardu
14. Nastavení table na true vám umožňuje přepínat mezi zobrazením grafu a zobrazením tabulky na widgetu v dashboardu. Výběr false zakáže funkci přepínání mezi grafem a tabulkou.
15. Viz poznámka výše o umístění widgetů pro informace o rozvrhových řádcích.

Widget sloupcového grafu vykreslený:

Šablona sloupcového grafu:

Pro vytvoření widgetu sloupcového grafu zkopírujte a vložte tuto šablonu do souboru dashboardu v Knihovně a vyplňte hodnoty. Doporučené rozvrhové hodnoty, hodnoty specifikující datový zdroj Elasticsearch a hodnota, která organizuje sloupcový graf podle času, jsou již vyplněny.

    "datasource:Název datového zdroje": {
        "type": "elasticsearch",
        "datetimeField": "@timestamp",
        "specification": "lmio-{{ tenant }}-events*",
        "aggregateResult": true,
        "matchPhrase": " "
    },
    "widget:Název widgetu": {
        "datasource": "datasource:office365-email-aggregated",
        "title": "Název widgetu",
        "type": "BarChart",
        "xaxis": "@timestamp",
        "yaxis": " ",
        "ylabel": " ",
        "table": true,
        "layout:w": 6,
        "layout:h": 4,
        "layout:x": 0,
        "layout:y": 0,
        "layout:moved": false,
        "layout:static": true,
        "layout:isResizable": false
    },

Koláčové grafy

Koláčový graf je kruh rozdělený na plátky, přičemž každý plátek představuje procento celku.

Příklad JSON pro koláčový graf:

    "datasource:office365-email-status": { #(1)
        "datetimeField": "@timestamp", #(2)
        "groupBy": "o365.message.status", #(3)
        "matchPhrase": "event.dataset:microsoft-office-365 AND event.action:MessageTrace", #(4)
        "specification": "lmio-{{ tenant }}-events*", #(5)
        "type": "elasticsearch", #(6)
        "size": 20 #(7)
    },
    "widget:office365-email-status": { #(8)
        "datasource": "datasource:office365-email-status", #(9)
        "title": "Stav přijatých e-mailů", #(10)
        "type": "PieChart", #(11)
        "tooltip": true, #(12)
        "table": true, #(13)
        "layout:w": 6, #(14)
        "layout:h": 4,
        "layout:x": 6,
        "layout:y": 0,
        "layout:moved": false,
        "layout:static": true,
        "layout:isResizable": false
    },

1. datasource označuje začátek sekce datového zdroje a také název datového zdroje. Název neovlivňuje funkci dashboardu, ale musíte na něj správně odkazovat v sekci widgetu.
2. Indikuje, které pole v logech je polem s datem a časem. Například v logech Elasticsearch, které jsou parsovány Elastic Common Schema (ECS), je pole s datem a časem @timestamp.
3. Pole, jehož hodnoty budou reprezentovat každý "plátek" koláčového grafu. V tomto příkladu koláčový graf oddělí logy podle jejich stavu zprávy. Bude existovat samostatný plátek pro každý z Odeslaných, Rozšířených, Karanténních atd., aby ukázal procentuální výskyt každého stavu zprávy.
4. Dotaz, který filtruje konkrétní logy. V tomto případě budou zobrazeny pouze data z logů z datasetu Microsoft Office 365 s hodnotou MessageTrace v poli event.action.
5. Odkazuje na index, ze kterého se načítají data v Elasticsearch. Hodnota lmio-{{ tenant}}-events* odpovídá našim názvovým konvencím indexů v Elasticsearch a {{ tenant }} je místo pro aktivního tenanta. Hvězdička * umožňuje neupřesněné další znaky v názvu indexu za events. Výsledek: Widget zobrazuje data z aktivního tenanta.
6. Typ datového zdroje. Pokud používáte Elasticsearch, hodnota je "elasticsearch"
7. Kolik hodnot chcete zobrazit. Protože tento koláčový graf zobrazuje stavy přijatých e-mailů, hodnota size 20 zobrazuje nejlepších 20 typů stavů. (Koláčový graf může mít maximálně 20 plátků.)
8. widget označuje začátek sekce widgetu a také název widgetu. Název neovlivňuje funkci dashboardu.
9. Odkazuje na sekci datového zdroje výše, která ji naplňuje. Ujistěte se, že hodnota zde přesně odpovídá názvu příslušného datového zdroje. (Tímto se widget dozví, odkud získá data.)
10. Název widgetu, který se bude zobrazovat v dashboardu
11. Typ widgetu
12. Pokud je tooltip nastaven na true: Když najedete myší na každý plátek koláčového grafu v dashboardu, malý informační okno s počtem hodnot v plátku se zobrazí u vašeho kurzoru. Pokud je tooltip nastaven na false: Počítací okno se objeví v levém horním rohu widgetu.
13. Nastavení table na true vám umožňuje přepínat mezi zobrazením grafu a zobrazením tabulky na widgetu v dashboardu. Výběr false zakáže funkci přepínání mezi grafem a tabulkou.
14. Viz poznámka výše o umístění widgetů pro informace o rozvrhových řádcích.

**Widget koláč