{"id":9670,"date":"2025-06-16T09:43:53","date_gmt":"2025-06-16T09:43:53","guid":{"rendered":"https:\/\/www.examsnap.com\/certification\/?p=9670"},"modified":"2026-10-28T07:43:09","modified_gmt":"2026-10-28T07:43:09","slug":"logging-in-python-what-every-developer-should-know","status":"publish","type":"post","link":"https:\/\/www.examsnap.com\/certification\/logging-in-python-what-every-developer-should-know\/","title":{"rendered":"Logging in Python: What Every Developer Should Know"},"content":{"rendered":"

Logging records meaningful application events so developers and operators can explain what happened before, during and after a failure. Python’s standard logging<\/code> module lets applications emit messages with severity, context and tracebacks without scattering print()<\/code> calls throughout production code. Good logging is selective: it communicates actionable facts without leaking credentials or overwhelming storage.<\/p>\n

This guide covers logger configuration, levels, handlers, formatters, error tracebacks, modules, security and testing. It replaces ambiguous code fragments with complete Python 3 examples and distinguishes local troubleshooting from centralized production observability.<\/p>\n

Start with the logging levels<\/h2>\n

The standard levels are DEBUG<\/code>, INFO<\/code>, WARNING<\/code>, ERROR<\/code> and CRITICAL<\/code>. They indicate increasing severity, not simply different formatting. A successful routine request might deserve no log; a failed external dependency or unexpected exception needs enough context to investigate.<\/p>\n

Choose thresholds according to the environment. A noisy debug configuration can be useful in a disposable test, but expensive or sensitive in production. The default behavior may filter messages below WARNING unless explicitly configured.<\/p>\n

import logging\nlogging.basicConfig(level=logging.INFO)\nlogging.debug(\"detail hidden at INFO\")\nlogging.info(\"worker initialized\")\nlogging.warning(\"retrying dependency\")<\/code><\/pre>\n
Use named loggers in modules<\/h2>\n
A module normally gets a logger with logging.getLogger(__name__)<\/code>. Libraries should not configure the application’s root logging policy, because the application or service owner needs to decide where messages go. The hierarchy of logger names enables different thresholds for different components.<\/p>\n
Avoid creating a new logger name containing an individual user’s identifier or other high-cardinality value. Put selected identifiers in message context instead, with privacy controls.<\/p>\n
import logging\nlogger = logging.getLogger(__name__)\ndef process(task_id):\n    logger.info(\"processing task=%s\", task_id)<\/code><\/pre>\n
Configure handlers and formatters deliberately<\/h2>\n
A handler sends accepted records to a destination such as standard error, a file or a queue. A formatter defines how fields such as timestamps, severity, logger name and message appear. Handlers and loggers can both filter events, so understand propagation before attaching several handlers.<\/p>\n
For a small command-line application, one basicConfig()<\/code> call in the program’s entry point may be enough. In an application server, use a centralized logging configuration or the host’s supported instrumentation rather than configuring handlers in every imported module.<\/p>\n
logging.basicConfig(\n    level=logging.INFO,\n    format=\"%(asctime)s %(levelname)s %(name)s: %(message)s\",\n)<\/code><\/pre>\n
Prefer lazy message interpolation<\/h2>\n
Pass format arguments separately to logger.info()<\/code> and related methods. The logging module can defer formatting until the record actually needs to be emitted. An f-string is evaluated eagerly, even when that log level is disabled. This difference matters for expensive string construction.<\/p>\n
Never place secrets, access tokens, passwords or unnecessary personal data in format arguments. Logs are copied into systems with different retention and access policies; a masked field is safer than logging a sensitive value with the intention to delete it later.<\/p>\n
logger.debug(\"item %s has %d attributes\", item_id, count)\n# Avoid logging secrets or raw authorization headers.<\/code><\/pre>\n
Capture exceptions with useful context<\/h2>\n
Inside an exception handler, logger.exception()<\/code> records an ERROR message and the active traceback. Outside that context, use exc_info=True<\/code> only when you actually have meaningful exception information. Avoid logging the same failure repeatedly at every stack layer.<\/p>\n
A good message states the operation and relevant safe identifiers rather than just \u201cerror happened.\u201d Decide whether an exception should be retried, propagated or handled; writing a log is not a substitute for correct control flow.<\/p>\n
try:\n    result = int(\"not-a-number\")\nexcept ValueError:\n    logger.exception(\"could not parse numeric field\")<\/code><\/pre>\n
Manage files, rotation and processes<\/h2>\n
A plain file handler does not automatically implement your retention policy. For simple single-process scenarios, rotating file handlers may help bound file sizes. Containerized or hosted applications often prefer structured records on stdout or stderr for a collector to capture.<\/p>\n
Multiple worker processes may need process-safe collection instead of writing concurrently to the same file without coordination. Test log rotation, permissions, disk space and behavior during service restart rather than assuming the handler alone solves operations.<\/p>\n
from logging.handlers import RotatingFileHandler\nhandler = RotatingFileHandler(\n    \"app.log\", maxBytes=2_000_000, backupCount=3\n)\nlogger.addHandler(handler)<\/code><\/pre>\n
Keep structured and correlated context<\/h2>\n
Useful context can include a request ID, operation name, duration, outcome and sanitized entity ID. The fields should help connect a failure across components. Do not treat free-form human text as the only possible representation of an incident.<\/p>\n
For larger systems, consider structured JSON logs, metrics and tracing together. Logs answer what happened at specific points; metrics reveal aggregates, while traces can show a request path. None should replace safe access control, sampling or retention limits.<\/p>\n
Test log behavior and avoid duplication<\/h2>\n
Write tests that assert important messages and levels without depending on exact timestamps. In pytest, a captured-log fixture can help. Repeated calls to basicConfig()<\/code> may do nothing once handlers already exist unless force=True<\/code> is intentionally supplied in supported Python versions.<\/p>\n
Double propagation can cause duplicate records if a child and parent both have handlers. Use a single clear configuration owner, and validate the output with the actual deployment runner.<\/p>\n
Conclusion<\/h2>\n
Good Python logging makes failures diagnosable while respecting the privacy and cost of recorded information. Choose meaningful levels, one configuration owner, contextual but safe messages and tested handlers. Pair logging with responsible command-line inputs as described in the Python argument parsing guide<\/a>, and consult the official Python logging reference<\/a> for handler and formatter semantics.<\/p>\n","protected":false},"excerpt":{"rendered":"
Logging records meaningful application events so developers and operators can explain what happened before, during and after a failure. Python’s standard logging module lets applications emit messages with severity, context and tracebacks without scattering print() calls throughout production code. Good logging is selective: it communicates actionable facts without leaking credentials or overwhelming storage. This guide covers logger configuration, levels, handlers, formatters, error tracebacks, modules, security and testing. It replaces ambiguous code fragments with complete Python 3 examples and distinguishes local troubleshooting from centralized production observability. Start with the logging levels…<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[711],"tags":[],"class_list":["post-9670","post","type-post","status-publish","format-standard","hentry","category-programming"],"aioseo_notices":[],"aioseo_head":"\n\t\t\n\t\n\t\n\t\n\t\n\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t