/cluster/mediator/<MEDIATOR>/alarms/ — команды управления аварийной сигнализацией
В данном разделе описываются команды управления аварийной сигнализацией.
Подробное описание структуры предупреждения приведено в разделе Описание структуры предупреждения или во вкладке ниже.
Описание структуры предупреждения
В таблице приведено описание структуры предупреждения.
Таблица — Структура предупреждения
Поле | Описание |
---|---|
ID | Уникальный идентификатор предупреждения. Служебная информация |
Class | Класс предупреждения. ecss::pa::sip::user |
Instance | Экземпляр класса предупреждения. Пример: имя ноды, идентификатор call-process, название кластера, название шлюза. |
Location | Местоположение ноды, которая сгенерировала предупреждение: имя ноды, название кластера, название хоста. |
User | Имя пользователя, выставившего/сбросившего предупреждение. Системные предупреждения выставляются и сбрасываются от имени "[system]". |
Date | Дата и время возникновения предупреждения. |
Cleared | Дата и время сброса предупреждения. |
Cause | Тип причины предупреждения, принимает значения:
|
Type | Тип предупреждения, принимает значения:
|
Problems | В текущей версии ПО не используется. |
Severity | Уровень важности предупреждения, принимает значения:
|
BackedupStatus | В текущей версии ПО не используется. |
BackupObject | В текущей версии ПО не используется. |
Trend | Тенденция изменения важности предупреждения, принимает значения:
|
Threshold | В текущей версии ПО не используется. |
NotificationIdentifier | В текущей версии ПО не используется. |
CorrelatedNotifications | В текущей версии ПО не используется. |
StateChangeDefinition | В текущей версии ПО не используется. |
MonitoredAttributes | В текущей версии ПО не используется. |
ProposedRepairActions | Предполагаемые действия для исправления предупреждения. В текущей версии ПО не используется. |
Message | Сообщение о предупреждении |
AdditionalInformation | Дополнительная информация |
Для администратора системы команды выполняются на уровне кластера в разделе /cluster/mediator/<CLUSTER>/alarms/.
Для администратора виртуальной АТС команды выполняются на уровне виртуальной АТС в разделе /domain/<DOMAIN>/alarms/ и применяются только для определенной виртуальной АТС. Описание команд приведено в разделе /domain/<DOMAIN>/alarms.
<CLUSTER> — имя кластера с ролью MEDIATOR.
Основные команды управления аварийной сигнализацией
clear
Сброс активных предупреждений/группы предупреждений.
Путь команды:
/cluster/mediator/<CLUSTER>/alarms/clear
Синтаксис:
clear all | [-l <LOCATION> -c <CLASS> -i <INSTANCE> d <DOMAIN>] [ --force]
Параметры:
all — cбросить все предупреждения;
-l <LOCATION> — cбросить предупреждения, которые были сгенерированы заданной подсистемой <LOCATION>, задается в формате: node@host;
-c <CLASS> — сбросить предупреждения, принадлежащие указанному классу предупреждений <CLASS>, задается в формате: ClassName::Subclass1::...::SubclassN;
-d <DOMAIN> — сбросить предупреждения, принадлежащие указанному домену <DOMAIN>;
-i <INSTANCE> — сбросить предупреждения указанного инстанса <INSANCE>;
--force — выполнение команды без запроса подтверждения.
Пример:
Сброс всех предупреждений:
admin@mycelium1@ecss1:/$ cluster/mediator/md1/alarms/clear all [clear] Alarms will be cleared Are you sure?: [n]/y ?> y ok [exec at: 15.02.2021 15:25:30, exec time: 2s 32ms, nodes: md1@ecss1 v.3.14.7.578] No more active alarms
Сброс всех предупреждений, принадлежащих указанному инстансу:
admin@mycelium1@ecss1:/$ cluster/mediator/md1/alarms/clear -i bond1.2:SIP61 [clear] Alarms will be cleared Are you sure?: [n]/y ?> y ok [exec at: 15.02.2021 15:24:53, exec time: 3s 166ms, nodes: md1@ecss1 v.3.14.7.578] Alarm list changed at 15.02.2021 15:24:54: critical: 22 major : 35
Сброс всех предупреждений, сгенерированных подсистемой:
admin@mycelium1@ecss1:/$ cluster/mediator/md1/alarms/clear -l md1@ecss1 [clear] Alarms will be cleared Are you sure?: [n]/y ?> y ok [exec at: 15.02.2021 14:54:13, exec time: 2s 28ms, nodes: md1@ecss1 v.3.14.7.578] Alarm list changed at 15.02.2021 14:54:15: critical: 23 major : 35
Сброс всех предупреждений, принадлежащих определенному классу:
admin@mycelium1@ecss1:/$ cluster/mediator/md1/alarms/clear -c ecss::cluster::node [clear] Alarms will be cleared Are you sure?: [n]/y ?> y ok [exec at: 15.02.2021 14:27:01, exec time: 2s 853ms, nodes: md1@ecss1 v.3.14.7.578] Alarm list changed at 15.02.2021 14:27:02: critical: 25 major : 36
delete
Удаление сброшенных предупреждений из системы.
Путь команды:
/cluster/mediator/<CLUSTER>/alarms/delete
Синтаксис:
delete all|last <N>|before <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 — выполнение команды без запроса подтверждения.
Пример:
Удалить 5 последних предупреждений:
admin@mycelium1@ecss1:/$ cluster/mediator/md1/alarms/delete last 5 [delete] Cleared alarms will be deleted Are you sure?: [n]/y ?> y ok [exec at: 15.02.2021 09:03:21, exec time: 2s 693ms, nodes: md1@ecss1 v.3.14.7.578]
export
Команда выгрузки/экспорта журнала предупреждений в CSV - файл.
Путь команды:
/cluster/mediator/<CLUSTER>/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/.
Пример:
admin@mycelium1@ecss1:/$ cluster/mediator/md1/alarms/export md1@ecss1 all limit 10 alarms_last_10.csv Export is successful [exec at: 15.02.2021 09:18:15, exec time: 64ms, nodes: md1@ecss1 v.3.14.7.578]
generate-alarm
Данная команда позволяет генерировать предупреждения с заданными параметрами.
Обратите внимание, что дважды по одному и тому же параметру дважды ошибка не создается.
Путь команды:
/cluster/mediator/<CLUSTER>/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@mycelium1@ecss1:/$ cluster/mediator/md1/alarms/generate-alarm ecss1 hw:error critical noChange equipmentAlarm powerProblem Power off Alarm was sent. [exec at: 15.02.2021 15:29:54, exec time: 5ms, nodes: md1@ecss1 v.3.14.7.578] Alarm list changed at 15.02.2021 15:29:55: critical: 1
list
Команда просмотра списка активных и удаленных предупреждений системы и виртуальных АТС .
Можно определить список параметров для просмотра и их порядок в таблице.
Записи в таблице могут быть упорядочены по возрастанию по любому из столбцов.
Путь команды:
/cluster/mediator/<CLUSTER>/alarms/list
Синтаксис:
list [all|cleared] [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 — тенденция изменения важности предупреждения;
- user — имя пользователя, выставившего/сбросившего предупреждение;
- type — тип предупреждения;
order <COLUMN> — при указании "order" задается условие сортировки записей в таблице по возрастанию, где <COLUMN> — название колонки, по которой будут упорядочены записи.
limit <N> — ограничить количество <N> выводимых записей. По умолчанию — 25. Изменить значение по умолчанию можно командой set:
/cluster/mediator/<some_mediator_cluster>/properties/rpss/set * defaultAlarmRowLimit 30
Пример:
admin@mycelium1@ecss1:/$ cluster/mediator/md1/alarms/list select date, location, cause, instance limit 5 ┌────────────────────────────────────────┬───────────────────────────────────────────┬─────────────────────────────────────────────────────────┬─────────────────────────────────────────────────────────┐ │ Date │ Location │ Cause │ Instance │ ├────────────────────────────────────────┼───────────────────────────────────────────┼─────────────────────────────────────────────────────────┼─────────────────────────────────────────────────────────┤ │10.02 07:36:26 │sip1@ecss1 │outOfService │ipset1:5071 │ │11.02 16:46:06 │ds1@ecss1 │softwareError │ds1@ecss1 │ │10.02 07:36:26 │sip1@ecss1 │outOfService │ipset1:5062 │ │10.02 07:36:26 │sip1@ecss1 │outOfService │ipset1:5060 │ │12.02 14:51:43 │core1@ecss1 │softwareProgramAbnormallyTerminated │mycelium1@ecss2 │ └────────────────────────────────────────┴───────────────────────────────────────────┴─────────────────────────────────────────────────────────┴─────────────────────────────────────────────────────────┘ Selected: 5 Total: 58 [exec at: 12.02.2021 15:49:18, exec time: 24ms, nodes: md1@ecss1 v.3.14.7.566]
res-cleanup
Команда очистки занимаемых ресурсов.
Путь команды:
/cluster/mediator/<CLUSTER>/alarms/res-cleanup
Синтаксис:
res-cleanup
Параметры:
Команда не содержит аргументов.
Пример:
admin@mycelium1@ecss1:/$ cluster/mediator/md1/alarms/res-cleanup ok [exec at: 15.02.2021 15:27:15, exec time: 47ms, nodes: md1@ecss1 v.3.14.7.578]
Команды управления масками предупреждений
maskadd
Данной командой добавляется фильтр записей в таблице предупреждений (маска).
Путь команды:
/cluster/mediator/<CLUSTER>/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 — показывать все записи, кроме указанных инстанций класса предупреждений;
-d — производить отбор записей по заданному домену (только для команды /cluster/mediator/<CLUSTER>/alarms/maskadd
);
-id — показывать все записи по всем доменам, кроме заданного домена (только для команды /cluster/mediator/<CLUSTER>/alarms/maskadd
);
-e — включить/выключить фильтр записей, по умолчанию фильтр включен, принимает значения:
- true — включить;
- false — выключить.
Пример:
admin@mycelium1@ecss1:/$ cluster/mediator/md1/alarms/maskadd -c ecss::bus::amqp::connection ok [exec at: 15.02.2021 15:49:41, exec time: 27ms, nodes: md1@ecss1 v.3.14.7.578]
maskdel
Командой производится удаление маски предупреждений.
Путь команды:
/cluster/mediator/<CLUSTER>/alarms/maskdel
Синтаксис:
maskdel <MASKID>
Параметры.
all — удалить все фильтры;
<MASKID> — идентификатор фильтра, значение "all" используется для удаления всех фильтров.
Пример:
Удалить фильтр с номером 30363464-3563-3538-3763-346638316438 :
admin@mycelium1@ecss1:/$ cluster/mediator/md1/alarms/maskdel 30363464-3563-3538-3763-346638316438 Mask(s) successfully removed. [exec at: 15.02.2021 15:54:31, exec time: 36ms, nodes: md1@ecss1 v.3.14.7.578]
masklist
Команда для просмотра активных масок предупреждений.
Путь команды:
/cluster/mediator/<CLUSTER>/alarms/masklist
Синтаксис:
masklist
Параметры:
Команда не содержит аргументов.
Пример:
admin@mycelium1@ecss1:/$ cluster/mediator/md1/alarms/masklist ┌────────────────────────────────────┬─┬──┬───────────────────────────┬──┬─┬──┬─┬──┬────┬──────────────────────┐ │ ID │L│IL│ C │IC│I│II│D│ID│ E │ Date │ ├────────────────────────────────────┼─┼──┼───────────────────────────┼──┼─┼──┼─┼──┼────┼──────────────────────┤ │30363464-3563-3538-3763-346638316438│*│ │ecss::bus::amqp::connection│ │*│ │*│ │true│2021.02.15 15:37:27.80│ └────────────────────────────────────┴─┴──┴───────────────────────────┴──┴─┴──┴─┴──┴────┴──────────────────────┘ 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: 15.02.2021 15:41:59, exec time: 22ms, nodes: md1@ecss1 v.3.14.7.578]
maskmod
Данная команда позволяет модифицировать заданную маску предупреждений.
Путь команды:
/cluster/mediator/<CLUSTER>/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 — показывать все записи, кроме указанных инстанций класса предупреждений;
-d — производить отбор записей по заданному домену (только для команды /cluster/mediator/<CLUSTER>/alarms/maskmod
);
-id — показывать все записи по всем доменам, кроме заданного домена (только для команды /cluster/mediator/<CLUSTER>/alarms/maskmod
);
-e — включить/выключить фильтр записей, по умолчанию фильтр включен, принимает значения:
- true — включить;
- false — выключить.
Пример:
admin@mycelium1@ecss1:/$ cluster/mediator/md1/alarms/maskmod 30363464-3563-3538-3763-346638316438 -e true ok [exec at: 15.02.2021 15:52:30, exec time: 30ms, nodes: md1@ecss1 v.3.14.7.578]
masktrace
Команда трассировки маски предупреждения.
Путь команды:
/cluster/mediator/<CLUSTER>/alarms/masktrace
Синтаксис:
modtrace [-l <LOCATION>] [-c <CLASS>] [-i <INSTANCE>]
Параметры:
- -l — трассировать по <LOCATION>;
Формат <location>: node_name@hostname; - -c — трассировать по <CLASS>;
Формат <CLASS>: ClassName::Subclass1::...::SubclassN; - -i — трассировать по <INSTANCE>;
- -d — трассировать по <DOMAIN> (только для команды
/cluster/mediator/<CLUSTER>/alarms/modtrace
);
Пример:
admin@mycelium1@ecss1:/$ cluster/mediator/md1/alarms/masktrace -c ecss::bus::amqp::connection Event will be masked by: ┌────────────────────────────────────┬─┬──┬───────────────────────────┬──┬─┬──┬─┬──┬────┬──────────────────────┐ │ ID │L│IL│ C │IC│I│II│D│ID│ E │ Date │ ├────────────────────────────────────┼─┼──┼───────────────────────────┼──┼─┼──┼─┼──┼────┼──────────────────────┤ │30363464-3563-3538-3763-346638316438│*│ │ecss::bus::amqp::connection│ │*│ │*│ │true│2021.02.15 15:52:30.49│ └────────────────────────────────────┴─┴──┴───────────────────────────┴──┴─┴──┴─┴──┴────┴──────────────────────┘ 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: 15.02.2021 15:52:38, exec time: 27ms, nodes: md1@ecss1 v.3.14.7.578]