CBL-5396: Use os_log instead of NSLog for Console Log #3323

velicuvlad · 2024-08-19T16:22:21Z

each LogLevel has been matched with a type of os_log - same behaviour as .NET
Additionally, os_log categories, mapped to DomainLevels, will now be created at the time logging is initialised, on open/create db. And every CBL log, with its specific domain, will now appear in its own corresponding category in console logs.

There are just a couple of NSLogs only for DEBUG, which for I've decided that the os_log object to be created dynamically as we dont care that much and based on those messages, there's an issue somewhere else anyway. The production ones will be generated as mentioned above.
Removed CBLLog+Admin.h as is no longer needed.

pasin · 2024-08-28T05:26:15Z

For some reason, a test was hang for 14 hour. I just canceled it.

pasin · 2024-08-28T05:27:50Z

Objective-C/Tests/Util/CBLWordEmbeddingModel.m

@@ -40,7 +40,8 @@ - (CBLDictionary*) predict: (CBLDictionary*)input {
    NSString* inputWord = [input stringForKey: @"word"];

    if (!inputWord) {
-        NSLog(@"No word input !!!");
+        os_log_t log = os_log_create("CouchbaseLite", "OSLogging");
+        os_log(log, "No word input !!!");


For this one we can use NSLog, I guessed or change it to assertion instead of logging.

changed to assert

pasin · 2024-08-28T05:28:58Z

Objective-C/CBLConsoleLogger.m

@@ -45,7 +45,8 @@ - (void) logWithLevel: (CBLLogLevel)level domain: (CBLLogDomain)domain message:

    NSString* levelName = CBLLog_GetLevelName(level);
    NSString* domainName = CBLLog_GetDomainName(domain);
-    NSLog(@"CouchbaseLite %@ %@: %@", domainName, levelName, message);
+    os_log_t log = os_log_create("CouchbaseLite", "OSDebug");


What is "OSDebug"? Where does it appear in the log?

changed to com.couchbase.lite.ios and the category now represents a domain (CBL)

pasin · 2024-08-28T05:29:34Z

Objective-C/CBLDatabase.mm

@@ -115,7 +115,8 @@ to be done in CBLInit()which is called only once when the first CBLDatabase is c
 */
 + (void) initialize {
    if (self == [CBLDatabase class]) {
-        NSLog(@"%@", [CBLVersion userAgent]);
+        os_log_t log = os_log_create("CouchbaseLite", "OSLogging");


What is "OSLogging"? Where does it appear in the log?

pasin · 2024-08-28T05:31:35Z

Objective-C/CBLConsoleLogger.m

@@ -45,7 +45,8 @@ - (void) logWithLevel: (CBLLogLevel)level domain: (CBLLogDomain)domain message:

    NSString* levelName = CBLLog_GetLevelName(level);
    NSString* domainName = CBLLog_GetDomainName(domain);
-    NSLog(@"CouchbaseLite %@ %@: %@", domainName, levelName, message);
+    os_log_t log = os_log_create("CouchbaseLite", "OSDebug");
+    os_log(log, "CouchbaseLite %@ %@: %@", domainName, levelName, message);


There are different types of os_log function based on the log level. I think we should use those functions. What is .NET using?

Objective-C/CBLDatabase.mm

Objective-C/CBLLog.mm

to be used with any additional in-code logging

Objective-C/CBLConsoleLogger.m

pasin · 2024-10-15T16:08:24Z

Objective-C/CBLConsoleLogger.m

@@ -32,6 +32,7 @@ - (instancetype) initWithLogLevel: (CBLLogLevel)level {
    if (self) {
        _level = level;
        _domains = kCBLLogDomainAll;
+        _sysID = [[NSBundle mainBundle] bundleIdentifier];


I'm not sure if this is right as it think it will return the bundle identifier of the app not the framework. What is the value when you run the test? If this returns bundle id of the app, you may try to get the bundle id from one of the classes such as CBLConsoleLogger itself.

you are right, will fix

pasin · 2024-10-15T16:10:05Z

Objective-C/CBLConsoleLogger.m

-    }
+    static dispatch_once_t onceToken;
+    dispatch_once(&onceToken, ^{
+        logger = os_log_create("com.couchbase.lite.ios", "Internal");


This one still uses the hardcode string, "com.couchbase.lite.ios".

velicuvlad · 2024-10-22T13:00:07Z

I've changed internalLogger to logAlways which will log under DB domain in the default scope of os_log (hence the name), independently of the log level set by CBL, that is only used only in logWithLevel. So we don't have to use another dispatch. Tested a bit and it works as expected.

pasin · 2024-10-22T16:02:32Z

Objective-C/CBLLog.mm

@@ -190,7 +191,7 @@ - (instancetype) initWithDefault {
                C4LogDomain domain = c4log_getDomain(domainName, true);
                C4LogLevel level = string2level(defaults[key]);
                c4log_setLevel(domain, level);
-                NSLog(@"CouchbaseLite logging to %s domain at level %s", domainName, kLevelNames[level]);
+                os_log(oslogger, "CouchbaseLite logging to %s domain at level %s", domainName, kLevelNames[level]);


Should it use CBLConsoleLogger's logAlways as well?

pasin · 2024-10-22T16:04:05Z

Objective-C/CBLConsoleLogger.m

+}
+
+ (void) logAlways: (NSString*)message {
+    os_log(osLogDictionary[@(kCBLLogDomainDatabase)], "%@", message);


Just noticed this. If CBLConsoleLogger is not inited yet, osLogDictionary will be empty as logAlways is a static function.

velicuvlad added 2 commits August 19, 2024 17:15

move NSLog to os_log

ed9ecfb

typo

9a03db9

velicuvlad requested a review from pasin August 27, 2024 14:44

pasin reviewed Aug 28, 2024

View reviewed changes

velicuvlad added 2 commits August 28, 2024 15:49

change log to assert for inputWord

a906642

changed to match .NET

6895ecd

velicuvlad requested review from pasin and borrrden September 5, 2024 14:29

borrrden approved these changes Sep 10, 2024

View reviewed changes

pasin requested changes Sep 12, 2024

View reviewed changes

Objective-C/CBLDatabase.mm Outdated Show resolved Hide resolved

Objective-C/CBLLog.mm Outdated Show resolved Hide resolved

Create generic internal logger for ConsoleLog

c139662

to be used with any additional in-code logging

velicuvlad requested a review from pasin September 13, 2024 16:28

pasin requested changes Oct 3, 2024

View reviewed changes

Objective-C/CBLConsoleLogger.m Outdated Show resolved Hide resolved

pasin requested changes Oct 3, 2024

View reviewed changes

Objective-C/CBLConsoleLogger.m Outdated Show resolved Hide resolved

velicuvlad added 2 commits October 4, 2024 16:49

feedback

4e50ac7

typo fix

90a540a

velicuvlad requested a review from pasin October 4, 2024 16:38

pasin requested changes Oct 15, 2024

View reviewed changes

velicuvlad added 2 commits October 17, 2024 16:20

fix framework id

e7defe8

log under Database using specific call

96a48a5

velicuvlad requested a review from pasin October 22, 2024 13:01

pasin approved these changes Oct 22, 2024

View reviewed changes

pasin requested changes Oct 22, 2024

View reviewed changes

plus 1

04526ca

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CBL-5396: Use os_log instead of NSLog for Console Log #3323

CBL-5396: Use os_log instead of NSLog for Console Log #3323

velicuvlad commented Aug 19, 2024 •

edited

Loading

pasin commented Aug 28, 2024

pasin Aug 28, 2024

velicuvlad Aug 28, 2024 •

edited

Loading

pasin Aug 28, 2024

velicuvlad Sep 5, 2024

pasin Aug 28, 2024

pasin Aug 28, 2024

pasin Oct 15, 2024

velicuvlad Oct 17, 2024

pasin Oct 15, 2024

velicuvlad commented Oct 22, 2024 •

edited

Loading

pasin Oct 22, 2024

pasin Oct 22, 2024 •

edited

Loading

CBL-5396: Use os_log instead of NSLog for Console Log #3323

Are you sure you want to change the base?

CBL-5396: Use os_log instead of NSLog for Console Log #3323

Conversation

velicuvlad commented Aug 19, 2024 • edited Loading

pasin commented Aug 28, 2024

Choose a reason for hiding this comment

velicuvlad Aug 28, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

velicuvlad commented Oct 22, 2024 • edited Loading

Choose a reason for hiding this comment

pasin Oct 22, 2024 • edited Loading

Choose a reason for hiding this comment

velicuvlad commented Aug 19, 2024 •

edited

Loading

velicuvlad Aug 28, 2024 •

edited

Loading

velicuvlad commented Oct 22, 2024 •

edited

Loading

pasin Oct 22, 2024 •

edited

Loading