Управление токенами

Функция детализации позволяет обновлять значения токенов и запускать динамические действия на текущем дашборде. Вместо перехода к другому поиску или дашборду, детализация может управлять значениями токенов при клике пользователя на элемент панели.

В зависимости от конфигурации панели, изменение значений токенов может привести к различным динамическим изменениям ее поведения.

Принцип работы

Управление значениями токенов является ключевым элементом создания интерактивного поведения дашборда с помощью функции детализации. Перед настройкой обновления значений токенов, необходимо спланировать желаемое поведение панели. Например, можно показывать или скрывать контент по клику пользователя. Также возможно установить значение токена, которое является частью поискового запроса, для формирования более детализированной визуализации на панели.

В детализации можно установить или изменить значения токенов по клику пользователя. Однако, само по себе изменение значений токенов не приводит к динамическому поведению панели. Для обеспечения интерактивности необходимо настроить элементы панели на реагирование на эти обновления токенов.

Шаги по настройке

Настройка по управлению токенами осуществляется по следующей инструкции:

1. На дашборде, где требуется настроить детализацию, нажать Редактировать.
2. Выбрать панель, где настраивается детализация и нажать на иконку настройки.
3. Выбрать тип ссылки Изменение токенов.
4. Настроить необходимый перечень используемых токенов.
5. Нажать Применить настройки для применения детализации.
6. Нажать Сохранить для сохранения изменений на дашборде.

Примеры

Данный дашборд представляет таблицу с количеством событий по типам действий. При клике пользователя на строку таблицы появляется дополнительная визуализация.

В редакторе детализации предусмотрена возможность настройки управления токенов для каждой панели. Для этого необходимо настроить пары "ключ-значение".

Для того, чтобы панель управления отображалась только при определенном действии пользователя, необходимо использовать атрибут depends.

{
  "label": "Последние 5 событий с действием $eventAction$",
  ...
  "depends": ["$eventAction$"]
}

На скриншоте ниже показан дашборд после того, как пользователь кликнул на тип действия logged-in в таблице.

Исходный код дашборда

    {
  "label": "Winlog: Статистика по действиям",
  "inputs": [],
  "rows": [{
      "panels": [{
          "inputs": [],
          "height": "not_set",
          "label": "Статистика по событиям пользователей",
          "type": "sm",
          "viz": {
            "options": {
              "colorRuleList": [{
                  "field": "Количество",
                  "colorScheme": "scale",
                  "pallete": "white_to_green",
                  "show": true,
                  "isBackground": true
                }, {
                  "field": "Исход",
                  "colorScheme": "field",
                  "pallete": [{
                      "value": "success",
                      "color": "#65A637"
                    }, {
                      "value": "failure",
                      "color": "#DC4E41"
                    }
                  ],
                  "show": true,
                  "isBackground": true
                }
              ],
              "tableAutoWidth": true,
              "pagination": {
                "enabled": true,
                "rowsPerPageList": [{
                    "label": "5"
                  }, {
                    "label": "10"
                  }, {
                    "label": "25"
                  }, {
                    "label": "50"
                  }
                ]
              },
              "sme": {
                "query": "source winlog_auth\r\n| aggs count by event.action.keyword\r\n| sort 0 -count\r\n| rename event.action.keyword as \"Действия\", count as \"Количество\""
              },
              "summary": {
                "enabled": false
              },
              "drilldown": {
                "enableDrilldown": true,
                "drilldownType": "tokenControl",
                "drilldownText": "/app/sm-dashboards/winlog_auth_events_journal#?_q=(eventAction:'$row.Действия$')",
                "drilldownQuery": "",
                "drilldownCustomTimeTokenEarliest": "now-24h",
                "drilldownCustomTimeTokenLatest": "now",
                "drilldownSelectTimeToken": "",
                "drilldownTokens": [{
                    "name": "$eventAction$",
                    "value": "$row.Действия$"
                  }, {
                    "name": "$count$",
                    "value": "$row.Количество$"
                  }
                ]
              },
              "timeToken": "",
              "dataTypes": {
                "Количество": {
                  "dateFormat": ""
                },
                "Исход": {
                  "dateFormat": ""
                }
              }
            },
            "timeToken": {
              "start": "now-24h",
              "end": "now"
            },
            "type": "table"
          },
          "subpanels": []
        }
      ]
    }, {
      "panels": [{
          "inputs": [{
              "name": "eventAction",
              "label": "Действие",
              "type": "selection",
              "token": {
                "prefix": "",
                "suffix": ""
              },
              "options": {
                "static": [],
                "default": "",
                "filter": {
                  "label": "",
                  "value": ""
                },
                "search": ""
              },
              "timeInput": "",
              "oldName": "eventAction"
            }
          ],
          "height": "not_set",
          "label": "Последние 5 событий с действием $eventAction$",
          "type": "sm",
          "viz": {
            "options": {
              "colorRuleList": [],
              "tableAutoWidth": true,
              "pagination": {
                "enabled": true,
                "rowsPerPageList": []
              },
              "sme": {
                "query": "source winlog_auth\r\n| search event.action.keyword=\"$eventAction$\"\r\n| table @timestamp, host.name,user.name, event.code, event.action, event.outcome\r\n| head 5\r\n| rename @timestamp as \"Время\", host.name as \"Хост\", user.name as \"Пользователь\", event.code as \"Код события\", event.action as \"Действие\", event.outcome as \"Исход\""
              },
              "summary": {
                "enabled": false
              },
              "drilldown": {
                "enableDrilldown": false,
                "drilldownType": "search",
                "drilldownText": "",
                "drilldownQuery": "",
                "drilldownCustomTimeTokenEarliest": "now-24h",
                "drilldownCustomTimeTokenLatest": "now",
                "drilldownSelectTimeToken": ""
              },
              "timeToken": ""
            },
            "timeToken": {
              "start": "now-24h",
              "end": "now"
            },
            "type": "table"
          },
          "depends": [
            "$eventAction$"
          ],
          "subpanels": []
        }
      ]
    }
  ],
  "vars": []
}