Функция log

Содержание

• Введение
• C++ API
• JavaScript API
  • log(message: string): void
  • log(section: string, message: string): void
  • log(section: string, traceId: string, message: string): void
  • log.err(...)
  • log.warn(...)
  • log.info(...)
  • log.debug(...)
• Использование пользовательских провайдеров логирования
• Разработка пользовательских провайдеров логирования

Введение

Логирование — базовое требование для создания сервисов. API логирования napajs позволяет разработчикам интегрировать собственные возможности логирования как в JavaScript, так и в C++ (аддон).

Строка журнала может содержать следующую информацию:

• (Необязательно) Раздел: полезное поле для фильтрации строк журнала. Обработка определяется провайдерами логирования.
• (Необязательно) Trace ID: полезное поле для объединения журналов в одной транзакции или запросе.
• (Обязательно) Сообщение: сообщение журнала.
• (Обязательно) Уровень логирования:
  • Ошибка: для ошибки приложения.
  • Предупреждение: для информации о предупреждении.
  • Информация: для уведомления.
  • Отладка: для целей отладки.

C++ API

Включить заголовок: <napa.h>

Макросы:

• LOG_ERROR(раздел, формат, ...)
• LOG_ERROR_WITH_TRACEID(раздел, traceId, формат, ...)
• LOG_WARNING(раздел, формат, ...)
• LOG_WARNING_WITH_TRACEID(раздел, traceId, формат, ...)
• LOG_INFO(раздел, формат, ...)
• LOG_INFO_WITH_TRACEID(раздел, traceId, формат, ...)
• LOG_DEBUG(раздел, формат, ...)
• LOG_DEBUG_WITH_TRACEID(раздел, traceId, формат, ...)

#include <napa.h>

void MyFunction() {
    // ...
    LOG_ERROR("init", "error: %s", errorMessage.c_str());
}

JavaScript API

log(message: string): void

Он регистрирует сообщение. Используется уровень информации.

• log — это ярлык для log.info.*

Пример:

var napa = require('napajs');
napa.log('program started');

log(section: string, message: string): void

Он записывает сообщение с разделом. Используется уровень информации.

Пример:

napa.log('init', 'program started');

log(section: string, traceId: string, message: string): void

Он регистрирует сообщение с разделом, связывая его с traceId. Используется уровень информации.

Пример:

napa.log('request', 'A1B2C3D4', 'request received');

log.err(...)

Он регистрирует сообщение об ошибке. Три вариации аргументов такие же, как у log.

log.warn(...)

Он регистрирует предупреждающее сообщение. Три вариации аргументов такие же, как у log.

log.info(...)

Он регистрирует информационное сообщение. Три вариации аргументов такие же, как у log.

log.debug(...)

Он регистрирует отладочное сообщение. Три комбинации аргументов такие же, как у log.

Использование пользовательских провайдеров логирования

Разработчики могут подключить пользовательский провайдер логирования, вызвав следующее перед созданием любых зон:

napa.runtime.setPlatformSettings({
    "loggingProvider": "<имя-модуля-пользовательского-провайдера-логирования>"
}

Разработка пользовательских провайдеров логирования

TBD