Inherits from DDAbstractLogger : NSObject
Conforms to DDLogger
Declared in DDTTYLogger.h

Overview

This class provides a logger for Terminal output or Xcode console output, depending on where you are running your code.

As described in the “Getting Started” page, the traditional NSLog() function directs it’s output to two places:

  • Apple System Log (so it shows up in Console.app)
  • StdErr (if stderr is a TTY, so log statements show up in Xcode console)

To duplicate NSLog() functionality you can simply add this logger and an asl logger. However, if you instead choose to use file logging (for faster performance), you may choose to use only a file logger and a tty logger.

Tasks

Properties

automaticallyAppendNewlineForCustomFormatters

@property (nonatomic, readwrite, assign) BOOL automaticallyAppendNewlineForCustomFormatters
Discussion

When using a custom formatter you can set the logMessage method not to append ‘\n’ character after each output. This allows for some greater flexibility with custom formatters. Default value is YES.

Declared In

DDTTYLogger.h

colorsEnabled

@property (readwrite, assign) BOOL colorsEnabled
Discussion

Want to use different colors for different log levels? Enable this property.

If you run the application via the Terminal (not Xcode), the logger will map colors to xterm-256color or xterm-color (if available).

Xcode does NOT natively support colors in the Xcode debugging console. You’ll need to install the XcodeColors plugin to see colors in the Xcode console. https://github.com/robbiehanson/XcodeColors

The default value is NO.

Declared In

DDTTYLogger.h

Class Methods

sharedInstance

+ (instancetype)sharedInstance

Instance Methods

clearAllColors

- (void)clearAllColors

clearColorsForAllFlags

- (void)clearColorsForAllFlags

clearColorsForAllTags

- (void)clearColorsForAllTags

clearColorsForFlag:

- (void)clearColorsForFlag:(DDLogFlag)mask
Discussion

Clearing color profiles.

Declared In

DDTTYLogger.h

clearColorsForFlag:context:

- (void)clearColorsForFlag:(DDLogFlag)mask context:(NSInteger)context

clearColorsForTag:

- (void)clearColorsForTag:(id<NSCopying>)tag

setForegroundColor:backgroundColor:forFlag:

- (void)setForegroundColor:(DDColor *)txtColor backgroundColor:(DDColor *)bgColor forFlag:(DDLogFlag)mask
Discussion

The default color set (foregroundColor, backgroundColor) is:

  • DDLogFlagError = (red, nil)
  • DDLogFlagWarning = (orange, nil)

You can customize the colors however you see fit. Please note that you are passing a flag, NOT a level.

GOOD : [ttyLogger setForegroundColor:pink backgroundColor:nil forFlag:DDLogFlagInfo]; // <- Good :) BAD : [ttyLogger setForegroundColor:pink backgroundColor:nil forFlag:DDLogLevelInfo]; // <- BAD! :(

DDLogFlagInfo = 0…00100 DDLogLevelInfo = 0…00111 <- Would match DDLogFlagInfo and DDLogFlagWarning and DDLogFlagError

If you run the application within Xcode, then the XcodeColors plugin is required.

If you run the application from a shell, then DDTTYLogger will automatically map the given color to the closest available color. (xterm-256color or xterm-color which have 256 and 16 supported colors respectively.)

This method invokes setForegroundColor:backgroundColor:forFlag:context: and applies it to LOG_CONTEXT_ALL.

Declared In

DDTTYLogger.h

setForegroundColor:backgroundColor:forFlag:context:

- (void)setForegroundColor:(DDColor *)txtColor backgroundColor:(DDColor *)bgColor forFlag:(DDLogFlag)mask context:(NSInteger)ctxt
Discussion

Just like setForegroundColor:backgroundColor:flag, but allows you to specify a particular logging context.

A logging context is often used to identify log messages coming from a 3rd party framework, although logging context’s can be used for many different functions.

Use LOG_CONTEXT_ALL to set the deafult color for all contexts that have no specific color set defined.

Logging context’s are explained in further detail here: Documentation/CustomContext.md

Declared In

DDTTYLogger.h

setForegroundColor:backgroundColor:forTag:

- (void)setForegroundColor:(DDColor *)txtColor backgroundColor:(DDColor *)bgColor forTag:(id<NSCopying>)tag
Discussion

Similar to the methods above, but allows you to map DDLogMessage->tag to a particular color profile. For example, you could do something like this:

static NSString *const PurpleTag = @“PurpleTag”;

define DDLogPurple(frmt, …) LOG_OBJC_TAG_MACRO(NO, 0, 0, 0, PurpleTag, frmt, ##VA_ARGS)

And then where you configure CocoaLumberjack:

purple = DDMakeColor((64/255.0), (0/255.0), (128/255.0));

or any UIColor/NSColor constructor.

Note: For CLI OS X projects that don’t link with AppKit use CLIColor objects instead

[[DDTTYLogger sharedInstance] setForegroundColor:purple backgroundColor:nil forTag:PurpleTag]; [DDLog addLogger:[DDTTYLogger sharedInstance]];

This would essentially give you a straight NSLog replacement that prints in purple:

DDLogPurple(@“I’m a purple log message!”);

Declared In

DDTTYLogger.h