How to NSLog into a file

Question

Is it possible to write every NSLog not only into console, but into a file too? I want to prepare this without replacing NSLog into someExternalFunctionForLogging.

It will be real problem to replace all NSLog. Maybe there is possibility for parsing data from console or catching messages?

Answer 1

Option 1: Use ASL

NSLog outputs log to ASL (Apple's version of syslog) and console, meaning it is already writing to a file in your Mac when you use the iPhone simulator. If you want to read it open the application Console.app, and type the name of your application in the filter field. To do the same in your iPhone device, you would need to use the ASL API and do some coding.

Option 2: write to a file

Let's say you are running on the simulator and you don't want to use the Console.app. You can redirect the error stream to a file of your liking using freopen:
freopen([path cStringUsingEncoding:NSASCIIStringEncoding], "a+", stderr);
See this explanation and sample project for details.

Or you can override NSLog with a custom function using a macro. Example, add this class to your project:

// file Log.h #define NSLog(args...) _Log(@"DEBUG ", __FILE__,__LINE__,__PRETTY_FUNCTION__,args); @interface Log : NSObject void _Log(NSString *prefix, const char *file, int lineNumber, const char *funcName, NSString *format,...); @end  // file Log.m #import "Log.h" @implementation Log void _Log(NSString *prefix, const char *file, int lineNumber, const char *funcName, NSString *format,...) {     va_list ap;     va_start (ap, format);     format = [format stringByAppendingString:@"\n"];     NSString *msg = [[NSString alloc] initWithFormat:[NSString stringWithFormat:@"%@",format] arguments:ap];        va_end (ap);     fprintf(stderr,"%s%50s:%3d - %s",[prefix UTF8String], funcName, lineNumber, [msg UTF8String]);     [msg release]; } @end 

And import it project wide adding the following to your <application>-Prefix.pch:

#import "Log.h" 

Now every call to NSLog will be replaced with your custom function without the need to touch your existing code. However, the function above is only printing to console. To add file output, add this function above _Log:

void append(NSString *msg){     // get path to Documents/somefile.txt     NSArray *paths = NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES);     NSString *documentsDirectory = [paths objectAtIndex:0];     NSString *path = [documentsDirectory stringByAppendingPathComponent:@"logfile.txt"];     // create if needed     if (![[NSFileManager defaultManager] fileExistsAtPath:path]){         fprintf(stderr,"Creating file at %s",[path UTF8String]);         [[NSData data] writeToFile:path atomically:YES];     }      // append     NSFileHandle *handle = [NSFileHandle fileHandleForWritingAtPath:path];     [handle truncateFileAtOffset:[handle seekToEndOfFile]];     [handle writeData:[msg dataUsingEncoding:NSUTF8StringEncoding]];     [handle closeFile]; } 

and add this line below fprintf in the _Log function:

append(msg); 

File writing also works in your iPhone device, but the file will be created in a directory inside it, and you won't be able to access unless you add code to send it back to your mac, or show it on a view inside your app, or use iTunes to add the documents directory.

Answer 2

There is a far easier approach. Here is the method that redirects NSLog output into a file in application’s Documents folder. This can be useful when you want to test your app outside your development studio, unplugged from your mac.

ObjC:

- (void)redirectLogToDocuments  {      NSArray *allPaths = NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES);      NSString *documentsDirectory = [allPaths objectAtIndex:0];      NSString *pathForLog = [documentsDirectory stringByAppendingPathComponent:@"yourFile.txt"];       freopen([pathForLog cStringUsingEncoding:NSASCIIStringEncoding],"a+",stderr); } 

Swift:

// 1. Window > Devices and Simulators // 2. Select the device // 3. Select your app and click gear icon // 4. Download container // 5. Right click and "view contents" // 6. Find "yourfile.log" under Downloads // // redirectLogToDocuments()  func redirectLogToDocuments() {   let allPaths = NSSearchPathForDirectoriesInDomains(.documentDirectory, .userDomainMask, true)   let documentsDirectory = allPaths.first!   let pathForLog = "\(documentsDirectory)/yourfile.log"   freopen(pathForLog.cString(using: String.Encoding.ascii)!, "a+", stdout) } 

After executing this method all output generated by NSLog (ObjC) or print (Swift) will be forwarded to specified file. To get your saved file open Organizer, browse application’s files and save Application Data somewhere in your file system, than simply browse to Documents folder.