Create ASL capture module. #242

DarioAhdoot · 2014-03-18T01:58:59Z

A number of notes:

The code is basically modified from the link I sent in the previous issue. Not a whole lot has changed.
I've added TODO: comments where your attention is required
It's not yet integrated with the rest of the Lumberjack framework as it's not yet clear the best way to do so. Also, I'm not sure if it makes sense to forward the messages on to DDLog since if you have a TTY logger or an ASL logger installed, then they will end up getting duplicates and you can potentially end up in an infinite recursion if you have an ASL logger. Really only makes sense for the file logger, or perhaps custom loggers people may write. Not sure the best way to proceed.
I'm not that experienced with GCD so I can't attest to the stability of the code. I haven't tested start/stopping the ASL capture module.
My Xcode has tabs set to 2 spaces, which is different than yours apparently. Sorry :-)

…he Lumberjack framework as it's not yet clear the best way to do so.

rivera-ernesto · 2014-03-18T05:50:05Z

Lumberjack/DDASLLogCapture.m

+  // TODO: We have some options here. One is to call the corresponding DDLog macros based on the log level. However
+  // we won't get the timestamp of the original NSLog there, which is an important piece of information. Alternatively
+  // we will have to create a DDLogMessage object and set the timestamp directly, but there is no DDLog interface for
+  // accepting a DDLogMessage.


Manually creating the log message is the best choice, we can then make + (void)queueLogMessage:(DDLogMessage *)logMessage asynchronously:(BOOL)asyncFlag public and use it.

Alternatively we could add a timestamp parameter to the DDLogMessage's init, and set it no the current time if no timestamp is set.

* Add new init method too DDLogMessage which takes in a timestamp * Make DDLog queueLogMessage:asynchronously: public * Add nanoseconds to ASL capture timestamps * Adjust some logging levels. * TODO: Need to figure out how to get ddLogLevel into the ASLLogCapture module so it can be passed to the DDLogMessage init method. Perhaps declare it as extern in DDLog.h?

DarioAhdoot · 2014-03-18T17:51:43Z

Hi Ernesto. I've pushed a new commit where I'm calling DDLog queueLogMessage:asynchronously: with a DDLogMessage initialized with the NSLog contents. There are a couple of things left to do which I'm not quite comfortable doing:

Need to get ddLogLevel variable scoped into the ASLLogCapture file. It's needed to pass to the logFlag variable of the DDLogMessage. Not sure of the best way to do that
I'm not sure if we should be calling queueLogMessage synchronously or asynchronously. I left it asynchronous to be safe.
I haven't touched the tag/context values as you suggested as I'm not familiar enough with Lumberjack to know how best to use those as you suggested
I'm not sure of the best place to integrate the DDASLCapture module into the rest of the codebase. More specifically, I'm not sure who should own one, where it should be started/stopped, etc. I figure it's best for you to take care of that, or at least let me know your thoughts on where that should happen
We might want to update the log level filtering on ASL based on the ddloglevel value. Currently we're getting every single ASL log message and relying on the framework to filter. The framework is filtering properly so this may not be an issue.

Thanks,
Dario

rivera-ernesto · 2014-03-19T02:07:19Z

Need to get ddLogLevel variable scoped into the ASLLogCapture file. It's needed to pass to the logFlag variable of the DDLogMessage. Not sure of the best way to do that

Maybe a new higher level +logMessage:(DDLogMessage *)message in DDLog would be better than making +queueLogMessage:asynchronously: public (sorry!). Then DDLog can directly overwrite ddLogLevel.

I'm not sure if we should be calling queueLogMessage synchronously or asynchronously. I left it asynchronous to be safe.

We could let the user choose by changing the start method to startAsynchronously:(BOOL)yesOrNo, etc.

I haven't touched the tag/context values as you suggested as I'm not familiar enough with Lumberjack to know how best to use those as you suggested

Tag is for now simply ignored so we can use that. I can do a separate pull request for this and in the mean time just the ASL logger should be skipped when capturing ASL logs.

I'm not sure of the best place to integrate the DDASLCapture module into the rest of the codebase. More specifically, I'm not sure who should own one, where it should be started/stopped, etc. I figure it's best for you to take care of that, or at least let me know your thoughts on where that should happen

We can do that or you could implement it as all + class methods just like DDLog does. Also a separate file like now is perfect I think.

We might want to update the log level filtering on ASL based on the ddloglevel value. Currently we're getting every single ASL log message and relying on the framework to filter. The framework is filtering properly so this may not be an issue.

Maybe to keep it simple we could have a separate +setCaptureLogLevel: directly in your class, you can still use the levels defined in DDLog.

Thanks to you! Looking forward to start using it ;)

* Allow client to specify whether ASL logs get dispatched synchronously or asynchronously

DarioAhdoot · 2014-03-19T18:54:08Z

Hi Ernesto. I've just pushed another commit which integrates your suggestions for items 2 and 4. For item 1, I'm not clear exactly how that would help as DDLog.m still doesn't have access to ddLogLevel. I'll leave items 1 and 3 up to you. For item 5, I've decided to leave it and use allow all ASL Log messages to be captured and allow the framework to filter.

