Добавить в РЭ: управление журналированием плат VE-01 и VE-02

[alx]

Начиная с прошивки ревизии 52 платы VE-01 и ревизии 8 платы VE-02 исполнения 1 появилась возможность изменять настройки журналирования плат "на лету" через веб-интерфейс.

В диалоге настройки этих плат в панели "Управление платой" на вкладке "Настройки" появилась кнопка "Журналирование". При ее нажатии открывается диалог настроек журналирования. В нем есть две настройки:

• Приоритет журналирования;
• Режим журналирования.

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

Режим журналирования позволяет выбрать, где ведется журнал: при выборе опции "буфер" - в буфере в ОЗУ платы, при выборе опции "файл" - в файле /www/messages в ПЗУ платы.

Следует отметить, что настройки логгирования хранятся в ПЗУ конкретной платы (VE-01 или VE-02), а не в файле конфигурации блока, находящемся в плате SW-01. При нажатии "OK" в диалоге настроек журналирования эти настройки немедленно записываются в плату и начинают действовать (не требуется после этого нажимать "Применить" или "OK" в диалоге настроек платы), также не требуется перезагружать плату.

Необходимо добавить эту информацию в РЭ.

[alx]

В соответствии с устной договоренностью пишу значения приоритетов журналирования.

/*
 * priorities/facilities are encoded into a single 32-bit quantity, where the
 * bottom 3 bits are the priority (0-7) and the top 28 bits are the facility
 * (0-big number).  Both the priorities and the facilities map roughly
 * one-to-one to strings in the syslogd(8) source code.  This mapping is
 * included in this file.
 *
 * priorities (these are ordered)
 */
#define LOG_EMERG       0       /* system is unusable */
#define LOG_ALERT       1       /* action must be taken immediately */
#define LOG_CRIT        2       /* critical conditions */
#define LOG_ERR         3       /* error conditions */
#define LOG_WARNING     4       /* warning conditions */
#define LOG_NOTICE      5       /* normal but significant condition */
#define LOG_INFO        6       /* informational */
#define LOG_DEBUG       7       /* debug-level messages */

[alx]

Обнаружил ошибку в описании тикета - было указано "минимальный" вместо "максимальный". Исправил.

[Vladimir]

Для русскоязычного Руководства лучше бы все пояснения указывать по-русски...
Я недостаточно хорошо знаю английский (также, как и большинство пользователей МС04),
поэтому лучше, чтобы кто-то, например, alx правильно перевёл значения приоритетов на русский.

[Vladimir]

Вот перевод, который сделал Яндекс:

Меню "Приоритет журналирования" позволяет выбрать следующие приоритеты:
– EMERG – система непригодна для использования
– ALERT – необходимо немедленно принять меры
– CRIT – критическое состояние
– ERR – условия возникновения ошибок
– WARNING – условия предупреждения
– NOTICE – нормальное, но значительное состояние
– IINFO – информационный
– DEBUG – сообщения уровня отладки

Кто сможет отредактировать этот перевод?

[alx]

В соответствии с устной договоренностью привожу свои варианты перевода приоритетов:

– EMERG – система непригодна для использования
– ALERT – сообщения, требующие немедленного принятия мер
– CRIT – критические сообщения
– ERR – сообщения об ошибках
– WARNING – предупреждения
– NOTICE – важные сообщения при нормальной работе
– IINFO – информационные сообщения
– DEBUG – отладочные сообщения

[Vladimir]

Ну вот, твой перевод гораздо лучше, чем у Яндекса!

Тогда текст про приоритеты будет такой:

"Приоритет журналирования устанавливает максимальный приоритет сообщений, попадающих в журнал и, таким образом, позволяет устанавливать степень подробности ведения журнала (например, если выбран максимальный приоритет NOTICE, то в журнал будут записаны сообщения NOTICE и все следующие сообщения по списку приоритетов: INFO, DEBUG):

Меню "Приоритет журналирования" позволяет выбрать следующие приоритеты:

– EMERG – система непригодна для использования
– ALERT – сообщения, требующие немедленного принятия мер
– CRIT – критические сообщения
– ERR – сообщения об ошибках
– WARNING – предупреждения
– NOTICE – важные сообщения при нормальной работе
– INFO – информационные сообщения
– DEBUG – отладочные сообщения
"

Теперь все согласны с таким текстом?

[san]

Только всё наоборот)
Если установить NOTICE, то в журнал попадут:

EMERG,ALERT, CRIT, ERR, WARNING, NOTICE

[san]

Андрей, помогай)

[andrei]

Предлагаю настройку Приоритет журналирования переименовать в Фильтр событий.
Настройка Фильтр событий указывает какие события будут сохраняться в журнал. Соответствие записываемых событий значению настройки приведено в таблице.

Таблица

