Skip to content

Commit fc18d0a

Browse files
authored
Chore: Update docs for airbyte.logs (#352)
1 parent 9257d4e commit fc18d0a

File tree

2 files changed

+12
-1
lines changed

2 files changed

+12
-1
lines changed

airbyte/__init__.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,7 @@
107107
- **`airbyte.exceptions`** - Definitions of all exception and warning classes used in PyAirbyte.
108108
- **`airbyte.experimental`** - Experimental features and utilities that do not yet have a stable
109109
API.
110+
- **`airbyte.logs`** - Logging functionality and configuration.
110111
- **`airbyte.records`** - Internal record handling classes.
111112
- **`airbyte.results`** - Documents the classes returned when working with results from
112113
`Source.read` and `Destination.write`
@@ -130,6 +131,7 @@
130131
documents,
131132
exceptions, # noqa: ICN001 # No 'exc' alias for top-level module
132133
experimental,
134+
logs,
133135
records,
134136
results,
135137
secrets,
@@ -159,6 +161,7 @@
159161
"documents",
160162
"exceptions",
161163
"experimental",
164+
"logs",
162165
"records",
163166
"registry",
164167
"results",

airbyte/logs.py

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# Copyright (c) 2024 Airbyte, Inc., all rights reserved.
2-
"""PyAirbyte Logging Configuration."""
2+
"""PyAirbyte Logging features and related configuration.
3+
4+
By default, PyAirbyte main logs are written to a file in the `AIRBYTE_LOGGING_ROOT` directory, which
5+
defaults to a system-created temporary directory. PyAirbyte also maintains connector-specific log
6+
files within the same directory, under a subfolder with the name of the connector.
7+
8+
PyAirbyte supports structured JSON logging, which is disabled by default. To enable structured
9+
logging in JSON, set `AIRBYTE_STRUCTURED_LOGGING` to `True`.
10+
"""
311

412
from __future__ import annotations
513

0 commit comments

Comments
 (0)