# FMPLog

interface FMPLog

Представляет логику системы логирования. Текущая реализация предполагает singleton с ограниченным управлением настройками. Настройки получаются с сервера FMP через систему политик и недоступны разработчику напрямую. Для изменения настроек логирования обратитесь к администратору проекта.

Каждая запись лога ограничена 255 символами.

#### Since

22.04.01

#### Samples

    import ru.fsight.fmp.FMP
    import ru.fsight.fmp.FMPLog
    fun main() {
       //sampleStart
       /*
     * Пример записи лога.
     */
    val log: FMPLog = fmp.log                    // Получить объект логирования.
    log.info("info message", isSensitive = true) // Записать лог с чувствительными данными.
    log.error("error message")                   // Записать лог ошибки.
       //sampleEnd
    }

## Types

Level
Link copied to clipboard
enum Level : Enum<FMPLog.Level>

Уровни логирования. ERROR включает в себя только ошибки, DEBUG включает все остальные данные и отладочную информацию. NONE отключает логирование.

Output
Link copied to clipboard
enum Output : Enum<FMPLog.Output>

Пути вывода логов. DATABASE записывает в базу данных фреймворка, JOURNAL записывает в системный журнал (logcat). Могут быть активны оба.

## Properties

isEnabled
Link copied to clipboard
abstract val isEnabled: Boolean

Включено ли логирование. Может не совпадать с уровнями отличными от Level.NONE и является приоритетным.

isLogSensitive
Link copied to clipboard
abstract val isLogSensitive: Boolean

Включено ли логирование "чувствительных" данных. Чувствительные - личные данные пользователя и данные системы, такие как логин, пароль, данные ресурсов.

level
Link copied to clipboard
abstract val level: FMPLog.Level

Текущий уровень логирования Level.

output
Link copied to clipboard
abstract val output: List<FMPLog.Output>

Список выводов логов.

## Functions

debug
Link copied to clipboard
abstract fun debug(message: String, isSensitive: Boolean = false)

Записать лог уровня Level.DEBUG.

error
Link copied to clipboard
abstract fun error(message: String, isSensitive: Boolean = false)

Записать лог уровня Level.ERROR.

info
Link copied to clipboard
abstract fun info(message: String, isSensitive: Boolean = false)

Записать лог уровня Level.INFO.

warning
Link copied to clipboard
abstract fun warning(message: String, isSensitive: Boolean = false)

Записать лог уровня Level.WARNING.