summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorilyakharev <[email protected]>2023-10-04 13:21:23 +0300
committerilyakharev <[email protected]>2023-10-04 14:32:41 +0300
commit878390a42ef0ebac95711510159532ecf26b027e (patch)
tree9bade71d9e2d065d279b847024622553db8fc9c3
parentf195b66080a41cc1c0683bc2ddaa0fc44345227d (diff)
Add logger docs for ydb-php-sdk
-rw-r--r--ydb/docs/en/core/reference/ydb-sdk/recipes/debug-logs.md15
-rw-r--r--ydb/docs/ru/core/reference/ydb-sdk/recipes/debug-logs.md27
2 files changed, 36 insertions, 6 deletions
diff --git a/ydb/docs/en/core/reference/ydb-sdk/recipes/debug-logs.md b/ydb/docs/en/core/reference/ydb-sdk/recipes/debug-logs.md
index 6abb0e3444f..02795cf3a62 100644
--- a/ydb/docs/en/core/reference/ydb-sdk/recipes/debug-logs.md
+++ b/ydb/docs/en/core/reference/ydb-sdk/recipes/debug-logs.md
@@ -338,4 +338,19 @@ Below are examples of code that enables logging in different {{ ydb-short-name }
</Configuration>
```
+- PHP
+
+ For logging purposes, you need to use a class, that implements `\Psr\Log\LoggerInterface`.
+ YDB-PHP-SDK has build-in loggers in `YdbPlatform\Ydb\Logger` namespace:
+ * `NullLogger` - default logger, which writes nothing
+ * `SimpleStdLogger($level)` - logger, which writes to logs in stderr.
+
+ Usage example:
+ ```php
+ $config = [
+ 'logger' => new \YdbPlatform\Ydb\Logger\SimpleStdLogger(\YdbPlatform\Ydb\Logger\SimpleStdLogger::INFO)
+ ]
+ $ydb = new \YdbPlatform\Ydb\Ydb($config);
+ ```
+
{% endlist %}
diff --git a/ydb/docs/ru/core/reference/ydb-sdk/recipes/debug-logs.md b/ydb/docs/ru/core/reference/ydb-sdk/recipes/debug-logs.md
index fe0296a2532..ed431898d1f 100644
--- a/ydb/docs/ru/core/reference/ydb-sdk/recipes/debug-logs.md
+++ b/ydb/docs/ru/core/reference/ydb-sdk/recipes/debug-logs.md
@@ -13,12 +13,12 @@
{% cut "Через переменную окружения `YDB_LOG_SEVERITY_LEVEL`" %}
Данная переменная окружения включает встроенный в `ydb-go-sdk` логгер (синхронный, неблочный) с выводом в стандартный поток вывода.
- Выставить переменную окружения можно так:
+ Выставить переменную окружения можно так:
```shell
export YDB_LOG_SEVERITY_LEVEL=info
- ```
+ ```
(доступные значения `trace`, `debug`, `info`, `warn`, `error`, `fatal`, `quiet`, по умолчанию `quiet`).
-
+
{% endcut %}
{% cut "Подключить сторонний логгер `go.uber.org/zap`" %}
@@ -139,10 +139,10 @@
{% cut "Через переменную окружения `YDB_LOG_SEVERITY_LEVEL`" %}
Данная переменная окружения включает встроенный в `ydb-go-sdk` логгер (синхронный, неблочный) с выводом в стандартный поток вывода.
- Выставить переменную окружения можно так:
+ Выставить переменную окружения можно так:
```shell
export YDB_LOG_SEVERITY_LEVEL=info
- ```
+ ```
(доступные значения `trace`, `debug`, `info`, `warn`, `error`, `fatal`, `quiet`, по умолчанию `quiet`).
{% endcut %}
@@ -289,7 +289,7 @@
В {{ ydb-short-name }} Java SDK для логирования используется библиотека slf4j, которая позволяет использовать различные уровни логирования (`error`, `warn`, `info`, `debug`, `trace`) для одного или нескольких логгеров. В текущей реализации доступны следующие логгеры:
- * Логгер `tech.ydb.core.grpc` предоставляет информацию о внутренней реализации grpc протокола
+ * Логгер `tech.ydb.core.grpc` предоставляет информацию о внутренней реализации grpc протокола
* уровень `debug` логирует все операции по протоколу grpc, рекомедуется использовать только для отладки
* уровень `info` рекомендуется использовать по умолчанию
@@ -338,4 +338,19 @@
</Configuration>
```
+- PHP
+
+ В YDB PHP SDK для логирования вам нужно использовать класс, который реализует `\Psr\Log\LoggerInterface`.
+ В YDB-PHP-SDK встроены логгеры в пространстве имен `YdbPlatform\Ydb\Logger`:
+ * `NullLogger` - по умолчанию, который ничего не выводит
+ * `SimpleStdLogger($level)` - логгер, который выводит логи в stderr.
+
+ Пример использования:
+ ```php
+ $config = [
+ 'logger' => new \YdbPlatform\Ydb\Logger\SimpleStdLogger(\YdbPlatform\Ydb\Logger\SimpleStdLogger::INFO)
+ ]
+ $ydb = new \YdbPlatform\Ydb\Ydb($config);
+ ```
+
{% endlist %}