Skip to content

Commit

Permalink
vdk-structlog: update README.md (#3047)
Browse files Browse the repository at this point in the history 
Add info about bound loggers and syslog support

---------

Signed-off-by: Dilyan Marinov <mdilyan@vmware.com>
Co-authored-by: Dilyan Marinov <mdilyan@vmware.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
  • Loading branch information
@DeltaMichael @pre-commit-ci
3 people committed Jan 30, 2024
1 parent 64864b1 commit f1c24b5
Showing 1 changed file with 141 additions and 25 deletions.
166 changes: 141 additions & 25 deletions projects/vdk-plugins/vdk-structlog/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ This plugin allows users to:
- select the log output format
- configure the logging metadata
- display metadata added by bound loggers
- emit logs to syslog

For a more in-depth technical analysis, check out [VEP-2448](https://github.com/vmware/versatile-data-kit/blob/main/specs/vep-2448-vdk-run-logs-simplified-and-readable/README.md)

## Usage

Expand All @@ -16,28 +19,36 @@ pip install vdk-structlog

### Configuration

(`vdk config-help` is useful command to browse all config options of your installation of vdk)
(`vdk config-help` is a useful command to browse all config options of your installation of vdk)

| Name | Description | Example Value | Possible Values |
|----------------------------|---------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------|
| logging_metadata | Configure the metadata that will be output along with the log message | "timestamp, level, logger_name, file_name, vdk_job_name | "timestamp, level, logger_name, file_name, line_number, function_name, vdk_job_name, vdk_step_name, vdk_step_type" |
| logging_format | Configure the logging output format. Available formats: json, console | "console" | "console", "json" |
| custom_console_log_pattern | Custom format string for console logging, applied only when`logging_format` is 'console' and overrides `logging_metadata` | "%(asctime)s %(name)-12s %(levelname)-8s %(message)s" | Any valid Python logging format string |
| log_level_module | Configure the log level of different Python modules separately | "a.b.c=INFO;foo.bar=ERROR" | Semicolon-separated list of pairs of Python module paths and log level labels |
| Name | Description | Example Value | Possible Values |
|----------------------------|-------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| logging_metadata | Configure the metadata that will be output along with the log message | "timestamp, level, logger_name, file_name, vdk_job_name | Any combination of the following: "timestamp, level, logger_name, file_name, line_number, function_name, vdk_job_name, vdk_step_name, vdk_step_type". Can be expanded by extra params and bound key-value pairs. See the bound logger examples for more information |
| logging_format | Configure the logging output format. Available formats: json, console | "console" | "console", "json", "ltsv" |
| custom_console_log_pattern | Custom format string for console logging, applied only when`logging_format` is 'console'. Overrides `logging_metadata`. | "%(asctime)s %(name)-12s %(levelname)-8s %(message)s" | Any valid Python logging format string |
| log_level_module | Configure the log level of different Python modules separately | "a.b.c=INFO;foo.bar=ERROR" | Semicolon-separated list of pairs of Python module paths and log level labels |
| syslog_host | Syslog host to which logs are emitted | "syslog.vmware.com" | Any valid host name |
| syslog_port | Syslog port used to emit logs | 514 | Any valid port number |
| syslog_protocol | Protocol used to emit logs | "UDP" | "TCP", "UDP" |
| syslog_enabled | Enable/disable syslog | "True" | "True", "False" |

### Example: Configure Custom Console Format

If you wish to apply a specific format to your console logs, you can define a custom format using the `custom_console_log_pattern` configuration. This custom format string will be used only when the `logging_format` is set to 'console'.
If you wish to apply a specific format to your console logs, you can define a
custom format using the `custom_console_log_pattern` configuration. This custom
format string will be used only when the `logging_format` is set to 'console'.

For example, add the following to your data job configuration:

```
```ini
[vdk]
custom_console_log_pattern=%(asctime)s %(name)-12s %(levelname)-8s %(message)s
```
When you run your data job, regardless of other logging settings, your logs will strictly follow this custom format, displaying the timestamp, logger's name, log level, and the log message as per the format string specified.
When you run your data job, regardless of other logging settings, your logs will
strictly follow this custom format, displaying the timestamp, logger's name, log
level, and the log message as per the format string specified.

```
```log
2023-10-17 11:20:59,202 managed_cursor INFO ingest-from-db-example-job - Executing query SUCCEEDED. Query duration 00h:00m:00s
2023-10-17 11:20:59,202 managed_connectio INFO ingest-from-db-example-job - Fetching query result...
2023-10-17 11:20:59,202 managed_cursor INFO ingest-from-db-example-job - Fetching all results from query ...
Expand All @@ -54,7 +65,7 @@ When you run your data job, regardless of other logging settings, your logs will

Create a data job and add the following config options

```
```ini
[vdk]
logging_metadata=timestamp,level,file_name,vdk_job_name
logging_format=console
Expand All @@ -64,7 +75,7 @@ Then run the data job. You should see just the configured tags where relevant.
For example, you won't see the vdk_job_name outside of log statements directly
related to job execution.

```
```log
2023-10-17 11:20:59,202 [VDK] [INFO ] managed_cursor.py ingest-from-db-example-job - Executing query SUCCEEDED. Query duration 00h:00m:00s
2023-10-17 11:20:59,202 [VDK] [INFO ] managed_connection_b ingest-from-db-example-job - Fetching query result...
2023-10-17 11:20:59,202 [VDK] [INFO ] managed_cursor.py ingest-from-db-example-job - Fetching all results from query ...
Expand All @@ -78,14 +89,15 @@ related to job execution.

Now, let's remove the timestamp from the configuration and add the line number

```
```ini
[vdk]
logging_metadata=level,file_name,line_number,vdk_job_name
logging_format=console
```

And run the job again

```
```log
[INFO ] managed_cursor.py :97 ingest-from-db-example-job - Executing query SUCCEEDED. Query duration 00h:00m:00s
[INFO ] managed_connection_b :133 ingest-from-db-example-job - Fetching query result...
[INFO ] managed_cursor.py :193 ingest-from-db-example-job - Fetching all results from query ...
Expand All @@ -101,7 +113,7 @@ And run the job again

Create a data job and add the following config options

```
```ini
[vdk]
logging_metadata=timestamp,level,file_name,vdk_job_name
logging_format=json
Expand All @@ -123,11 +135,112 @@ And you should see json-formatted logs.

### Example: Bound loggers

TODO: Add an example once bound loggers are part of vdk-core
Python's logging module allows you to pass extra params as a dict. vdk-structlog
takes this into account and displays the extra params, as long as they're added
to `structlog_metadata` in config.ini

```python
import logging
import uuid

log = logging.getLogger(__name__)

myid = uuid.uuid4()
log.info(f"Starting job step {__name__}")
log.info("This is an info log statement with extra stuff.", extra={"uuid": myid})
```

```ini
[vdk]
structlog_metadata=timestamp,level,logger_name,file_name,line_number,function_name,uuid
structlog_format=console
```

```log
2024-01-16 10:16:53,237 [VDK] [INFO ] step_20_python_ste 20_python_step.py :21 run - Starting job step step_20_python_ste
2024-01-16 10:16:53,237 [VDK] [INFO ] step_20_python_ste 20_python_step.py :22 run 78118954-fe0c-451d-80cf-9b9bc80b8140 - This is an info log statement with extra stuff
```

This is fine, however, if we want to have the same uuid with multiple log
statements, it's not very convenient to pass it every time. `vdk` offers a
function to solve this problem.

```python
import logging
import uuid
from vdk.internal.core.logging import bind_logger

log = logging.getLogger(__name__)

log.info(f"Starting job step {__name__}")

myid = uuid.uuid4()
bound_log = bind_logger(log, {"uuid": myid})
bound_log.info("This is an info log statement with extra stuff")
bound_log.info("This is another log statement with uuid")
```

```ini
[vdk]
structlog_metadata=timestamp,level,logger_name,file_name,line_number,function_name,uuid
structlog_format=console
```

Now every time you log using the bound logger, you have the uuid attached.

```log
2024-01-16 10:31:04,761 [VDK] [INFO ] step_20_python_ste 20_python_step.py :22 run - Starting job step step_20_python_ste
2024-01-16 10:31:04,761 [VDK] [INFO ] step_20_python_ste 20_python_step.py :25 run ed1e447d-3746-4068-8a83-353176327985 - This is an info log statement with extra stuff
2024-01-16 10:31:04,761 [VDK] [INFO ] step_20_python_ste 20_python_step.py :26 run ed1e447d-3746-4068-8a83-353176327985 - This is another log statement with uuid
```

Bound loggers act the same as regular loggers. You can even pass extra params to
them, or bind additional context.

```python
import logging
import uuid
from vdk.internal.core.logging import bind_logger

log = logging.getLogger(__name__)

log.info(f"Starting job step {__name__}")

### Example: Passing custom metadata fields with extra_params
myid = uuid.uuid4()
bound_log = bind_logger(log, {"uuid": myid})
bound_log.info("This is an info log statement with extra stuff")
bound_log.info("This is another log statement with uuid")
bound_log.info("More stuff", extra={"new_key": "new_value", "extra_key":"more_value"})
rebound_log = bind_logger(bound_log, {"another_key": "another_value"})
```

```ini
[vdk]
structlog_metadata=timestamp,level,logger_name,file_name,line_number,function_name,uuid,new_key,another_key,extra_key
structlog_format=console
```

### Syslog support

Outputting logs to a syslog server is supported with the following config
options

TODO: Add an example
```ini
[vdk]
syslog_host=localhost
syslog_port=514
syslog_protocol=UDP
syslog_enabled=True
```

The syslog output format is set to `console` and the following formatter string
is used. These are currently not configurable.

```python
DETAILED_FORMAT =
"%(asctime)s [VDK] %(job_name)s [%(levelname)-5.5s] %(name)-30.30s %(filename)20.20s:%("
"lineno)-4.4s %(funcName)-16.16s[id:%(attempt_id)s]- %(message)s"
```

### Build and test

Expand All @@ -137,15 +250,18 @@ pip install -e .
pytest
```

In VDK repo [../build-plugin.sh](https://github.com/vmware/versatile-data-kit/tree/main/projects/vdk-plugins/build-plugin.sh) script can be used also.
The
[../build-plugin.sh](https://github.com/vmware/versatile-data-kit/tree/main/projects/vdk-plugins/build-plugin.sh)
script can be used also.


#### Note about the CICD:

.plugin-ci.yaml is needed only for plugins part of [Versatile Data Kit Plugin repo](https://github.com/vmware/versatile-data-kit/tree/main/projects/vdk-plugins).

The CI/CD is separated in two stages, a build stage and a release stage.
The build stage is made up of a few jobs, all which inherit from the same
job configuration and only differ in the Python version they use (3.7, 3.8, 3.9 and 3.10).
They run according to rules, which are ordered in a way such that changes to a
plugin's directory trigger the plugin CI, but changes to a different plugin does not.
The CI/CD is separated in two stages, a build stage and a release stage. The
build stage is made up of a few jobs, all which inherit from the same job
configuration and only differ in the Python version they use (3.7, 3.8, 3.9 and
3.10). They run according to rules, which are ordered in a way such that changes
to a plugin's directory trigger the plugin CI, but changes to a different plugin
does not.

0 comments on commit f1c24b5

Please sign in to comment.