rivera-ernesto · 2014-03-20T01:49:00Z

Sure. I'll try to address the remaining points. Thanks again!

Capture ASL

DarioAhdoot · 2014-04-02T00:58:53Z

Pull request with your changes included.

rivera-ernesto · 2014-04-02T05:16:33Z

@Diarrhio does it work well for your usages?

@bpoplauschi what do you think about using DDASLLoggerIgnoreLogMessageTag to ignore ASL messages?

DarioAhdoot · 2014-04-02T05:19:02Z

Yup.

rivera-ernesto · 2014-04-07T00:46:45Z

Ok, merging this myself.

Let's try to use pod 'CocoaLumberjack', :head to test everything before we make a new release.

Create ASL capture module.

bpoplauschi · 2014-04-07T10:47:53Z

@rivera-ernesto: I just saw the question about DDASLLoggerIgnoreLogMessageTag, sounds good to me.

About testing, I think we lack some good unit tests that we can run after a big change like this or before a release. Will add that to our 2.0 list.

DarioAhdoot · 2014-04-07T23:21:15Z

I've done some preliminary tests with :head and things seem to be working well. Will file an issue if I find anything.

rivera-ernesto · 2014-04-14T06:46:49Z

@Diarrhio One last thing before making a release. There's an Analyzer warning here.

DDASLLogCapture.m:136:124: Variable 'notifyToken' is uninitialized when captured by block

    int notifyToken;  // Can be used to unregister with notify_cancel(). // <- We need to set a default value here!
    notify_register_dispatch(kNotifyASLDBUpdate, &notifyToken, dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_HIGH, 0), ^(int token)
    {
      // At least one message has been posted; build a search query.
      @autoreleasepool
      {
        // ...

        if(_cancel)
        {
          notify_cancel(notifyToken);
          return;
        }
      }
    });

rivera-ernesto · 2014-04-14T09:54:13Z

Silenced the warning just by setting int notifyToken = 0 here.

Create ASL capture module. It's not yet integrated with the rest of t…

6ccc209

…he Lumberjack framework as it's not yet clear the best way to do so.

rivera-ernesto reviewed Mar 18, 2014
View reviewed changes

* Make class a static class

c729aa8

* Allow client to specify whether ASL logs get dispatched synchronously or asynchronously

利辺羅エルネスト added 10 commits March 20, 2014 11:29

Add CaptureASL Demo and Travis configuration

06f0274

New [DDLog log:message:] primitive

7f8af2e

Rename static variables

a314384

Add capture level property and fix level flags

0f6c25b

New DDASLLoggerIgnoreLogMessageTag

0313793

Prevent logging ASL captured messages back to ASL

812e53e

Update Capture Demo

c9e561c

Update Travis configuration

d435174

Fix Capture Demo Podfile

fabeaba

Update Travis configuration to use pod update instead of pod install

45960dc

rivera-ernesto mentioned this pull request Mar 27, 2014

Following Apple's guidelines for iOS Static Libraries #249

Merged

Merge pull request #1 from rivera-ernesto/capture_asl

da3e42a

Capture ASL

rivera-ernesto assigned bpoplauschi Apr 3, 2014

rivera-ernesto pushed a commit that referenced this pull request Apr 7, 2014

Merge pull request #242 from Diarrhio/master

888cd3f

Create ASL capture module.

rivera-ernesto merged commit 888cd3f into CocoaLumberjack:master Apr 7, 2014

rivera-ernesto mentioned this pull request Apr 14, 2014

Capture ASL improvements #263

Merged

1 task

bpoplauschi added this to the 1.9.0 milestone May 16, 2014

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create ASL capture module. #242

Create ASL capture module. #242

DarioAhdoot commented Mar 18, 2014

rivera-ernesto Mar 18, 2014

DarioAhdoot commented Mar 18, 2014

rivera-ernesto commented Mar 19, 2014

DarioAhdoot commented Mar 19, 2014

rivera-ernesto commented Mar 20, 2014

DarioAhdoot commented Apr 2, 2014

rivera-ernesto commented Apr 2, 2014

DarioAhdoot commented Apr 2, 2014

rivera-ernesto commented Apr 7, 2014

bpoplauschi commented Apr 7, 2014

DarioAhdoot commented Apr 7, 2014

rivera-ernesto commented Apr 14, 2014

rivera-ernesto commented Apr 14, 2014

Create ASL capture module. #242

Create ASL capture module. #242

Conversation

DarioAhdoot commented Mar 18, 2014

rivera-ernesto Mar 18, 2014

Choose a reason for hiding this comment

DarioAhdoot commented Mar 18, 2014

rivera-ernesto commented Mar 19, 2014

DarioAhdoot commented Mar 19, 2014

rivera-ernesto commented Mar 20, 2014

DarioAhdoot commented Apr 2, 2014

rivera-ernesto commented Apr 2, 2014

DarioAhdoot commented Apr 2, 2014

rivera-ernesto commented Apr 7, 2014

bpoplauschi commented Apr 7, 2014

DarioAhdoot commented Apr 7, 2014

rivera-ernesto commented Apr 14, 2014

rivera-ernesto commented Apr 14, 2014