/domain/<DOMAIN>/alarms/ - команды управления предупреждениями
В данном разделе описываются команды управления журналом предупреждений.
Подробное описание структуры предупреждения приведено в разделе Описание структуры предупреждения или во вкладке ниже.
Описание структуры предупреждения
В таблице приведено описание структуры предупреждения.
Таблица — Структура предупреждения
Поле | Описание |
---|---|
Severity | Уровень важности предупреждения, принимает значения:
|
Origseverity | |
ID | Уникальный идентификатор предупреждения. Служебная информация |
Class | Класс предупреждения. ecss::pa::sip::user |
Domain | Имя домена. |
Instance | Экземпляр класса предупреждения. Пример: имя ноды, идентификатор call-process, название кластера, название шлюза. |
Location | Местоположение ноды, которая сгенерировала предупреждение: имя ноды, название кластера, название хоста. |
User | Имя пользователя, выставившего/сбросившего предупреждение. Системные предупреждения выставляются и сбрасываются от имени "[system]". |
Date | Дата и время возникновения предупреждения. |
Cleared | Дата и время сброса предупреждения. |
Duration | Длительность. |
Cause | Тип причины предупреждения, принимает значения:
|
Type | Тип предупреждения, принимает значения:
|
Problems | В текущей версии ПО не используется. |
BackedupStatus | В текущей версии ПО не используется. |
BackupObject | В текущей версии ПО не используется. |
Trend | Тенденция изменения важности предупреждения, принимает значения:
|
Threshold | В текущей версии ПО не используется. |
NotificationIdentifier | В текущей версии ПО не используется. |
CorrelatedNotifications | В текущей версии ПО не используется. |
StateChangeDefinition | В текущей версии ПО не используется. |
MonitoredAttributes | В текущей версии ПО не используется. |
ProposedRepairActions | Предполагаемые действия для исправления предупреждения. В текущей версии ПО не используется. |
Message | Сообщение о предупреждении. |
AdditionalInformation | Дополнительная информация |
Для администратора виртуальной АТС команды выполняются на уровне виртуальной АТС в разделе domain/<DOMAIN>/alarms/ и применяются только для определенной виртуальной АТС.
Основные команды управления аварийной сигнализацией
clear
Сброс активных предупреждений/группы предупреждений.
Путь команды:
/domain/<DOMAIN>/alarms/clear
Синтаксис:
clear all | [-l <LOCATION> -c <CLASS> -i <INSTANCE>] [ --force]
Параметры:
all - cбросить все предупреждения;
-l <LOCATION> - cбросить предупреждения, которые были сгенерированы заданной подсистемой <LOCATION>, задается в формате: node@host;
-c <CLASS> - сбросить предупреждения, принадлежащие указанному классу предупреждений <CLASS>, задается в формате: ClassName::Subclass1::...::SubclassN;
-d <DOMAIN> - сбросить предупреждения, принадлежащие указанному домену <DOMAIN>;
-i <INSTANCE> - сбросить предупреждения указанного инстанса <INSANCE>;
--force - выполнение команды без запроса подтверждения.
Пример:
Сброс всех предупреждений:
admin@ds1@ecss1:/$ domain/biysk.local/alarms/clear all [clear] Alarms will be cleared Are you sure?: [n]/y ?> y ok [exec at: 09.02.2021 10:33:27, exec time: 2s 134ms, nodes: md1@ecss1 v.3.14.7.562] Alarm list changed at 09.02.2021 10:33:28: critical: 5 major : 12
Сброс всех предупреждений, принадлежащих указанному инстансу:
admin@ds1@ecss1:/$ domain/biysk.local/alarms/clear -i ipset1:5064 --force ok [exec at: 09.02.2021 10:30:46, exec time: 14ms, nodes: md1@ecss1 v.3.14.7.562]
Сброс всех предупреждений, сгенерированных подсистемой и принадлежащих определенному классу:
admin@ds1@ecss1:/$ domain/biysk.local/alarms/clear -l megaco1@ecss1 -c ecss::pa::megaco::domain [clear] Alarms will be cleared Are you sure?: [n]/y ?> y ok [exec at: 09.02.2021 10:29:37, exec time: 3s 424ms, nodes: md1@ecss1 v.3.14.7.562] Alarm list changed at 09.02.2021 10:29:38: critical: 5 major : 13
delete
Удаление сброшенных предупреждений из системы.
Путь команды:
/domain/<DOMAIN>/alarms/delete
Синтаксис:
delete all | last <N> | before | last <DATA> [--force]
Параметры:
all - при указании команды "all" из системы удаляются все сброшенные предупреждения;
last <N> - при указании команды "last" из системы удаляются последние <N> записей журнала предупреждений;
<N> - количество записей;
Записи в журнале предупреждений отсортированы по дате, причем в последних записях информация о самых старых предупреждениях. То есть данной командой из журнала удалятся <N> самых старых сообщений.
before <DATA> - при указании команды "before" из системы удаляются все сброшенные предупреждения до заданной даты;
<DATA> - дата, по которую из журнала предупреждений будут удалены все сообщения,
задается в виде: YYYY/MM/DD HH:Mi:SS.sss либо "now" - текущая дата;
after <DATA> - при указании команды "after" из системы удаляются все сброшенные предупреждения после заданной даты;
<DATA> - дата, начиная с которой из журнала предупреждений будут удалены все сообщения,
задается в виде: YYYY/MM/DD HH:Mi:SS.sss либо "now" - текущая дата;
--force - выполнение команды без запроса подтверждения.
Пример:
Удалить все сброшенные предупреждения до 01.02.2019:
admin@ds1@ecss1:/$ domain/biysk.local/alarms/delete before 2021/02/01 00:00:00 [delete] Cleared alarms will be deleted Are you sure?: [n]/y ?> y ok [exec at: 09.02.2021 10:34:07, exec time: 2s 25ms, nodes: md1@ecss1 v.3.14.7.562]
export
Команда выгрузки/экспорта журнала предупреждений в файл.
Путь команды:
/domain/<DOMAIN>/alarms/export
Синтаксис:
export <NODE> [all|cleared] [select <COLUMN>, ... <COLUMN> [order <COLUMN> [asc|desc]]] [limit <N>] [--header] [-delim <DELIM>] [<FILENAME>]
Параметры:
<NODE> - вычислительный узел (нода);
[all|cleared] - при указании команды "all" будет экспортирована информация об всех предупреждениях (активных и сброшенных), при указании команды "cleared" будет экспортирована информация только о сброшенных предупреждениях;
[select <COLUMN>] - при указании команды "select" задается набор столбцов таблицы, экспортируемых в файл;
<COLUMN> - название колонок, задаются в виде <COLUMN> [,<COLUMN>]:
- additionalinformation - дополнительная информация;
- backedupstatus - в текущем ПО параметр не используется;
- backupobject - в текущем ПО параметр не используется;
- cause - тип причины предупреждения;
- class - класс предупреждения;
- cleared - дата и время сброса предупреждения;
- correlatednotifications - в текущем ПО параметр не используется;
- date - дата и время возникновения предупреждения;
- domain - название домена;
- duration - продолжительность предупреждения в активном состоянии;
- id - уникальный идентификатор предупреждения;
- instance - инстанс класса предупреждения;
- location - местоположение подсистемы, которая сгенерировала предупреждение;
- message - сообщение с предупреждением;
- monitoredattributes - в текущем ПО параметр не используется;
- notificationidentifier - в текущем ПО параметр не используется;
- origseverity - изначальный уровень важности предупреждения;
- problems - в текущем ПО параметр не используется;
- proposedrepairactions - предполагаемые действия для исправления предупреждения, в текущем ПО параметр не используется;
- severity - уровень важности предупреждения;
- statechangedefinition - в текущем ПО параметр не используется;
- threshold - в текущем ПО параметр не используется;
- trend - тенденция изменения важности предупреждения;
- type - тип предупреждения;
- user - имя пользователя, выставившего/сбросившего предупреждение.
order <COLUMN> - при указании "order" задается условие сортировки записей в таблице по возрастанию, где <COLUMN> - название колонки, по которой будут упорядочены записи;
limit <N> - ограничить количество экспортируемых записей, где <N> - количество записей;
--header - флаг, при указании которого экспорт предупреждений выполняется с выводом названия столбцов;
-delim <DELIM> - разделитель столбцов, который будет использоваться при формировании таблицы в файле, где по умолчанию используется символ ";".
<FILENAME> - имя файла. Каталог экспорта - /var/log/ecss/alarms/<DOMAIN>/
Пример:
admin@ds1@ecss1:/$ domain/biysk.local/alarms/export md1@ecss1 all limit 100 alarm100.csv Export is successful [exec at: 09.02.2021 10:23:31, exec time: 65ms, nodes: md1@ecss1 v.3.14.7.562]
generate-alarm
Данная команда позволяет генерировать предупреждения с заданными параметрами.
Путь команды:
/domain/<DOMAIN>/alarms/generate-alarm
Синтаксис:
generate-alarm <LOCATION> <CLASS> <SEVERITY> <TREND> <TYPE> <CAUSE> <TEXT>
Параметры:
<LOCATION> - местоположение подсистемы, которая сгенерировала предупреждение: название ноды, название кластера, название хоста;<CLASS> - класс предупреждения;
<SEVERITY> - уровень важности предупреждения, принимает значения:
- cleared - предупреждение сброшено;
- indeterminate - уровень предупреждения не определен;
- critical - в системе произошла критическая ошибка, система может работать неправильно;
- major - важный уровень предупреждения, необходимо немедленное вмешательство в систему;
- minor - незначительный уровень предупреждения, в системе произошла ошибка;
- warning - предупреждение, неаварийное сообщение;
<TREND> - тенденция изменения важности предупреждения, принимает значения:
- moreSevere - значительные изменения;
- noChange - нет изменений;
- lessSevere - небольшие изменения;
<TYPE> - тип предупреждения, принимает значения:
- other - другая причина (не была отнесена к ниже перечисленным);
- communicationsAlarm - предупреждение, связанное с коммуникациями;
- qualityOfServiceAlarm - конфигурация;
- processingErrorAlarm - предупреждение, связанное с обработкой;
- equipmentAlarm - предупреждение, связанное с оборудованием;
- environmentalAlarm - предупреждение, связанное с окружением;
- integrityViolation - предупреждение, связанное с неконсистентной информацией;
- operationalViolation - предупреждение, связанное с некорректной работой;
- physicalViolation - предупреждение, связанное с физическими нарушениями (например, выход оборудования из строя);
- securityServiceOrMechanismViolation - предупреждение, связанное с безопасностью (например, несанкционированный доступ);
- timeDomainViolation - предупреждение, связанное с возникновением несвоевременных или запрещенных событий.|
<CAUSE> - предполагаемые действия для исправления предупреждения;
<TEXT> - текст предупреждения.
Пример:
admin@ds1@ecss1:/$ domain/biysk.local/alarms/generate-alarm host-4 eal::climat major moreSevere equipmentAlarm lowTemperatue Температура АКБ ниже критической! Alarm was sent. [exec at: 09.02.2021 10:25:33, exec time: 20ms, nodes: md1@ecss1 v.3.14.7.562] Alarm list changed at 09.02.2021 10:25:34: critical: 6 major : 13
list
Команда просмотра списка активных и удаленных предупреждений виртуальной АТС с именем <DOMAIN>.
Можно определить список параметров для просмотра и их порядок в таблице.
Записи в таблице могут быть упорядочены по возрастанию по любому из столбцов.
Путь команды:
/domain/<DOMAIN>/alarms/list
Синтаксис:
list [all|cleared|domain-only|cluster-only] [select <column>, ... <column> [order <column> [asc|desc]]] [limit N]
Параметры:
[all|cleared] - при указании команды "all" на дисплей будет выведена информация об всех предупреждениях.
При указании команды "cleared" на дисплей будет выведена информация об удаленных предупреждениях.
Если не указывать команды "all" и "cleared" на дисплей будет выведена информация об активных предупреждениях.
select <COLUMN> - при указании команды "select" задается набор столбцов таблицы, выводимых на экран.
<COLUMN> - название колонок, которые будут выведены на экран, задаются в виде <column> [,<column>]:
- additionalinformation - дополнительная информация;
- backedupstatus - в текущем ПО параметр не используется;
- backupobject - в текущем ПО параметр не используется;
- cause - тип причины предупреждения;
- class - класс предупреждения;
- cleared - дата и время сброса предупреждения;
- correlatednotifications - в текущем ПО параметр не используется;
- date - дата и время возникновения предупреждения;
- domain - название домена;
- duration - продолжительность предупреждения в активном состоянии;
- id - уникальный идентификатор предупреждения;
- instance - инстанс класса предупреждения;
- location - местоположение подсистемы, которая сгенерировала предупреждение;
- message - сообщение с предупреждением;
- monitoredattributes - в текущем ПО параметр не используется;
- notificationidentifier - в текущем ПО параметр не используется;
- origseverity - изначальный уровень важности предупреждения;
- problems - в текущем ПО параметр не используется;
- proposedrepairactions - предполагаемые действия для исправления предупреждения, в текущем ПО параметр не используется;
- severity - уровень важности предупреждения;
- statechangedefinition - в текущем ПО параметр не используется;
- threshold - в текущем ПО параметр не используется;
- trend - тенденция изменения важности предупреждения;
- type - тип предупреждения;
- user - имя пользователя, выставившего/сбросившего предупреждение.
order <COLUMN> - при указании "order" задается условие сортировки записей в таблице по возрастанию, где <COLUMN> - название колонки, по которой будут упорядочены записи.
limit <N> - ограничить количество <N> выводимых записей. По умолчанию - 25. Изменить значение по умолчанию можно командой на уровне кластера, например:
admin@ds1@ecss1:/$ cluster/mediator/md1/properties/rpss/set * defaultAlarmRowLimit 30 Property "defaultAlarmRowLimit" successfully changed from: 25 to 30. [exec at: 09.02.2021 10:27:07, exec time: 148ms, nodes: md1@ecss1 v.3.14.7.562]
Пример:
admin@ds1@ecss1:/$ domain/biysk.local/alarms/list all select id, class, instance, date, location, message limit 5 ┌────────────────────┬───────────────────────────┬───────────────────────────┬───────────────────┬────────────────────┬──────────────────────────────────────────────────────────────────────────────────┐ │ ID │ Class │ Instance │ Date │ Location │ Message │ ├────────────────────┼───────────────────────────┼───────────────────────────┼───────────────────┼────────────────────┼──────────────────────────────────────────────────────────────────────────────────┤ │30363463-3463-3161-3│ecss::cluster │core1 │03.02 07:21:29 │megaco1@ecss1 │Communication core subsystem "core1" is down │ │739-343864616239 │ │ │ │ │ │ │30363463-3231-6637-3│ecss::cluster │core1 │01.02 07:25:00 │ds1@ecss1 │Communication core subsystem "core1" is down │ │939-373765363663 │ │ │ │ │ │ │30363462-6364-6264-6│ecss::cluster │sip1 │28.01 21:04:59 │ds1@ecss1 │SIP subsystem "sip1" is down │ │134-623033366665 │ │ │ │ │ │ │30363463-6364-3561-6│eal::climat │md1@ecss1 │09.02 10:25:33 │host-4 │Температура АКБ ниже критической! │ │434-656130616131 │ │ │ │ │ │ │30363463-6361-3938-3│ecss::pa::megaco::domain │"biysk.local" │09.02 07:17:10 │megaco1@ecss1 │Megaco start transport error │ │636-303535333335 │ │ │ │ │ │ └────────────────────┴───────────────────────────┴───────────────────────────┴───────────────────┴────────────────────┴──────────────────────────────────────────────────────────────────────────────────┘ Selected: 5 Total: 39 [exec at: 09.02.2021 10:27:30, exec time: 28ms, nodes: md1@ecss1 v.3.14.7.562]
Команды управления масками предупреждений
maskadd
Данной командой добавляется фильтр записей в таблице предупреждений (маска).
Путь команды:
/domain/<DOMAIN>/alarms/maskadd
Синтаксис:
maskadd all | [[-l <LOCATION>|-il <Loc1>,..,<LocN>] [-c <CLASS>|-ic <Cl1>,..,<ClN> ] [-i <INSTANCE>|-ii <Ins1>,..,<InsN>]] [-e true|false]
Параметры:
all - маскировать все предупреждения;-l - производить отбор записей по заданному местоположению подсистемы <LOCATION>, которая сгенерировала предупреждение (названия ноды, кластера, хоста);
-il - показывать все записи, кроме указанных "locations": Loc1,..,LocN;
-c - производить отбор записей по заданному классу предупреждения <CLASS>;
-ic - показывать все записи, кроме указанных классов предупреждений;
-i – производить отбор записей по заданной инстанции класса предупреждения;
-ii – показывать все записи, кроме указанных инстанций класса предупреждений;
-e - включить/выключить фильтр записей, по умолчанию фильтр включен, принимает значения:
- true - включить;
- false - выключить.
Пример:
admin@ds1@ecss1:/$ domain/biysk.local/alarms/maskadd -i call_recording ok [exec at: 09.02.2021 10:34:47, exec time: 34ms, nodes: md1@ecss1 v.3.14.7.562]
maskdel
Путь команды:
/domain/<DOMAIN>/alarms/maskdel
Командой производится удаление маски предупреждений.
Синтаксис:
maskdel all | MaskID
Параметры.
all - удалить все фильтры;
<MASKID> - идентификатор фильтра, значение "all" используется для удаления всех фильтров.
Пример:
Удалить фильтр с номером 38373365-6463-3336-6431-646565326633:
admin@ds1@ecss1:/$ domain/biysk.local/alarms/maskdel all Mask(s) successfully removed. [exec at: 09.02.2021 10:56:05, exec time: 36ms, nodes: md1@ecss1 v.3.14.7.562]
masklist
Команда для просмотра активных масок предупреждений.
Путь команды:
/domain/<DOMAIN>/alarms/masklist
Синтаксис:
masklist
Параметры:
Команда не содержит аргументов.
Пример:
admin@ds1@ecss1:/$ domain/biysk.local/alarms/masklist ┌────────────────────────────────────┬─┬──┬─┬──┬──────────────┬──┬───────────┬──┬────┬──────────────────────┐ │ ID │L│IL│C│IC│ I │II│ D │ID│ E │ Date │ ├────────────────────────────────────┼─┼──┼─┼──┼──────────────┼──┼───────────┼──┼────┼──────────────────────┤ │30363463-6364-3764-3732-636361356136│*│ │*│ │call_recording│ │biysk.local│ │true│2021.02.09 10:34:47.18│ │30363463-6364-3839-3263-343466383264│*│ │*│ │bond1.2:ТС │ │biysk.local│ │true│2021.02.09 10:37:54.80│ └────────────────────────────────────┴─┴──┴─┴──┴──────────────┴──┴───────────┴──┴────┴──────────────────────┘ Total: 2 Colunms: ID - identificator of mask L - location of alarm IL - ignore list of alarm locations C - class of alarm IC - ignore list of alarm classes I - instance of alarm II - ignore list of alarm instances D - domain of alarm ID - ignore list of alarm domains E - Enabled or disabled: true or false [exec at: 09.02.2021 10:41:37, exec time: 23ms, nodes: md1@ecss1 v.3.14.7.562]
maskmod
Данная команда позволяет модифицировать заданную маску предупреждений.
Путь команды:
/domain/<DOMAIN>/alarms/maskmod
Синтаксис:
maskmod <MASKID> all | [[-l <LOCATION>|-il <Loc1>,..,<LocN>] [-c <CLASS>|-ic <Cl1>,..,<ClN> ] [-i <INSTANCE>|-ii <Ins1>,..,<InsN>]] [-e true|false]
Параметры:
<MASKID> - идентификатор фильтра;all - маскировать все предупреждения;
-l - производить отбор записей по заданному местоположению подсистемы <Location>, которая сгенерировала предупреждение (названия ноды, кластера, хоста);
-il - показывать все записи, кроме указанных "locations": Loc1,..,LocN;
-c - производить отбор записей по заданному классу предупреждения <Class>;
-ic - показывать все записи, кроме указанных классов предупреждений;
-i – производить отбор записей по заданной инстанции класса предупреждения;
-ii – показывать все записи, кроме указанных инстанций класса предупреждений;
-e - включить/выключить фильтр записей, по умолчанию фильтр включен, принимает значения:
- true - включить;
- false - выключить.
Пример:
admin@ds1@ecss1:/$ domain/biysk.local/alarms/maskmod 30363463-6364-3839-3263-343466383264 -i bond1.2:SIP61 ok [exec at: 09.02.2021 10:42:49, exec time: 36ms, nodes: md1@ecss1 v.3.14.7.562]
masktrace
Команда трассировки маски предупреждения.
Путь команды:
/domain/<DOMAIN>/alarms/masktrace
Синтаксис:
masktrace [-l <LOCATION>] [-c <CLASS>] [-i <INSTANCE>]
Параметры:
- -l - трассировать по <LOCATION>;
Формат <location>: node_name@hostname; - -c - трассировать по <CLASS>;
Формат <CLASS>: ClassName::Subclass1::...::SubclassN; - -i - трассировать по <INSTANCE>;
Пример:
admin@ds1@ecss1:/$ domain/biysk.local/alarms/masktrace -i bond1.2:SIP61 Event will be masked by: ┌────────────────────────────────────┬─┬──┬─┬──┬─────────────┬──┬───────────┬──┬────┬──────────────────────┐ │ ID │L│IL│C│IC│ I │II│ D │ID│ E │ Date │ ├────────────────────────────────────┼─┼──┼─┼──┼─────────────┼──┼───────────┼──┼────┼──────────────────────┤ │30363463-6364-3839-3263-343466383264│*│ │*│ │bond1.2:SIP61│ │biysk.local│ │true│2021.02.09 10:42:49.65│ └────────────────────────────────────┴─┴──┴─┴──┴─────────────┴──┴───────────┴──┴────┴──────────────────────┘ Total: 1 Colunms: ID - identificator of mask L - location of alarm IL - ignore list of alarm locations C - class of alarm IC - ignore list of alarm classes I - instance of alarm II - ignore list of alarm instances D - domain of alarm ID - ignore list of alarm domains E - Enabled or disabled: true or false [exec at: 09.02.2021 10:54:54, exec time: 34ms, nodes: md1@ecss1 v.3.14.7.562]