logging

Software writes messages to a log while running. A message might record a user signing in, a background task starting or an integration returning an error. Together, these messages provide a record of what happened in the application and its underlying systems.

What does a log message contain?

A log message usually contains a timestamp, an event description and a level such as information, warning or error. It often includes context such as a service name, request ID or software version. Developers can use this information to connect messages from different components and reconstruct the sequence of events.

Good logging records enough to understand a problem without storing passwords, access keys or unnecessary personal data. Which information is useful and how long logs are retained depend on the system and the purpose of the records.

Logging, monitoring and exception tracking

MonitoringGlossary · In briefmonitoringMonitoring systematically tracks software, infrastructure or processes through measurements and checks. Deviations can trigger alerts so an administrator can investigate.Read more uses log data and other measurements to track software health and issue alerts when something deviates from expectations. Logging supplies data for this but does not itself check whether the system works correctly.

Exception trackingGlossary · In briefexception trackingException tracking automatically records and groups errors that occur while software is running. It gives developers information to investigate an error's cause and impact.Read more focuses on errors captured by the software. It groups similar errors and adds technical context. Logging is broader: a successful import, a started task or a changed setting can also be logged. An audit trailGlossary · In briefaudit trailAn audit trail is a chronological record of actions and changes in a system. It shows who or what performed an action, when it happened and what changed.Read more is more specific and records who performed a relevant action.