Skip to content

Commit 628bffc

Browse files
committed
doc: use global logger name in getting started
These examples predate the current best practice of global `logger` and local `log`. fixes #823
1 parent fbbea9d commit 628bffc

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

docs/getting-started.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ As a result, the simplest possible usage looks like this:
2323

2424
```{doctest}
2525
>>> import structlog
26-
>>> log = structlog.get_logger()
27-
>>> log.info("hello, %s!", "world", key="value!", more_than_strings=[1, 2, 3]) # doctest: +SKIP
26+
>>> logger = structlog.get_logger()
27+
>>> logger.info("hello, %s!", "world", key="value!", more_than_strings=[1, 2, 3]) # doctest: +SKIP
2828
2022-10-07 10:41:29 [info ] hello, world! key=value! more_than_strings=[1, 2, 3]
2929
```
3030

@@ -97,13 +97,13 @@ def view(request):
9797
user_agent = request.get("HTTP_USER_AGENT", "UNKNOWN")
9898
peer_ip = request.client_addr
9999
if something:
100-
log.info("something", user_agent=user_agent, peer_ip=peer_ip)
100+
logger.info("something", user_agent=user_agent, peer_ip=peer_ip)
101101
return "something"
102102
elif something_else:
103-
log.info("something_else", user_agent=user_agent, peer_ip=peer_ip)
103+
logger.info("something_else", user_agent=user_agent, peer_ip=peer_ip)
104104
return "something_else"
105105
else:
106-
log.info("else", user_agent=user_agent, peer_ip=peer_ip)
106+
logger.info("else", user_agent=user_agent, peer_ip=peer_ip)
107107
return "else"
108108
```
109109

@@ -114,7 +114,7 @@ At this point, you'll be tempted to write a closure like:
114114

115115
```python
116116
def log_closure(event):
117-
log.info(event, user_agent=user_agent, peer_ip=peer_ip)
117+
logger.info(event, user_agent=user_agent, peer_ip=peer_ip)
118118
```
119119

120120
inside of the view.
@@ -127,7 +127,7 @@ Let's have a look at a better approach:
127127

128128
```python
129129
def view(request):
130-
log = log.bind(
130+
log = logger.bind(
131131
user_agent=request.get("HTTP_USER_AGENT", "UNKNOWN"),
132132
peer_ip=request.client_addr,
133133
)

0 commit comments

Comments
 (0)