Error – добавить сообщение об ошибке в лог
<< Click to Display Table of Contents >> Объектная модель > Основные механизмы > Logger – работа с логом Error – добавить сообщение об ошибке в лог |
Метод добавляет сообщение об ошибке в лог.
Перегрузки
Error(string message) |
Добавить сообщение об ошибке в лог |
Error(Exception exception, string messageTemplate = null, params object[] templateArgs) |
Добавить сообщение об ошибке и текст исключения в лог |
Error(string messageTemplate, params object[] templateArgs) |
Добавить сообщение об ошибке в лог. Сообщение задать по шаблону с указанием параметров |
Синтаксис
C# |
public static void Error(string message); public static void Error(Exception exception, string messageTemplate = null, params object[] templateArgs); public static void Error(string messageTemplate, params object[] templateArgs); |
Параметры
string – сообщение об ошибке;
exception – исключение;
messageTemplate – шаблон сообщения;
templateArgs – параметры шаблона сообщения. В параметрах рекомендуется указывать простые типы данных, например, string, bool. Имена параметров должны состоять из букв латинского алфавита и цифр. Рекомендуется использовать только одно слово и не использовать пробелы, скобки и другие символы.
Пример 1. Добавить в лог сообщение об ошибке и текст исключения
try
{
throw new Exception("Open error");
}
catch (Exception ex)
{
Logger.Error(ex, "Не удалось подготовить данные для выгрузки");
}
Сообщение об ошибке записывается в лог-файл в атрибут mt, а исключение – в атрибут ex:
{
...
"mt": "Не удалось подготовить данные для выгрузки",
"ex": {
"type": "System.Exception",
"m": "Open error",
"stack": "…"
...
}
Пример 2. Добавить в лог сообщение с параметрами
Чаще всего необходимо логировать сообщение и другие данные, значения которых содержатся в переменных. Для этого в методе Error() нужно передавать первым аргументом шаблон сообщения messageTemplate, и затем список его параметров.
Logger.Error("Ошибка при открытии документа {id}", _obj.Id);
Шаблон сообщения messageTemplate записывается в лог-файл в атрибут mt. При логировании шаблон не меняется, в фигурных скобках содержатся только имена параметров, а не их значения. Сами параметры преобразуются в ключи атрибута args.
{
...
"l": "Error",
"lg": "Logger",
"mt": "Ошибка при открытии документа {id}",
"args": {
"id": 785,
},
...
}
© Компания Directum, 2024 |