События\настройка	EMERG	ALERT	CRIT	ERR	WARNING	NOTICE	INFO	DEBUG
система непригодна для использования	•	•	•	•	•	•	•	•
сообщения, требующие немедленного принятия мер		•	•	•	•	•	•	•
критические сообщения			•	•	•	•	•	•
сообщения об ошибках				•	•	•	•	•
предупреждения					•	•	•	•
важные сообщения при нормальной работе						•	•	•
информационные сообщения							•	•
отладочные сообщения								•

[alx]

Replying to Vladimir:

"Приоритет журналирования устанавливает максимальный приоритет сообщений, попадающих в журнал и, таким образом, позволяет устанавливать степень подробности ведения журнала (например, если выбран максимальный приоритет NOTICE, то в журнал будут записаны сообщения NOTICE и все следующие сообщения по списку приоритетов: INFO, DEBUG):

...

Теперь все согласны с таким текстом?

Теперь я не согласен, так как этот текст неправильный - не соответствует действительности и противоречит сам себе. А именно, неверен в этом тексте приведенный пример. При установке параметра "Приоритет журналирования" в значение "NOTICE", в журнал будут выводиться сообщения с приоритетами EMERG, ALERT, CRIT, ERR, WARNING и NOTICE. Сообщения же с приоритетами INFO и DEBUG как раз выводиться в журнал не будут, так как их приоритет больше установленного параметром максимального значения.

[Vladimir]

Replying to andrei:

Предлагаю настройку Приоритет журналирования переименовать в Фильтр событий.
Настройка Фильтр событий указывает какие события будут сохраняться в журнал. Соответствие записываемых событий значению настройки приведено в таблице.

Если SAN и ALX согласны заменить на Рис. 7.10 Настройки журналирования слова
Приоритет журналирования на слова Фильтр событий, то пусть пришлют обновлённый рисунок и я заменю этот рисунок в РЭ-41, и изменю текст к этому рисунку.

Как вариант предлагаю изменить текст к существующему рисунку так:
"Приоритет журналирования устанавливает приоритет сообщений, попадающих в журнал и, таким образом, позволяет устанавливать степень подробности ведения журнала (например, если выбран приоритет NOTICE, то в журнал будут записаны сообщения NOTICE и все предыдущие сообщения по списку приоритетов: EMERG, ALERT, CRIT, ERR, WARNING и NOTICE):"

Если не нравится слово "предыдущие сообщения" то можно записать "вышестоящие сообщения по списку..."

[san]

Не вижу необходимости переобзывать настройку.

С предложением Vladimir согласен. И "предыдущие сообщения" действительно не нравится, "вышестоящие ..." подойдёт.

[Vladimir]

В РЭ-41 большинством голосов Разработчиков принят вариант:

"Рис. 7.10 Настройки журналирования

Меню Приоритет журналирования позволяет выбрать следующие приоритеты:

– EMERG – система непригодна для использования
– ALERT – сообщения, требующие немедленного принятия мер
– CRIT – критические сообщения
– ERR – сообщения об ошибках
– WARNING – предупреждения
– NOTICE – важные сообщения при нормальной работе
– INFO – информационные сообщения
– DEBUG – отладочные сообщения

"Приоритет журналирования" устанавливает приоритет сообщений, попадающих в журнал и, таким образом, позволяет устанавливать степень подробности ведения журнала (например, если выбран приоритет NOTICE, то в журнал будут записаны сообщения NOTICE и все вышестоящие сообщения по списку приоритетов: EMERG, ALERT, CRIT, ERR, WARNING и NOTICE).

"

[alx]

В тексте РЭ редакции 41 параметр "Приоритет журналирования" описан следующим образом:

Приоритет журналирования устанавливает приоритет сообщений, попадающих в журнал и, таким образом, позволяет устанавливать степень подробности ведения журнала (например, если выбран приоритет NOTICE, то в журнал будут записаны сообщения NOTICE и все вышестоящие сообщения по списку приоритетов: EMERG, ALERT, CRIT, ERR, WARNING и NOTICE).

В процитированном фрагменте есть один существенный недостаток: здесь написано, то параметр влияет на то, какие сообщения попадают в журнал, а какие - нет, но как именно он на это влияет, по каким правилам - не разъясняется. Некоторая дополнительная информация (о том, что все вышестоящие приоритеты также попадают в журнал) есть в приведенном в скобках примере, но, так как это лишь пример настройки, читатель не может быть уверен в том, что этот же принцип будет действовать и при установке других значений параметров.

Предлагаю уточнить описание параметра, сообщив, что в журнал выводятся все сообщения с приоритетом равным установленному или более высоким. Чтобы не возникало вопрсоов о том, какой приоритет выше, а какой ниже, предлагаю также уточнить выше по тексту, где приводится список возможных значений приоритета, что приоритеты в списке указаны в порядке их понижения (от высшего к низшему).

[Vladimir]

Согласно Комм-15 сразу после списка "Меню Приоритет журналирования"
в РЭ-52 от сего дня добавил и изменил текст в п."7.2 Настройки платы VE-01":

"Приоритеты в списке указаны в порядке их понижения (от высшего к низшему).

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

[san]

Milestone deleted