FMPLog

Описание

Класс FMPLog предназначен для работы с логами.

class FMPLog

Свойства

Свойство Описание
isFetchScheduleEnabled Индикатор статуса расписания получения политики логирования.
var isFetchScheduleEnabled: Bool { get }
isSendLogsScheduleEnabled Индикатор статуса расписания отправки логов.
var isSendLogsScheduleEnabled: Bool { get }
isSensitiveDataEnabled Флаг, который определяет, включена ли запись чувствительных данных.
var isSensitiveDataEnabled: Bool { get }

level

Уровень логирования.
var level: Level? { get }
output Месторасположение записи логов.
var output: Output? { get }

Методы

Метод Описание
copy() Получение экземпляра класса-строителя для копирования FMPLog. Возвращает экземпляр класса-строителя FMPLog.Builder.
func copy() -> FMPLog.Builder

debug(_:)

Запись сообщения в журнал. В базу данных записывается информация, полезная пользователю SDK (статистика, ключевые настройки, статус старта/остановки и т.д.). Уровень логирования соответствует значению FMPLog.Level.debug. Если текущий уровень логирования больше, то сообщение не обрабатывается.
func debug(_ text: String) throws

Параметры:

  • text. Текст сообщения.

error(_:) Запись сообщения в журнал. В базу данных записывается ошибка, после которой приложение может работать, но результаты могут быть неожиданными. Уровень логирования соответствует значению FMPLog.Level.error. Если текущий уровень логирования больше, то сообщение не обрабатывается.
func error(_ text: String) throws

Параметры:

  • text. Текст сообщения.

info(_:) Запись сообщения в журнал. В базу данных записывается полезная информация (старт/остановка сервиса, конфигурирование и др.). Уровень логирования соответствует значению FMPLog.Level.info. Если текущий уровень логирования больше, то сообщение не обрабатывается.
func info(_ text: String) throws

Параметры:

  • text. Текст сообщения.

warning(_:) Запись сообщения в журнал. В базу данных записываются предупреждения, в которых содержится информация о том, что пользователю/разработчику следует обратить внимание на результат работы приложения. Уровень логирования соответствует значению FMPLog.Level.warning. Если текущий уровень логирования больше, то сообщение не обрабатывается.
func warning(_ text: String) throws

Параметры:

  • text. Текст сообщения.

Примеры

Просмотр настроек логирования:

// Построим экземпляр класса FMPLog
let log: FMPLog = fmp.log.build()
 
// Получим уровень логирования
let level = log.level
 
// Получим место вывода логов
let output = log.output
 
// Получим признак необходимости записывать чувствительные данные
let isSensitiveDataEnabled = log.isSensitiveDataEnabled
 
// Получим статус расписания получения политики
let isFetchScheduleEnabled = log.isFetchScheduleEnabled
 
// Получим статус расписания отправки логов
let isSendLogsScheduleEnabled = log.isSendLogsScheduleEnabled

Запись пользовательских логов:

// Построим экземпляр класса FMPLog
let log: FMPLog = fmp.log.build()
  
// Запишем отладочную информацию
do {
    try log.debug("debug text")
} catch let error {
    // Выведем код и описание ошибки
    print((response.error as? FMPError)?.code, (response.error as? FMPError)?.description)
}
 
// Запишем полезную информацию
do {
    try log.info("info text")
} catch let error {
    // Выведем код и описание ошибки
    print((response.error as? FMPError)?.code, (response.error as? FMPError)?.description)
}
 
// Запишем предупреждение
do {
    try log.warning("warning text")
} catch let error {
    // Выведем код и описание ошибки
    print((response.error as? FMPError)?.code, (response.error as? FMPError)?.description)
}
 
// Запишем ошибку
do {
    try log.error("error text")
} catch let error {
    // Выведем код и описание ошибки
    print((response.error as? FMPError)?.code, (response.error as? FMPError)?.description)
}

См. также:

Фреймворк FMPKit | Классы