From 15e22915c7d5d6d0f9e16b87380510e6ccc1cbc3 Mon Sep 17 00:00:00 2001 From: Kairat Jenishev Date: Thu, 12 Dec 2024 23:21:57 +0600 Subject: [PATCH] Added documentation in Russian language regarding the `$maskVars` property #20295 --- docs/guide-ru/runtime-logging.md | 17 +++++++++++++++++ docs/guide/runtime-logging.md | 2 +- 2 files changed, 18 insertions(+), 1 deletion(-) diff --git a/docs/guide-ru/runtime-logging.md b/docs/guide-ru/runtime-logging.md index 2f45900e2ca..e805507097b 100644 --- a/docs/guide-ru/runtime-logging.md +++ b/docs/guide-ru/runtime-logging.md @@ -173,6 +173,23 @@ return [ При задании значением свойства `logVars` пустого массива, общая информация не будет выводиться. Для определения собственного алгоритма подключения общей информации, следует переопределить метод [[yii\log\Target::getContextMessage()]]. +Если некоторые из полей вашего запроса содержат конфиденциальную информацию, которую вы не хотели бы логировать (например, пароли, токены доступа), +вы можете дополнительно настроить свойство `maskVars`, которое может содержать как точные значения, так и шаблоны (без учета регистра). +По умолчанию следующие параметры запроса будут замаскированы с помощью `***`: +`$_SERVER[HTTP_AUTHORIZATION]`, `$_SERVER[PHP_AUTH_USER]`, `$_SERVER[PHP_AUTH_PW]`, но вы можете задать свои собственные. Например: + +```php +[ + 'class' => 'yii\log\FileTarget', + 'logVars' => ['_SERVER'], + 'maskVars' => [ + '_SERVER.HTTP_X_PASSWORD', + '_SERVER.*_SECRET', // соответствует всем, заканчивающимся на "_SECRET" + '_SERVER.SECRET_*', // соответствует всем, начинающимся с "SECRET_" + '_SERVER.*SECRET*', // соответствует всем содержащим "SECRET" + ] +] +``` ### Уровень отслеживания выполнения кода diff --git a/docs/guide/runtime-logging.md b/docs/guide/runtime-logging.md index 7bccee119c1..5185c0916e7 100644 --- a/docs/guide/runtime-logging.md +++ b/docs/guide/runtime-logging.md @@ -219,7 +219,7 @@ Or if you want to implement your own way of providing context information, you m In case some of your request fields contain sensitive information you would not like to log (e.g. passwords, access tokens), you may additionally configure `maskVars` property, which can contain both exact values and (case-insensitive) patterns. By default, the following request parameters will be masked with `***`: -`$_SERVER[HTTP_AUTHORIZATION]`, `$_SERVER[PHP_AUTH_USER]`, `$_SERVER[PHP_AUTH_PW]`, but you can set your own: +`$_SERVER[HTTP_AUTHORIZATION]`, `$_SERVER[PHP_AUTH_USER]`, `$_SERVER[PHP_AUTH_PW]`, but you can set your own. For example: ```php [