Skip to content

Commit d8a98cc

Browse files
committed
Improve documentation about PROCESSOR_LOG_LEVEL
1 parent 15791db commit d8a98cc

2 files changed

Lines changed: 62 additions & 2 deletions

File tree

docs/en/development.md

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,37 @@ Operator and processor read the **LOG_LEVEL** environment variable. Allowed valu
140140

141141
In Helm, the operator level is set via the **logLevel** value (default `"info"`), which is passed as env `LOG_LEVEL` in the operator pod.
142142

143-
Processor pod log level is controlled by the operator env **PROCESSOR_LOG_LEVEL** (processor pods default to `LOG_LEVEL=info`). To enable verbose processor logs when debugging, set env `PROCESSOR_LOG_LEVEL=debug` in the operator Deployment.
143+
#### PROCESSOR_LOG_LEVEL
144+
145+
The operator reads the **PROCESSOR_LOG_LEVEL** environment variable and passes it to every processor pod as **LOG_LEVEL**. Processor pods are the workloads created for each DataFlow; they run the actual data pipelines.
146+
147+
| Aspect | Description |
148+
|--------|-------------|
149+
| **Default** | `info` (if unset, processor pods get `LOG_LEVEL=info`) |
150+
| **Allowed values** | Same as LOG_LEVEL: `debug`, `info`, `warn`, `error` (case-insensitive) |
151+
| **Where to set** | In the **operator** Deployment (not in the DataFlow resource). The operator injects this value into each processor pod's `LOG_LEVEL` env. When using Helm, set the **processorLogLevel** value (see below). |
152+
153+
**With Helm:** use the **processorLogLevel** value (default `"info"`). Example for verbose processor logs:
154+
155+
```bash
156+
helm upgrade dataflow-operator oci://ghcr.io/dataflow-operator/helm-charts/dataflow-operator \
157+
--set processorLogLevel=debug \
158+
--reuse-values
159+
```
160+
161+
Or in `values.yaml`:
162+
163+
```yaml
164+
processorLogLevel: "debug" # processor pods get LOG_LEVEL=debug
165+
```
166+
167+
**Without Helm:** set the env in the operator Deployment, e.g.:
168+
169+
```bash
170+
kubectl set env deployment/dataflow-operator PROCESSOR_LOG_LEVEL=debug -n <operator-namespace>
171+
```
172+
173+
Then restart or recreate the operator so it recreates processor pods with the new level.
144174

145175
## Testing
146176

docs/ru/development.md

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,37 @@ make manifests
187187

188188
В Helm для оператора уровень задаётся через value **logLevel** (по умолчанию `"info"`); он подставляется в env `LOG_LEVEL` в поде оператора.
189189

190-
Уровень лога подов процессора задаётся переменной окружения оператора **PROCESSOR_LOG_LEVEL** (по умолчанию поды процессора получают `LOG_LEVEL=info`). Чтобы включить детальные логи процессора при отладке, задайте в Deployment оператора env `PROCESSOR_LOG_LEVEL=debug`.
190+
#### PROCESSOR_LOG_LEVEL
191+
192+
Оператор читает переменную окружения **PROCESSOR_LOG_LEVEL** и передаёт её в каждый под процессора как **LOG_LEVEL**. Поды процессора — это рабочие нагрузки, создаваемые для каждого DataFlow; в них выполняются сами пайплайны.
193+
194+
| Аспект | Описание |
195+
|--------|----------|
196+
| **По умолчанию** | `info` (если переменная не задана, поды процессора получают `LOG_LEVEL=info`) |
197+
| **Допустимые значения** | Те же, что у LOG_LEVEL: `debug`, `info`, `warn`, `error` (регистр не важен) |
198+
| **Где задавать** | В Deployment **оператора** (не в ресурсе DataFlow). Оператор подставляет это значение в env `LOG_LEVEL` каждого пода процессора. При установке через Helm задаётся value **processorLogLevel** (см. ниже). |
199+
200+
**Через Helm:** используйте value **processorLogLevel** (по умолчанию `"info"`). Пример для детальных логов процессоров:
201+
202+
```bash
203+
helm upgrade dataflow-operator oci://ghcr.io/dataflow-operator/helm-charts/dataflow-operator \
204+
--set processorLogLevel=debug \
205+
--reuse-values
206+
```
207+
208+
Или в `values.yaml`:
209+
210+
```yaml
211+
processorLogLevel: "debug" # поды процессора получают LOG_LEVEL=debug
212+
```
213+
214+
**Без Helm:** задайте переменную окружения в Deployment оператора, например:
215+
216+
```bash
217+
kubectl set env deployment/dataflow-operator PROCESSOR_LOG_LEVEL=debug -n <namespace-оператора>
218+
```
219+
220+
После этого перезапустите или пересоздайте оператор, чтобы поды процессора пересоздались с новым уровнем.
191221

192222
## Тестирование
193223

0 commit comments

Comments
 (0)