URLs, headers, stack traces and request bodies can contain API tokens. Redact secrets before writing diagnostic logs. Prefer minimal event metadata.
What You Will Learn
This lesson focuses on Avoid Logging Tokens or Credentials. You will connect the operation to a concrete input, inspect the result and identify the situation in which a different approach would be safer or clearer.
Network programs cross process and machine boundaries. Connections may fail, responses can be delayed, and data received from another system must be treated as untrusted until checked.
How It Works
Separate endpoint selection, transport, protocol parsing and application validation. A successful connection does not mean the remote application returned complete or correct data.
Worked Example
The following example isolates the main behavior so you can run it from a local Python installation. Read the inputs first, then follow the operation and the final printed result.
def redact_headers(headers):
sensitive = {"authorization", "x-api-key", "cookie"}
return {k: ("[redacted]" if k.lower() in sensitive else v) for k, v in headers.items()}
print(redact_headers({"Authorization": "Bearer secret", "Accept": "application/json"}))Understanding the Example
Start with the setup and import statements; these define the objects that the operation needs. Follow each assignment or function call in order, noting which arguments are provided and whether the operation creates a new value, changes existing state or returns a result. Finally, inspect the printed value or assertion rather than assuming that the operation worked.
The important behavior demonstrated here is: URLs, headers, stack traces and request bodies can contain API tokens. Redact secrets before writing diagnostic logs. Prefer minimal event metadata. The example uses deliberately small values so the intermediate result is easy to reason about. A larger application must still handle validation, errors and resource cleanup.
Environment note: this example may require a separately installed package, local service, platform permission or network connection. Set up the indicated environment before running it; it has not been executed automatically for this guide.
When to Use This Approach
Begin with localhost and small, deterministic examples. Add external services only when the program has timeout, retry, credential and observability requirements.
Important Behavior and Edge Cases
Logging an exception with the complete Authorization header or putting tokens in query strings.
Set timeouts, limit input sizes and validate permitted destinations before accessing user-controlled URLs. Handle socket and HTTP errors specifically, and close connections reliably.
Practice Exercise
Build a structured log record containing only the endpoint path, status and elapsed milliseconds.
Before running your modified code, predict the output or expected failure. Confirm the result using at least one ordinary case and one invalid, missing or boundary input. If the operation accesses external resources, first exercise it against a controlled local or test environment.
Common Beginner Mistakes
- Logging an exception with the complete Authorization header or putting tokens in query strings.
- Set timeouts, limit input sizes and validate permitted destinations before accessing user-controlled URLs. Handle socket and HTTP errors specifically, and close connections reliably.
Key Takeaways
- URLs, headers, stack traces and request bodies can contain API tokens. Redact secrets before writing diagnostic logs. Prefer minimal event metadata.
- Choose this technique for the problem it solves, but validate inputs and follow the cleanup and failure behavior shown above.
- Next practice step: Build a structured log record containing only the endpoint path, status and elapsed milliseconds.