1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
|
%global _empty_manifest_terminate_build 0
Name: python-alchemy-logging
Version: 1.1.1
Release: 1
Summary: A wrapper around the logging package to provide Alchemy Logging functionality
License: MIT
URL: https://github.com/IBM/alchemy-logging
Source0: https://mirrors.aliyun.com/pypi/web/packages/0d/0c/33fbd28a7240c0aabff04ad76abd0230f9cfac3b779dd23522cac0f79081/alchemy-logging-1.1.1.tar.gz
BuildArch: noarch
%description
# Alchemy Logging (alog) - Python
The `alog` framework provides tunable logging with easy-to-use defaults and power-user capabilities. The mantra of `alog` is **"Log Early And Often"**. To accomplish this goal, `alog` makes it easy to enable verbose logging at develop/debug time and trim the verbosity at production run time.
## Setup
To use the `alog` module, simply install it with `pip`:
```sh
pip install alchemy-logging
```
## Channels and Levels
The primary components of the framework are **channels** and **levels** which allow for each log statement to be enabled or disabled when appropriate.
1. **Levels**: Each logging statement is made at a specific level. Levels provide sequential granularity, allowing detailed debugging statements to be placed in the code without clogging up the logs at runtime. The sequence of levels and their general usage is as follows:
1. `off`: Disable the given channel completely
1. `fatal`: A fatal error has occurred. Any behavior after this statement should be regarded as undefined.
1. `error`: An unrecoverable error has occurred. Any behavior after this statement should be regarded as undefined unless the error is explicitly handled.
1. `warning`: A recoverable error condition has come up that the service maintainer should be aware of.
1. `info`: High-level information that is valuable at runtime under moderate load.
1. `trace`: Used to log begin/end of functions for debugging code paths.
1. `debug`: High-level debugging statements such as function parameters.
1. `debug1`: High-level debugging statements.
1. `debug2`: Mid-level debugging statements such as computed values.
1. `debug3`: Low-level debugging statements such as computed values inside loops.
1. `debug4`: Ultra-low-level debugging statements such as data dumps and/or statements inside multiple nested loops.
1. **Channels**: Each logging statement is made to a specific channel. Channels are independent of one another and allow for logical grouping of log messages by functionality. A channel can be any string. A channel may have a specific **level** assigned to it, or it may use the configured default level if it is not given a specific level filter.
Using this combination of **Channels** and **Levels**, you can fine-tune what log statements are enabled when you run your application under different circumstances.
## Usage
### Configuration
```py
import alog
if __name__ == "__main__":
alog.configure(default_level="info", filters="FOO:debug,BAR:off")
```
In this example, the channel `"FOO"` is set to the `debug` level, the channel `"BAR"` is fully disabled, and all other channels are set to use the `INFO` level.
In addition to the above, the `configure` function also supports the following arguments:
* `formatter`: May be `"pretty"`, `"json"`, or any class derived from `AlogFormatterBase`
* `thread_id`: Bool indicating whether or not to include a unique thread ID with the logging header (`pretty`) or structure (`json`).
* `handler_generator`: This allows users to provide their own output handlers and replace the standard handler that sends log messages to `stderr`. See [the `logging` documentation](https://docs.python.org/3/library/logging.handlers.html#module-logging.handlers) for details.
### Logging Functions
For each log level, there are two functions you can use to create log lines: The standard `logging` package function, or the corresponding `alog.use_channel(...).<level>` function. The former will always log to the `root` channel while the later requires that
a channel string be specified via `use_channel()`.
```py
import alog
import logging
def foo(age):
alog.use_channel("FOO").debug3(
"Debug3 line on the FOO channel with an int value %d!", age
)
logging.debug("debug line on the MAIN channel")
```
### Channel Log
In a given portion of code, it often makes sense to have a common channel that is used by many logging statements. Re-typing the channel name can be cumbersome and error-prone, so the concept of the **Channel Log** helps to eliminate this issue. To create a Channel Log, call the `use_channel` function. This gives you a handle to a channel log which has all of the same standard log functions as the top-level `alog`, but without the requirement to specify a channel. For example:
```py
import alog
log = alog.use_channel("FOO")
def foo(age):
log.info("Hello Logging World! I am %d years old", age)
```
**NOTE**: In this (python) implementation, this is simply a wrapper around `logging.getLogger()`
### Extra Log Information
There are several other types of information that `alog` supports adding to log records:
#### Log Codes
This is an optional argument to all logging functions which adds a specified code to the record. It can be useful for particularly high-profile messages (such as per-request error summaries in a server) that you want to be able to track in a programmatic way. The only requirement for a `log_code` is that it begin with `<` and end with `>`. The log code always comes before the `message`. For example:
```py
ch = alog.use_channel("FOO")
ch.debug("<FOO80349757I>", "Logging is fun!")
```
#### Dict Data
Sometimes, it's useful to log structured key/value pairs in a record, rather than a plain-text message, even when using the `pretty` output formatter. To do this, simply use a `dict` in place of a `str` in the `message` argument to the logging function. For example:
```py
ch = alog.use_channel("FOO")
ch.debug({"foo": "bar"})
```
When a `dict` is logged with the `json` formatter enabled, all key/value pairs are added as key/value pairs under the top-level `message` key.
### Log Contexts
One of the most common uses for logging is to note events when a certain block of code executes. To facilitate this, `alog` has the concept of log contexts. The two primary contexts that `alog` supports are:
* `ContextLog`: This [contextmanager](https://docs.python.org/3/library/contextlib.html#contextlib.contextmanager) logs a `START:` message when the context starts and an `END:` message when the context ends. All messages produced within the same thread inside of the context will have an incremented level of indentation.
```py
import alog
alog.configure("debug2")
log = alog.use_channel("DEMO")
with alog.ContextLog(log.info, "Doing some work"):
log.debug("Deep in the muck!")
```
```
2021-07-29T19:09:03.819422 [DEMO :INFO] BEGIN: Doing some work
2021-07-29T19:09:03.820079 [DEMO :DBUG] Deep in the muck!
2021-07-29T19:09:03.820178 [DEMO :INFO] END: Doing some work
```
* `ContextTimer`: This [contextmanager](https://docs.python.org/3/library/contextlib.html#contextlib.contextmanager) starts a timer when the context begins and logs a message with the duration when the context ends.
```py
import alog
import time
alog.configure("debug2")
log = alog.use_channel("DEMO")
with alog.ContextTimer(log.info, "Slow work finished in: "):
log.debug("Starting the slow work")
time.sleep(1)
```
```
2021-07-29T19:12:00.887949 [DEMO :DBUG] Starting the slow work
2021-07-29T19:12:01.890839 [DEMO :INFO] Slow work finished in: 0:00:01.002793
```
### Function Decorators
In addition to arbitrary blocks of code that you may wish to scope or time, a very common use case for logging contexts is to provide function tracing. To this end, `alog` provides two useful function decorators:
* `@logged_function`: This [decorator](https://www.python.org/dev/peps/pep-0318/) wraps the `ContextLog` and provides a `START`/`END` scope where the message is prepopulated with the name of the function.
```py
import alog
alog.configure("debug")
log = alog.use_channel("DEMO")
@alog.logged_function(log.trace)
def foo():
log.debug("This is a test")
foo()
```
```
2021-07-29T19:16:40.036119 [DEMO :TRCE] BEGIN: foo()
2021-07-29T19:16:40.036807 [DEMO :DBUG] This is a test
2021-07-29T19:16:40.036915 [DEMO :TRCE] END: foo()
```
* `@timed_function`: This [decorator](https://www.python.org/dev/peps/pep-0318/) wraps the `ContextTimer` and performs a scoped timer on the entire function.
```py
import alog
import time
alog.configure("debug")
log = alog.use_channel("DEMO")
@alog.timed_function(log.trace)
def foo():
log.debug("This is a test")
time.sleep(1)
foo()
```
```
2021-07-29T19:19:47.468428 [DEMO :DBUG] This is a test
2021-07-29T19:19:48.471788 [DEMO :TRCE] 0:00:01.003284
```
## Tip
- Visual Studio Code (VSCode) users can take advantage of [alchemy-logging extension](https://marketplace.visualstudio.com/items?itemName=Gaurav-Kumbhat.alog-code-generator) that provides automatic log code generation and insertion.
%package -n python3-alchemy-logging
Summary: A wrapper around the logging package to provide Alchemy Logging functionality
Provides: python-alchemy-logging
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-alchemy-logging
# Alchemy Logging (alog) - Python
The `alog` framework provides tunable logging with easy-to-use defaults and power-user capabilities. The mantra of `alog` is **"Log Early And Often"**. To accomplish this goal, `alog` makes it easy to enable verbose logging at develop/debug time and trim the verbosity at production run time.
## Setup
To use the `alog` module, simply install it with `pip`:
```sh
pip install alchemy-logging
```
## Channels and Levels
The primary components of the framework are **channels** and **levels** which allow for each log statement to be enabled or disabled when appropriate.
1. **Levels**: Each logging statement is made at a specific level. Levels provide sequential granularity, allowing detailed debugging statements to be placed in the code without clogging up the logs at runtime. The sequence of levels and their general usage is as follows:
1. `off`: Disable the given channel completely
1. `fatal`: A fatal error has occurred. Any behavior after this statement should be regarded as undefined.
1. `error`: An unrecoverable error has occurred. Any behavior after this statement should be regarded as undefined unless the error is explicitly handled.
1. `warning`: A recoverable error condition has come up that the service maintainer should be aware of.
1. `info`: High-level information that is valuable at runtime under moderate load.
1. `trace`: Used to log begin/end of functions for debugging code paths.
1. `debug`: High-level debugging statements such as function parameters.
1. `debug1`: High-level debugging statements.
1. `debug2`: Mid-level debugging statements such as computed values.
1. `debug3`: Low-level debugging statements such as computed values inside loops.
1. `debug4`: Ultra-low-level debugging statements such as data dumps and/or statements inside multiple nested loops.
1. **Channels**: Each logging statement is made to a specific channel. Channels are independent of one another and allow for logical grouping of log messages by functionality. A channel can be any string. A channel may have a specific **level** assigned to it, or it may use the configured default level if it is not given a specific level filter.
Using this combination of **Channels** and **Levels**, you can fine-tune what log statements are enabled when you run your application under different circumstances.
## Usage
### Configuration
```py
import alog
if __name__ == "__main__":
alog.configure(default_level="info", filters="FOO:debug,BAR:off")
```
In this example, the channel `"FOO"` is set to the `debug` level, the channel `"BAR"` is fully disabled, and all other channels are set to use the `INFO` level.
In addition to the above, the `configure` function also supports the following arguments:
* `formatter`: May be `"pretty"`, `"json"`, or any class derived from `AlogFormatterBase`
* `thread_id`: Bool indicating whether or not to include a unique thread ID with the logging header (`pretty`) or structure (`json`).
* `handler_generator`: This allows users to provide their own output handlers and replace the standard handler that sends log messages to `stderr`. See [the `logging` documentation](https://docs.python.org/3/library/logging.handlers.html#module-logging.handlers) for details.
### Logging Functions
For each log level, there are two functions you can use to create log lines: The standard `logging` package function, or the corresponding `alog.use_channel(...).<level>` function. The former will always log to the `root` channel while the later requires that
a channel string be specified via `use_channel()`.
```py
import alog
import logging
def foo(age):
alog.use_channel("FOO").debug3(
"Debug3 line on the FOO channel with an int value %d!", age
)
logging.debug("debug line on the MAIN channel")
```
### Channel Log
In a given portion of code, it often makes sense to have a common channel that is used by many logging statements. Re-typing the channel name can be cumbersome and error-prone, so the concept of the **Channel Log** helps to eliminate this issue. To create a Channel Log, call the `use_channel` function. This gives you a handle to a channel log which has all of the same standard log functions as the top-level `alog`, but without the requirement to specify a channel. For example:
```py
import alog
log = alog.use_channel("FOO")
def foo(age):
log.info("Hello Logging World! I am %d years old", age)
```
**NOTE**: In this (python) implementation, this is simply a wrapper around `logging.getLogger()`
### Extra Log Information
There are several other types of information that `alog` supports adding to log records:
#### Log Codes
This is an optional argument to all logging functions which adds a specified code to the record. It can be useful for particularly high-profile messages (such as per-request error summaries in a server) that you want to be able to track in a programmatic way. The only requirement for a `log_code` is that it begin with `<` and end with `>`. The log code always comes before the `message`. For example:
```py
ch = alog.use_channel("FOO")
ch.debug("<FOO80349757I>", "Logging is fun!")
```
#### Dict Data
Sometimes, it's useful to log structured key/value pairs in a record, rather than a plain-text message, even when using the `pretty` output formatter. To do this, simply use a `dict` in place of a `str` in the `message` argument to the logging function. For example:
```py
ch = alog.use_channel("FOO")
ch.debug({"foo": "bar"})
```
When a `dict` is logged with the `json` formatter enabled, all key/value pairs are added as key/value pairs under the top-level `message` key.
### Log Contexts
One of the most common uses for logging is to note events when a certain block of code executes. To facilitate this, `alog` has the concept of log contexts. The two primary contexts that `alog` supports are:
* `ContextLog`: This [contextmanager](https://docs.python.org/3/library/contextlib.html#contextlib.contextmanager) logs a `START:` message when the context starts and an `END:` message when the context ends. All messages produced within the same thread inside of the context will have an incremented level of indentation.
```py
import alog
alog.configure("debug2")
log = alog.use_channel("DEMO")
with alog.ContextLog(log.info, "Doing some work"):
log.debug("Deep in the muck!")
```
```
2021-07-29T19:09:03.819422 [DEMO :INFO] BEGIN: Doing some work
2021-07-29T19:09:03.820079 [DEMO :DBUG] Deep in the muck!
2021-07-29T19:09:03.820178 [DEMO :INFO] END: Doing some work
```
* `ContextTimer`: This [contextmanager](https://docs.python.org/3/library/contextlib.html#contextlib.contextmanager) starts a timer when the context begins and logs a message with the duration when the context ends.
```py
import alog
import time
alog.configure("debug2")
log = alog.use_channel("DEMO")
with alog.ContextTimer(log.info, "Slow work finished in: "):
log.debug("Starting the slow work")
time.sleep(1)
```
```
2021-07-29T19:12:00.887949 [DEMO :DBUG] Starting the slow work
2021-07-29T19:12:01.890839 [DEMO :INFO] Slow work finished in: 0:00:01.002793
```
### Function Decorators
In addition to arbitrary blocks of code that you may wish to scope or time, a very common use case for logging contexts is to provide function tracing. To this end, `alog` provides two useful function decorators:
* `@logged_function`: This [decorator](https://www.python.org/dev/peps/pep-0318/) wraps the `ContextLog` and provides a `START`/`END` scope where the message is prepopulated with the name of the function.
```py
import alog
alog.configure("debug")
log = alog.use_channel("DEMO")
@alog.logged_function(log.trace)
def foo():
log.debug("This is a test")
foo()
```
```
2021-07-29T19:16:40.036119 [DEMO :TRCE] BEGIN: foo()
2021-07-29T19:16:40.036807 [DEMO :DBUG] This is a test
2021-07-29T19:16:40.036915 [DEMO :TRCE] END: foo()
```
* `@timed_function`: This [decorator](https://www.python.org/dev/peps/pep-0318/) wraps the `ContextTimer` and performs a scoped timer on the entire function.
```py
import alog
import time
alog.configure("debug")
log = alog.use_channel("DEMO")
@alog.timed_function(log.trace)
def foo():
log.debug("This is a test")
time.sleep(1)
foo()
```
```
2021-07-29T19:19:47.468428 [DEMO :DBUG] This is a test
2021-07-29T19:19:48.471788 [DEMO :TRCE] 0:00:01.003284
```
## Tip
- Visual Studio Code (VSCode) users can take advantage of [alchemy-logging extension](https://marketplace.visualstudio.com/items?itemName=Gaurav-Kumbhat.alog-code-generator) that provides automatic log code generation and insertion.
%package help
Summary: Development documents and examples for alchemy-logging
Provides: python3-alchemy-logging-doc
%description help
# Alchemy Logging (alog) - Python
The `alog` framework provides tunable logging with easy-to-use defaults and power-user capabilities. The mantra of `alog` is **"Log Early And Often"**. To accomplish this goal, `alog` makes it easy to enable verbose logging at develop/debug time and trim the verbosity at production run time.
## Setup
To use the `alog` module, simply install it with `pip`:
```sh
pip install alchemy-logging
```
## Channels and Levels
The primary components of the framework are **channels** and **levels** which allow for each log statement to be enabled or disabled when appropriate.
1. **Levels**: Each logging statement is made at a specific level. Levels provide sequential granularity, allowing detailed debugging statements to be placed in the code without clogging up the logs at runtime. The sequence of levels and their general usage is as follows:
1. `off`: Disable the given channel completely
1. `fatal`: A fatal error has occurred. Any behavior after this statement should be regarded as undefined.
1. `error`: An unrecoverable error has occurred. Any behavior after this statement should be regarded as undefined unless the error is explicitly handled.
1. `warning`: A recoverable error condition has come up that the service maintainer should be aware of.
1. `info`: High-level information that is valuable at runtime under moderate load.
1. `trace`: Used to log begin/end of functions for debugging code paths.
1. `debug`: High-level debugging statements such as function parameters.
1. `debug1`: High-level debugging statements.
1. `debug2`: Mid-level debugging statements such as computed values.
1. `debug3`: Low-level debugging statements such as computed values inside loops.
1. `debug4`: Ultra-low-level debugging statements such as data dumps and/or statements inside multiple nested loops.
1. **Channels**: Each logging statement is made to a specific channel. Channels are independent of one another and allow for logical grouping of log messages by functionality. A channel can be any string. A channel may have a specific **level** assigned to it, or it may use the configured default level if it is not given a specific level filter.
Using this combination of **Channels** and **Levels**, you can fine-tune what log statements are enabled when you run your application under different circumstances.
## Usage
### Configuration
```py
import alog
if __name__ == "__main__":
alog.configure(default_level="info", filters="FOO:debug,BAR:off")
```
In this example, the channel `"FOO"` is set to the `debug` level, the channel `"BAR"` is fully disabled, and all other channels are set to use the `INFO` level.
In addition to the above, the `configure` function also supports the following arguments:
* `formatter`: May be `"pretty"`, `"json"`, or any class derived from `AlogFormatterBase`
* `thread_id`: Bool indicating whether or not to include a unique thread ID with the logging header (`pretty`) or structure (`json`).
* `handler_generator`: This allows users to provide their own output handlers and replace the standard handler that sends log messages to `stderr`. See [the `logging` documentation](https://docs.python.org/3/library/logging.handlers.html#module-logging.handlers) for details.
### Logging Functions
For each log level, there are two functions you can use to create log lines: The standard `logging` package function, or the corresponding `alog.use_channel(...).<level>` function. The former will always log to the `root` channel while the later requires that
a channel string be specified via `use_channel()`.
```py
import alog
import logging
def foo(age):
alog.use_channel("FOO").debug3(
"Debug3 line on the FOO channel with an int value %d!", age
)
logging.debug("debug line on the MAIN channel")
```
### Channel Log
In a given portion of code, it often makes sense to have a common channel that is used by many logging statements. Re-typing the channel name can be cumbersome and error-prone, so the concept of the **Channel Log** helps to eliminate this issue. To create a Channel Log, call the `use_channel` function. This gives you a handle to a channel log which has all of the same standard log functions as the top-level `alog`, but without the requirement to specify a channel. For example:
```py
import alog
log = alog.use_channel("FOO")
def foo(age):
log.info("Hello Logging World! I am %d years old", age)
```
**NOTE**: In this (python) implementation, this is simply a wrapper around `logging.getLogger()`
### Extra Log Information
There are several other types of information that `alog` supports adding to log records:
#### Log Codes
This is an optional argument to all logging functions which adds a specified code to the record. It can be useful for particularly high-profile messages (such as per-request error summaries in a server) that you want to be able to track in a programmatic way. The only requirement for a `log_code` is that it begin with `<` and end with `>`. The log code always comes before the `message`. For example:
```py
ch = alog.use_channel("FOO")
ch.debug("<FOO80349757I>", "Logging is fun!")
```
#### Dict Data
Sometimes, it's useful to log structured key/value pairs in a record, rather than a plain-text message, even when using the `pretty` output formatter. To do this, simply use a `dict` in place of a `str` in the `message` argument to the logging function. For example:
```py
ch = alog.use_channel("FOO")
ch.debug({"foo": "bar"})
```
When a `dict` is logged with the `json` formatter enabled, all key/value pairs are added as key/value pairs under the top-level `message` key.
### Log Contexts
One of the most common uses for logging is to note events when a certain block of code executes. To facilitate this, `alog` has the concept of log contexts. The two primary contexts that `alog` supports are:
* `ContextLog`: This [contextmanager](https://docs.python.org/3/library/contextlib.html#contextlib.contextmanager) logs a `START:` message when the context starts and an `END:` message when the context ends. All messages produced within the same thread inside of the context will have an incremented level of indentation.
```py
import alog
alog.configure("debug2")
log = alog.use_channel("DEMO")
with alog.ContextLog(log.info, "Doing some work"):
log.debug("Deep in the muck!")
```
```
2021-07-29T19:09:03.819422 [DEMO :INFO] BEGIN: Doing some work
2021-07-29T19:09:03.820079 [DEMO :DBUG] Deep in the muck!
2021-07-29T19:09:03.820178 [DEMO :INFO] END: Doing some work
```
* `ContextTimer`: This [contextmanager](https://docs.python.org/3/library/contextlib.html#contextlib.contextmanager) starts a timer when the context begins and logs a message with the duration when the context ends.
```py
import alog
import time
alog.configure("debug2")
log = alog.use_channel("DEMO")
with alog.ContextTimer(log.info, "Slow work finished in: "):
log.debug("Starting the slow work")
time.sleep(1)
```
```
2021-07-29T19:12:00.887949 [DEMO :DBUG] Starting the slow work
2021-07-29T19:12:01.890839 [DEMO :INFO] Slow work finished in: 0:00:01.002793
```
### Function Decorators
In addition to arbitrary blocks of code that you may wish to scope or time, a very common use case for logging contexts is to provide function tracing. To this end, `alog` provides two useful function decorators:
* `@logged_function`: This [decorator](https://www.python.org/dev/peps/pep-0318/) wraps the `ContextLog` and provides a `START`/`END` scope where the message is prepopulated with the name of the function.
```py
import alog
alog.configure("debug")
log = alog.use_channel("DEMO")
@alog.logged_function(log.trace)
def foo():
log.debug("This is a test")
foo()
```
```
2021-07-29T19:16:40.036119 [DEMO :TRCE] BEGIN: foo()
2021-07-29T19:16:40.036807 [DEMO :DBUG] This is a test
2021-07-29T19:16:40.036915 [DEMO :TRCE] END: foo()
```
* `@timed_function`: This [decorator](https://www.python.org/dev/peps/pep-0318/) wraps the `ContextTimer` and performs a scoped timer on the entire function.
```py
import alog
import time
alog.configure("debug")
log = alog.use_channel("DEMO")
@alog.timed_function(log.trace)
def foo():
log.debug("This is a test")
time.sleep(1)
foo()
```
```
2021-07-29T19:19:47.468428 [DEMO :DBUG] This is a test
2021-07-29T19:19:48.471788 [DEMO :TRCE] 0:00:01.003284
```
## Tip
- Visual Studio Code (VSCode) users can take advantage of [alchemy-logging extension](https://marketplace.visualstudio.com/items?itemName=Gaurav-Kumbhat.alog-code-generator) that provides automatic log code generation and insertion.
%prep
%autosetup -n alchemy-logging-1.1.1
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "\"/%h/%f.gz\"\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-alchemy-logging -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Tue Jun 20 2023 Python_Bot <Python_Bot@openeuler.org> - 1.1.1-1
- Package Spec generated
|