Inspecting logs

All gd.Guard calls are logged internally, and can be accessed via two methods, gd.Guard.guard_state or guardrails.log.

🪵 Accessing logs via guardrails.log

This is the simplest way to access logs. It returns a list of all gd.Guard calls, in the order they were made.

In order to access logs, run:

eliot-tree --output-format=ascii guardrails.log

🇻🇦 Accessing logs via gd.Guard.guard_state

guard_state is an attribute of the gd.Guard class. It contains:

1. A list of all gd.Guard calls, in the order they were made.
2. For each call, reasks needed and their results.

To pretty print logs, run:

from rich import print

print(guard.state.most_recent_call.tree)

To access fine-grained logs on field validation, see the FieldValidationLogs object:

validation_logs = guard.guard_state.all_histories[0].history[0].field_validation_logs
print(validation_logs.json(indent=2))

{
  "validator_logs": [],
  "children": {
    "name": {
      "validator_logs": [
        {
          "validator_name": "TwoWords",
          "value_before_validation": "peter parker the second",
          "validation_result": {
            "outcome": "fail",
            "metadata": null,
            "error_message": "must be exactly two words",
            "fix_value": "peter parker"
          },
          "value_after_validation": {
            "incorrect_value": "peter parker the second",
            "fail_results": [
              {
                "outcome": "fail",
                "metadata": null,
                "error_message": "must be exactly two words",
                "fix_value": "peter parker"
              }
            ],
            "path": [
              "name"
            ]
          }
        }
      ],
      "children": {}
    }
  }
}