@tramvai/module-log 1.53.2 → 1.54.0

package/README.md

@@ -1,117 +1,123 @@
 # Log
 
-Модуль добавляет реализацию токена `LOGGER_TOKEN` на основе библиотеки [@tinkoff/logger](references/libs/logger.md).
+Module adds `LOGGER_TOKEN` token implementation using library [@tinkoff/logger](references/libs/logger.md).
 
-## Подключение
+## Installation
 
-Подключается в модуле `@tramvai/module-common`
+Module is automatically installs and adds with module `@tramvai/module-common`
 
-## Пример
+## Explanation
 
-```tsx
-import { Module, commandLineListToken, provide } from '@tramvai/core';
-import { LOGGER_TOKEN } from '@tramvai/module-common';
-
-@Module({
-  providers: [
-    provide({
-      provide: commandLineListToken.customerStart,
-      useFactory: ({ logger }) => {
-        logger.debug('customer start'); // логгирование в глобальном пространстве логов
-
-        const myLogger = logger({
-          name: 'test',
-        });
-
-        myLogger.warn('warning'); // логгирование в пространстве test
-        myLogger.error('error!');
-      },
-      deps: {
-        logger: LOGGER_TOKEN,
-      },
-    }),
-  ],
-})
-export class MyModule {}
-```
+### Display logs
 
