Определение пользовательских свойств объектов мониторинга#

В продукте предусмотрена возможность определения пользовательских свойств объектов мониторинга.

Чтобы воспользоваться этой функцией, необходимо задекларировать набор дополнительных свойств (обычно эта операция выполняется однократно при развертывании системы).

После определения пользовательские свойства становятся доступны в Оперативном центре для отображения, группировки и поиска.

Для уже существующих объектов мониторинга в Kintsugi значения у пользовательских свойств будут отсутствовать. Чтобы получить возможность работать с новыми данными, нужно воспользоваться API-вызовом.

Последовательность выполнения#

Для определения пользовательских свойств объектов мониторинга Оперативного центра:

1. Выполните подключение к БД meta:

   psql -h <host.example> -p <port.example> -U <user.example> kintsugi.example.test
   

   Описание параметров:

   • <host.example> – адрес базы данных метаинформации;

   • <port.example> – порт базы данных;

   • <user.example> – имя пользователя;

   • kintsugi.example.test – база данных метаинформации.

2. Выполните команду запуска хранимых процедур для определения пользовательских свойств объектов мониторинга.

   Пример запуска хранимых процедур:

       BEGIN;
   
       \set declare_json `cat custom_property_declarations.json`
       CALL declare_asset_custom_properties(:'declare_json'::JSONB);
   
       COMMIT;
   

   Примечание

   При возникновении ошибки в результате выполнения команды проверьте правильность заполнения параметров в asset_selector файла custom_property_values.json.

   Декларация пользовательских свойств описана ниже.

3. Откройте в Kintsugi вкладку Оперативный центр и проверьте наличие созданных пользовательских свойств в поле Группировка и в табличных данных.

Результат#

Пользовательские свойства объектов мониторинга Оперативного центра определены.

Декларация пользовательских свойств#

Для декларации пользовательских свойств необходимо создать файл custom_property_declarations.json со следующей структурой:

{
    "bundle_type": "asset_custom_property_declarations",
    "declare_properties": [
        {
            "property_key": "custom_property_a",
            "title": {
                "ru": "Свойство А",
                "en": "Property A"
            },
            "description": {
                "ru": "Свойство А - описание",
                "en": "Property A - description"
            }
        },
        {
            "property_key": "custom_property_b",
            "title": {
                "ru": "Свойство B",
                "en": "Property B"
            },
            "description": {
                "en": "Свойство B - описание",
                "en": "Property B - description"
            }
        },
        {
            "property_key": "custom_property_c",
            "title": {
                "ru": "Свойство C",
                "en": "Property C"
            },
            "description": {
                "ru": "Свойство C - описание",
                "en": "Property C - description"
            }
        }
    ]
}

Описание параметров:

• property_key – уникальный ключ пользовательского свойства;

• title – название пользовательского свойства;

• description – описание пользовательского свойства.

Требования к синтаксису property_key:

• может содержать строчные буквы (a-z), цифры (0-9) и знаки подчеркивания (_);

• должен начинаться с префикса custom_;

• первый символ после префикса должен быть буквой;

• должен содержать хотя бы 4 символа после префикса;

• общая длина (вместе с префиксом) не должна быть более 64 символов.