Сервис Directum Identity Service настраивается в конфигурационном файле appsettings.json.

Структура файла:

{

  "Serilog": {
    "MinimumLevel": {
      "Default": "{Минимальный уровень логирования}",
      "Override": {
        "Microsoft.EntityFrameworkCore": "Error",
        "System": "Error"
        "Elastic.Apm": "Error"
      }
    },
    "Properties": {
      "Application": "IdentityService"
    },
    "WriteTo": [
       {
        "Name": "RollingFile",
        "Args": {
          "formatter": "IdentityService.Logger.IdentityEcsTextFormatter, IdentityService",
          "pathFormat": "{Путь до папки с лог-файлом}/{Date}.log"
        }
       }
    ]
  },
  "ConnectionStrings": {
    "DefaultConnection": "User ID={Имя пользователя};Password={Пароль};Host={Адрес};Port={Порт};Database={Имя базы данных};Pooling={Использовать пул подключений к БД};",
  },
  "ElasticApm": {
    "ServerUrls": "{Адрес сервиса Elastic APM Service}",
    "ServiceName": "{Имя сервиса в Elastic APM Service}",
    "LogLevel": "{Уровень логирования библиотеки, которая отправляет информацию о сервисе в Elastic APM Service}",
    "TransactionSampleRate": "{Регулярность отправки трейсов в сервис Elastic APM Service}",
    "SpanFramesMinDuration": "{Время, в течение которого в лог файл записывается подробная информация об ошибке обработки документа. Указывается в миллисекундах}",
    "MetricsInterval": "{Интервал сбора метрик в секундах}",
    "CaptureBody": "errors"
  },
  "Certificate": {
    "Name": "{Наименование файла сертификата}",
    "Password": "{Пароль сертификата}"
  }
}

Serilog – параметры ведения лог-файлов:

•MinimumLevel. Минимальный уровень протоколирования. Значение по умолчанию:

  "Serilog": {

    "MinimumLevel": {
      "Default": "{Минимальный уровень логирования}",
      "Override": {
        "Microsoft.EntityFrameworkCore": "Error",
        "System": "Error"
        "Elastic.Apm": "Error"
      }
    },

При указанном значении параметра в лог-файл записываются сообщения о каждом этапе обработки документа, а также ошибки, возникающие при работе сервиса.

Подробнее об изменении значения параметра см. на сервисе GitHub в документации библиотеки Serilog;

•WriteTo. Формат хранения лог-файлов, где:

•pathFormat. Путь до папки с лог-файлами.

ConnectionStrings – параметры подключения:

•DefaultConnection. Строка подключения к базе данных PostgreSQL, где:

•UserID и Password – имя и пароль пользователя для подключения к СУБД PostgreSQL. Хранятся в зашифрованном виде;

•Host – адрес СУБД PostgreSQL;

•Port – порт для подключения к СУБД PostgreSQL;

•Database – имя базы данных сервиса Identity Service;

•Pooling – признак использования пула подключений к базе данных. Возможные значения: True, False. Если установлено значение True, то для новых запросов к базе данных используется ранее созданное подключение из пула. Если установлено значение False, то каждый раз создается новое подключение. Для ускорения работы сервиса рекомендуется оставить в параметре значение по умолчанию True.

Примечание. Directum Identity Service имеет собственную базу данных, отличную от базы данных Directum Smart Service.

ElasticApm – настройка подключения к сервису Directum Elastic APM Service:

•ServerUrls. Адрес сервиса Elastic APM Service;

•ServiceName. Имя, под которым сервис Identity Service отображается в лог-файлах Elastic APM Service. Значение по умолчанию Identity Service;

•LogLevel. Уровень логирования библиотеки, которая отправляет в сервис Elastic APM Service информацию о запросах и метриках сервиса Identity Service. Значение по умолчанию Error;

•TransactionSampleRate. Регулярность отправки трейсов в Elastic APM Service. Укажите значение 1.0, если необходимо отправлять все трейсы, 0.5 – если каждый второй. Значение по умолчанию 1.0;

•SpanFramesMinDuration. Если при обработке документа возникла ошибка и время обработки превышает значение параметра, в лог-файл записывается не только факт ошибки, но и подробная информация о ней. Значение по умолчанию 0ms, при котором запись в лог-файл отключена;

•MetricsInterval. Интервал сбора метрик о состоянии памяти и CPU. Значение по умолчанию 0s, при котором метрики не собираются;

•CaptureBody. Сообщения, которые передаются в сервис Elastic APM Service. Возможные значения:

•off – сообщения не передаются;

•errors – сообщения с ошибками;

•transactions – сообщения без ошибок;

•all – все сообщения.

Значение по умолчанию errors.

Certificate – настройка сертификата для выдачи токена пользователю:

•Name. Наименование файла сертификата;

•Password. Пароль пользователя сертификата.

© Компания Directum, 2024