Skip to content

Commit 568b0d8

Browse files
committed
[DOP-19927] Fix logging config docstrings
1 parent c5d5c1c commit 568b0d8

File tree

2 files changed

+7
-16
lines changed

2 files changed

+7
-16
lines changed

syncmaster/backend/settings/server/__init__.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@ class ServerSettings(BaseModel):
2222
.. code-block:: bash
2323
2424
SYNCMASTER__SERVER__DEBUG=True
25-
SYNCMASTER__SERVER__LOGGING__PRESET=colored
25+
SYNCMASTER__SERVER__REQUEST_ID__ENABLED=True
26+
SYNCMASTER__SERVER__MONITORING__ENABLED=True
2627
"""
2728

2829
debug: bool = Field(

syncmaster/settings/log/__init__.py

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -20,31 +20,21 @@ class LoggingSettings(BaseModel):
2020
2121
.. code-block:: bash
2222
23-
# backend logging
24-
SYNCMASTER__SERVER__LOGGING__SETUP=True
25-
SYNCMASTER__SERVER__LOGGING__PRESET=json
26-
27-
# celery logging
28-
SYNCMASTER__WORKER__LOGGING__SETUP=True
29-
SYNCMASTER__WORKER__LOGGING__PRESET=json
23+
SYNCMASTER__LOGGING__SETUP=True
24+
SYNCMASTER__LOGGING__PRESET=json
3025
3126
Passing custom logging config file:
3227
3328
.. code-block:: bash
3429
35-
# backend logging
36-
SYNCMASTER__SERVER__LOGGING__SETUP=True
37-
SYNCMASTER__SERVER__LOGGING__CUSTOM__CONFIG_PATH=/some/logging.yml
38-
39-
# celery logging
40-
SYNCMASTER__WORKER__LOGGING__SETUP=True
41-
SYNCMASTER__WORKER__LOGGING__CUSTOM__CONFIG_PATH=/some/logging.yml
30+
SYNCMASTER__LOGGING__SETUP=True
31+
SYNCMASTER__LOGGING__CUSTOM__CONFIG_PATH=/some/logging.yml
4232
4333
Setup logging in some other way, e.g. using `uvicorn args <https://www.uvicorn.org/settings/#logging>`_:
4434
4535
.. code-block:: bash
4636
47-
$ export SYNCMASTER__SERVER__LOGGING__SETUP=False
37+
$ export SYNCMASTER__LOGGING__SETUP=False
4838
$ python -m syncmaster.backend --log-level debug
4939
"""
5040

0 commit comments

Comments
 (0)