Configuration JSON
На странице представлена информация о форматировании конфигураций. Все конфигурации необходимо сохранять и обновлять в формате JSON.
У JSON конфигурации есть обязательные поля, а также поле, которое считается идентификатором конфигурации. Если у конфигурации указаны обязательные поля, они обязательно должны присутствовать при сохранении, даже если допустимы любые поля. Если поле-идентификатор отличается от _id, оно автоматически дублируется в конфигурацию. В этом случае, сохранится конфигурация с определенным идентификатором и указанным полем-идентификатором со значением идентификатора. При запросе обновления необходимо, чтобы это поле и параметр {config_id}
совпадали. В таблице ниже указано, в каком индексе хранится конфигурация, допустимо ли сохранять любые поля, не указанные в обязательных и дополнительных, а также привязаны ли к конфигурациям тэги.
Таблица характеристик конфигураций
Название | Индекс | Поле-идентификатор | Обязательные поля | Дополнительные поля | Допустимы любые поля | С тэгами |
---|---|---|---|---|---|---|
lookups | .sm_sme_lookups | name | idx , fields | condition , sourcetype , limit , wildcards , case_sensitive , cidrmatch | - | + |
db | .sm_sme_db | connection_name | connection_string , driver_class , driver_file | - | + | + |
db_queries | .sm_sme_db_queries | name | query | - | - | + |
dashboards | .sm_dashboards | _id | yaml | - | + | + |
scripts | .sm_sme_scripts | _id | argumentsCount , script , description , type | alias | - | - |
tags | .sm_sme_tags | _id | - | - | + | - |
search_favorites | .sm_search_favorite | _id | query , historyQueryId , user | - | - | - |
search_histories | .sm_search_history | _id | query , timestamp , user | - | - | - |
search_anywhere_sources | .sm_sme_search_anywhere_sources | _id | source_type | server , port , user , path_to_trust_store , trust_store_password , password , connection_string , connection_url | - | + |
persons | .sm_persons | _id | - | - | + | - |
Дополнительные особенности
Поля fields
, wildcards
, case_sensitive
, cidrmatch
в lookups передаются как массив строк.
Поле type
в scripts
может быть только internal
, external
или system
.
Если в конфигурации указано поле password
, оно будет храниться и отображаться в зашифрованном виде.