ball_recordformattertimezone

Detailed Description

Enumerate a set of timezone defaults for log timestamps.

Outline

• Purpose
• Classes
• Description
  • Usage
    • Example 1: Selecting Timestamp Timezone for Logging

Purpose

Enumerate a set of timezone defaults for log timestamps.

Classes

• ball::RecordFormatterTimezone: namespace for enumerating timezones

Description

This component provides a namespace, ball::RecordFormatterTimezone, for the enum type ball::RecordFormatterTimezone::Enum. Enum enumerates a list of time stamp timezone values that log record formatters may apply.

Usage

This section illustrates intended use of this component.

Example 1: Selecting Timestamp Timezone for Logging

Suppose we are implementing a logging system and need to allow users to configure whether timestamps should be rendered in UTC or local time. We can use ball::RecordFormatterTimezone::Enum to represent this choice.

First, we define a variable to hold the configured timezone setting, defaulting to UTC:

 ball::RecordFormatterTimezone::Enum timezone =
                                       ball::RecordFormatterTimezone::e_UTC;

Then, based on user configuration, we might change this to local time:

 bool useLocalTime = true;  // from user configuration
 
 if (useLocalTime) {
     timezone = ball::RecordFormatterTimezone::e_LOCAL;
 }

Finally, we can use this value to control timestamp formatting:

 if (ball::RecordFormatterTimezone::e_LOCAL == timezone) {
     // Format timestamp in local time
 }
 else {
     // Format timestamp in UTC
 }

This allows timestamps in log records to be rendered in either UTC (useful for distributed systems and log aggregation) or local time (useful for local debugging and human readability).

assert(ball::RecordFormatterTimezone::e_LOCAL == timezone);