-## Отображение логов
+see [@tinkoff/logger](../libs/logger#display-logs).
 
-см. [@tinkoff/logger](../libs/logger#отображение-логов).
+> By default, on server all of the logs of level warn and above are enabled. On the client in dev-mode all the logs of level error and above are enabled while in prod-mode all of the logs on client are disabled.
 
-> По умолчанию на сервере включены все логи уровня warn и выше. На клиенте в дев-режиме включены логи error и выше, в прод-режиме отображение каких-либо логов отключено.
+### Send logs to the API
 
-## Отправка логов на апи
+It is implied that logs from the server are collected by the external tool that has access to the server console output and because of this logging to the external API from the server is not needed.
 
-Предполагается что логи с сервера собираются через отдельный механизм, который имеет доступ к выводу консоли сервера и поэтому в логгировании на внешнее апи нет смысла.
+In browser logs to the API are send with [RemoteReporter](../libs/logger.md#remotereporter). By default, all of the logs with levels `error` and `fatal` are send. The url for the API is specified by environment variable `FRONT_LOG_API`. For the customization see docs for the [RemoteReporter](../libs/logger.md#remotereporter).
 
-В браузере логи на апи отправляются с помощью [RemoteReporter](../libs/logger.md#remotereporter). По умолчанию отправляются все логи уровня `error` и `fatal`. Урл апи определяется из переменной окружения `FRONT_LOG_API`. Для индивидуальной настройки смотри документацию к [RemoteReporter](../libs/logger.md#remotereporter).
+### See logs from the server in browser
 
-## Просмотр логов с сервера в браузере
+This functionality is available only in dev-mode and can make development a little easier.
 
-Данная функция доступна в дев режиме и создана для упрощения работы с логами при разработке.
+In browser console when loading page of the app the special log group with name `Tramvai SSR Logs` will be showed. If you open this group you will see logs from the server that was logged to this particular request. Herewith will be displayed only logs that are enabled for the [displaying on the server](#display-logs). If you want to see all of the logs in browser with settings for [displaying in browser](#display-logs) you can specify env `DEBUG_FULL_SSR` when running app.
 
-В консоли браузера при заходе на страницу приложения появится специальная группа логов, под тегом `Tramvai SSR Logs` при раскрытии логов будут отображены логи которые были залогированы для даного конретного запроса на сервера, причем будут отображены именно те логи, которые подпадают под настройки [отображения для сервера](#отображение-логов-на-сервере). Если необходимо отобразить все логи с сервера с настройками [отображения для клиента](#отображение-логов-в-браузере), то нужно запустить сервер с переменной окружения `DEBUG_FULL_SSR`
+### See logs for the requests
 
-## Просмотр логов для запросов на основе [@tinkoff/request](https://tinkoff.github.io/tinkoff-request/)
+> Works only with [@tinkoff/request](https://tinkoff.github.io/tinkoff-request/)
 
-Логгер и настройки для него должны явно передаваться в [плагин логгирования](https://tinkoff.github.io/tinkoff-request/docs/plugins/log.html), что уже делается в [http-client](references/modules/http-client.md).
+[http-client](references/modules/http-client.md) is already passes logger and its settings to the [log plugin](https://tinkoff.github.io/tinkoff-request/docs/plugins/log.html).
 
-В плагине используется генерация тега для логгера в виде `request.${name}` поэтому чтобы отобразить такие необходимо настроить фильтры для отображения для конкретной фабрики запросов:
+Plugin automatically generates names for loggers using template `request.${name}` that might be used to setting up [displaying of logs](#display-logs):
 
 ```tsx
 const logger = di.get(LOGGER_TOKEN);
 const makeRequest = request([...otherPlugins, logger({ name: 'my-api-name', logger })]);
 ```
 
-Т.к. имя для логгера равно `my-api-name`, то для отображения логов необходимо:
+As name of the logger equals to `my-api-name` to show logs:
 
-- на сервере дополнить переменную окружения `LOG_ENABLE: 'request.my-api-name'`
-- на клиенте включить логгирование через вызов `logger.enable('request.my-api-name')`
+- on server extend env `LOG_ENABLE: 'request.my-api-name'`
+- on client call `logger.enable('request.my-api-name')`
 
-## Как правильно форматировать логи
+### Change logger settings on server
 
-Смотри [Как правильно логгировать](../libs/logger.md#как-правильно-логгировать)
+By default, settings for the logger on server are specified by envs `LOG_ENABLE` and `LOG_LEVEL`.
 
-## Экспортируемые токены
+You can change this settings in runtime using papi-route `{app}/private/papi/logger`
 
-### LOGGER_TOKEN
-
-Сущность логгера. Заменяет стандартную реализацию `LOGGER_TOKEN` из [@tramvai/module-common](references/modules/common.md)
-
-## Изменение серверных настроек логгера
-
-По умолчанию, настройки отображения логгера на сервере берутся из переменной окружения `LOG_ENABLE`, а настройки уровня логирования из переменной окружения `LOG_LEVEL`
-
-Для изменения этих настроек в рантайме существует papi роут `{app}/private/papi/logger`
-
-Отображение логов меняется через query параметр `enable`, например:
+Displaying of the logs is changed by query with the name `enable`, e.g.:
 
 ```
 https://localhost:3000/{app}/private/papi/logger?enable=request.tinkoff
 ```
 
-Уровень логгирования меняется через query параметр `level`, например:
+Level of the logs is change by query with the name `level`, e.g.:
 
 ```
 https://localhost:3000/{app}/private/papi/logger?level=warn
 ```
 
-Вернуть настройки по умолчанию, из переменных окружения, можно с параметром `mode=default`:
+To reset settings to default, based on env, use `mode=default`:
 
 ```
 https://localhost:3000/{app}/private/papi/logger?mode=default
 ```
 
-## Переменные окружения
+### Env
+
+- `LOG_LEVEL` = trace | debug | info | warn | error | fatal - show logs with specified level and higher. E.g.:
+  - if `LOG_LEVEL=info` then logs with levels `info`, `warn`, `error`, `fatal` will be showed
+- `LOG_ENABLE` = `${name}` | `${level}:${name}` - show logs with specified name of the logger or name + level. Several entries are passed with comma as delimiter. E.g.:
+  - if `LOG_ENABLE=server` then show logs with the name `server`
+  - if `LOG_ENABLE=trace:server*` then show logs with the name `server` and level `trace`
+  - if `LOG_ENABLE=info:server,client,trace:shared` then show all of the specified logs using rules from above
+
+### Debug
 
-- `LOG_LEVEL` = trace | debug | info | warn | error | fatal - включает отображение логов для заданного уровня и все уровней выше. Пример:
-  - если `LOG_LEVEL=info`, то будут отображаться все логи уровней info, warn, error, fatal
-- `LOG_ENABLE` = `${name}` | `${level}:${name}` - позволяет включить отображение всех логов по определенному имени логгера или по определенному имени и уровню. Несколько вхождений передаются через запятую. Примеры:
-  - если `LOG_ENABLE=server`, то будут отображены логи всех уровней с именем `server`
-  - если `LOG_ENABLE=trace:server*`, то будут отображены только логи для `server` с уровнем `trace`
-  - если `LOG_ENABLE=info:server,client,trace:shared`, то будут включены логи для заданных логгеров по правилам выше
+Module uses logger with the id `ssr-logger`
 
-## Отладка
+## How to
+
+### Example of base usage
+
+```tsx
+import { Module, commandLineListToken, provide } from '@tramvai/core';
+import { LOGGER_TOKEN } from '@tramvai/module-common';
+
+@Module({
+  providers: [
+    provide({
+      provide: commandLineListToken.customerStart,
+      useFactory: ({ logger }) => {
+        logger.debug('customer start'); // logging in the global namespace
+
+        const myLogger = logger({
+          name: 'test',
+        });
+
+        myLogger.warn('warning'); // logging in the namespace test
+        myLogger.error('error!');
+      },
+      deps: {
+        logger: LOGGER_TOKEN,
+      },
+    }),
+  ],
+})
+export class MyModule {}
+```
+
+### How to properly format logs
+
+See [@tinkoff/logger](../libs/logger.md#how-to-log-properly)
+
+## Exported tokens
+
+### LOGGER_TOKEN
 
-Модуль использует логгер с идентификатором `ssr-logger`
+Instance of the logger. Replaces base implementation for the `LOGGER_TOKEN` from the [@tramvai/module-common](references/modules/common.md)

package/lib/browser.js

@@ -12,6 +12,7 @@ import { createEvent, createReducer } from '@tramvai/state';
 
 const LOGGER_NAME = '';
 const LOGGER_KEY = 'tramvai';
+const LOGGER_DEPTH_LIMIT = 20;
 
 const setLogs = createEvent('setLogs');
 const LogStore = createReducer('devLogs', []).on(setLogs, (_, logs) => logs);
@@ -180,6 +181,7 @@ const logger = createLoggerFactory({
     name: LOGGER_NAME,
     key: LOGGER_KEY,
     reporters: [new BrowserReporter()],
+    depthLimit: LOGGER_DEPTH_LIMIT,
 });
 let LogModule = class LogModule {
 };

package/lib/constants.d.ts

@@ -1,2 +1,3 @@
 export declare const LOGGER_NAME = "";
 export declare const LOGGER_KEY = "tramvai";
+export declare const LOGGER_DEPTH_LIMIT = 20;

package/lib/server.es.js

@@ -177,6 +177,7 @@ const flushLogs = (ssrLogger, logs) => {
 
 const LOGGER_NAME = '';
 const LOGGER_KEY = 'tramvai';
+const LOGGER_DEPTH_LIMIT = 20;
 
 const DefaultReporter = env.ci || env.test ? NodeBasicReporter : NodeDevReporter;
 const reporter = process.env.DEBUG_PLAIN || process.env.NODE_ENV !== 'production'
@@ -190,6 +191,7 @@ const logger = createLoggerFactory({
         pid: process.pid,
         hostname: hostname(),
     },
+    depthLimit: LOGGER_DEPTH_LIMIT,
 });
 function factory({ environmentManager, loggerInitHooks }) {
     var _a, _b;

package/lib/server.js

@@ -186,6 +186,7 @@ const flushLogs = (ssrLogger, logs) => {
 
 const LOGGER_NAME = '';
 const LOGGER_KEY = 'tramvai';
+const LOGGER_DEPTH_LIMIT = 20;
 
 const DefaultReporter = env__default["default"].ci || env__default["default"].test ? logger$1.NodeBasicReporter : logger$1.NodeDevReporter;
 const reporter = process.env.DEBUG_PLAIN || process.env.NODE_ENV !== 'production'
@@ -199,6 +200,7 @@ const logger = logger$1.createLoggerFactory({
         pid: process.pid,
         hostname: os.hostname(),
     },
+    depthLimit: LOGGER_DEPTH_LIMIT,
 });
 function factory({ environmentManager, loggerInitHooks }) {
     var _a, _b;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tramvai/module-log",
-  "version": "1.53.2",
+  "version": "1.54.0",
   "description": "",
   "browser": "lib/browser.js",
   "main": "lib/server.js",
@@ -19,16 +19,16 @@
     "build-for-publish": "true"
   },
   "dependencies": {
-    "@tinkoff/logger": "0.10.12"
+    "@tinkoff/logger": "0.10.13"
   },
   "peerDependencies": {
     "@tinkoff/utils": "^2.1.2",
-    "@tramvai/core": "1.53.2",
-    "@tramvai/module-environment": "1.53.2",
-    "@tramvai/papi": "1.53.2",
-    "@tramvai/state": "1.53.2",
-    "@tramvai/tokens-common": "1.53.2",
-    "@tramvai/tokens-server": "1.53.2",
+    "@tramvai/core": "1.54.0",
+    "@tramvai/module-environment": "1.54.0",
+    "@tramvai/papi": "1.54.0",
+    "@tramvai/state": "1.54.0",
+    "@tramvai/tokens-common": "1.54.0",
+    "@tramvai/tokens-server": "1.54.0",
     "std-env": "^2.2.1",
     "tslib": "^2.0.3"
   },