-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathperuserloglevels.html
386 lines (362 loc) · 21 KB
/
peruserloglevels.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
<!DOCTYPE html>
<html lang="en">
<head>
<title>PerUserLogLevels Reference</title>
<link rel="stylesheet" type="text/css" href="css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="css/highlight.css" />
<meta charset='utf-8'>
<script src="js/jquery.min.js" defer></script>
<script src="js/jazzy.js" defer></script>
<script src="js/lunr.min.js" defer></script>
<script src="js/typeahead.jquery.js" defer></script>
<script src="js/jazzy.search.js" defer></script>
</head>
<body>
<a title="PerUserLogLevels Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">CocoaLumberjack 3.7.0 Docs</a> (64% documented)</p>
<p class="header-right"><a href="https://github.com/CocoaLumberjack/CocoaLumberjack"><img src="img/gh.png"/>View on GitHub</a></p>
<p class="header-right">
<form role="search" action="search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="index.html">CocoaLumberjack Reference</a>
<img id="carat" src="img/carat.png" />
PerUserLogLevels Reference
</p>
</div>
<div class="content-wrapper">
<nav class="sidebar">
<ul class="nav-groups">
<li class="nav-group-name">
<a href="Guides.html">Guides</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="arc.html">ARC</a>
</li>
<li class="nav-group-task">
<a href="appcode-support.html">AppCode-support</a>
</li>
<li class="nav-group-task">
<a href="architecture.html">Architecture</a>
</li>
<li class="nav-group-task">
<a href="combineloggers.html">CombineLoggers</a>
</li>
<li class="nav-group-task">
<a href="customcontext.html">CustomContext</a>
</li>
<li class="nav-group-task">
<a href="customformatters.html">CustomFormatters</a>
</li>
<li class="nav-group-task">
<a href="customloglevels.html">CustomLogLevels</a>
</li>
<li class="nav-group-task">
<a href="customloggers.html">CustomLoggers</a>
</li>
<li class="nav-group-task">
<a href="dynamicloglevels.html">DynamicLogLevels</a>
</li>
<li class="nav-group-task">
<a href="faq.html">FAQ</a>
</li>
<li class="nav-group-task">
<a href="finegrainedlogging.html">FineGrainedLogging</a>
</li>
<li class="nav-group-task">
<a href="gettingstarted.html">GettingStarted</a>
</li>
<li class="nav-group-task">
<a href="logfilemanagement.html">LogFileManagement</a>
</li>
<li class="nav-group-task">
<a href="perloggerloglevels.html">PerLoggerLogLevels</a>
</li>
<li class="nav-group-task">
<a href="peruserloglevels.html">PerUserLogLevels</a>
</li>
<li class="nav-group-task">
<a href="performance.html">Performance</a>
</li>
<li class="nav-group-task">
<a href="problemsolution.html">ProblemSolution</a>
</li>
<li class="nav-group-task">
<a href="readme.html">README</a>
</li>
<li class="nav-group-task">
<a href="xcodecolors.html">XcodeColors</a>
</li>
<li class="nav-group-task">
<a href="xcodetricks.html">XcodeTricks</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Classes/CLIColor.html">CLIColor</a>
</li>
<li class="nav-group-task">
<a href="Classes/DDASLLogCapture.html">DDASLLogCapture</a>
</li>
<li class="nav-group-task">
<a href="Classes/DDASLLogger.html">DDASLLogger</a>
</li>
<li class="nav-group-task">
<a href="Classes/DDAbstractDatabaseLogger.html">DDAbstractDatabaseLogger</a>
</li>
<li class="nav-group-task">
<a href="Classes/DDAbstractLogger.html">DDAbstractLogger</a>
</li>
<li class="nav-group-task">
<a href="Classes.html#/c:objc(cs)DDAtomicCounter">DDAtomicCounter</a>
</li>
<li class="nav-group-task">
<a href="Classes/DDContextBlacklistFilterLogFormatter.html">DDContextBlacklistFilterLogFormatter</a>
</li>
<li class="nav-group-task">
<a href="Classes/DDContextWhitelistFilterLogFormatter.html">DDContextWhitelistFilterLogFormatter</a>
</li>
<li class="nav-group-task">
<a href="Classes/DDDispatchQueueLogFormatter.html">DDDispatchQueueLogFormatter</a>
</li>
<li class="nav-group-task">
<a href="Classes/DDFileLogger.html">DDFileLogger</a>
</li>
<li class="nav-group-task">
<a href="Classes/DDLog.html">DDLog</a>
</li>
<li class="nav-group-task">
<a href="Classes/DDLogFileFormatterDefault.html">DDLogFileFormatterDefault</a>
</li>
<li class="nav-group-task">
<a href="Classes/DDLogFileInfo.html">DDLogFileInfo</a>
</li>
<li class="nav-group-task">
<a href="Classes/DDLogFileManagerDefault.html">DDLogFileManagerDefault</a>
</li>
<li class="nav-group-task">
<a href="Classes/DDLogMessage.html">DDLogMessage</a>
</li>
<li class="nav-group-task">
<a href="Classes/DDLoggerInformation.html">DDLoggerInformation</a>
</li>
<li class="nav-group-task">
<a href="Classes/DDMultiFormatter.html">DDMultiFormatter</a>
</li>
<li class="nav-group-task">
<a href="Classes/DDOSLogger.html">DDOSLogger</a>
</li>
<li class="nav-group-task">
<a href="Classes/DDTTYLogger.html">DDTTYLogger</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Constants.html">Constants</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Constants.html#/c:@CocoaLumberjackVersionNumber">CocoaLumberjackVersionNumber</a>
</li>
<li class="nav-group-task">
<a href="Constants.html#/c:@CocoaLumberjackVersionString">CocoaLumberjackVersionString</a>
</li>
<li class="nav-group-task">
<a href="Constants.html#/c:@DDLoggerNameASL">DDLoggerNameASL</a>
</li>
<li class="nav-group-task">
<a href="Constants.html#/c:@DDLoggerNameFile">DDLoggerNameFile</a>
</li>
<li class="nav-group-task">
<a href="Constants.html#/c:@DDLoggerNameOS">DDLoggerNameOS</a>
</li>
<li class="nav-group-task">
<a href="Constants.html#/c:@DDLoggerNameTTY">DDLoggerNameTTY</a>
</li>
<li class="nav-group-task">
<a href="Constants.html#/c:@DDQualityOfServiceBackground">DDQualityOfServiceBackground</a>
</li>
<li class="nav-group-task">
<a href="Constants.html#/c:@DDQualityOfServiceDefault">DDQualityOfServiceDefault</a>
</li>
<li class="nav-group-task">
<a href="Constants.html#/c:@DDQualityOfServiceUnspecified">DDQualityOfServiceUnspecified</a>
</li>
<li class="nav-group-task">
<a href="Constants.html#/c:@DDQualityOfServiceUserInitiated">DDQualityOfServiceUserInitiated</a>
</li>
<li class="nav-group-task">
<a href="Constants.html#/c:@DDQualityOfServiceUserInteractive">DDQualityOfServiceUserInteractive</a>
</li>
<li class="nav-group-task">
<a href="Constants.html#/c:@DDQualityOfServiceUtility">DDQualityOfServiceUtility</a>
</li>
<li class="nav-group-task">
<a href="Constants.html#/c:@kDDASLDDLogValue">kDDASLDDLogValue</a>
</li>
<li class="nav-group-task">
<a href="Constants.html#/c:@kDDASLKeyDDLog">kDDASLKeyDDLog</a>
</li>
<li class="nav-group-task">
<a href="Constants.html#/c:@kDDDefaultLogFilesDiskQuota">kDDDefaultLogFilesDiskQuota</a>
</li>
<li class="nav-group-task">
<a href="Constants.html#/c:@kDDDefaultLogMaxFileSize">kDDDefaultLogMaxFileSize</a>
</li>
<li class="nav-group-task">
<a href="Constants.html#/c:@kDDDefaultLogMaxNumLogFiles">kDDDefaultLogMaxNumLogFiles</a>
</li>
<li class="nav-group-task">
<a href="Constants.html#/c:@kDDDefaultLogRollingFrequency">kDDDefaultLogRollingFrequency</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Enums/DDDispatchQueueLogFormatterMode.html">DDDispatchQueueLogFormatterMode</a>
</li>
<li class="nav-group-task">
<a href="Enums/DDLogFlag.html">DDLogFlag</a>
</li>
<li class="nav-group-task">
<a href="Enums/DDLogLevel.html">DDLogLevel</a>
</li>
<li class="nav-group-task">
<a href="Enums/DDLogMessageOptions.html">DDLogMessageOptions</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Protocols/DDAtomicCountable.html">DDAtomicCountable</a>
</li>
<li class="nav-group-task">
<a href="Protocols/DDLogFileManager.html">DDLogFileManager</a>
</li>
<li class="nav-group-task">
<a href="Protocols/DDLogFormatter.html">DDLogFormatter</a>
</li>
<li class="nav-group-task">
<a href="Protocols/DDLogger.html">DDLogger</a>
</li>
<li class="nav-group-task">
<a href="Protocols/DDRegisteredDynamicLogging.html">DDRegisteredDynamicLogging</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Type%20Definitions.html">Type Definitions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Type%20Definitions.html#/c:DDTTYLogger.h@T@DDColor">DDColor</a>
</li>
<li class="nav-group-task">
<a href="Type%20Definitions.html#/c:DDLoggerNames.h@T@DDLoggerName">DDLoggerName</a>
</li>
<li class="nav-group-task">
<a href="Type%20Definitions.html#/c:DDDispatchQueueLogFormatter.h@T@DDQualityOfServiceName">DDQualityOfServiceName</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Functions.html">Functions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Functions.html#/c:@F@DDExtractFileNameWithoutExtension">DDExtractFileNameWithoutExtension</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/c:DDTTYLogger.h@F@DDMakeColor">DDMakeColor</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section>
<section class="section">
<p>When working as part of a team, different developers are working on different parts of the application. You may be adding a new feature to FileA, while your colleague is trying to track down a bug in FileB. During your development and testing, you increase the log level of FileA to verbose. This spits out a bunch of useful log statements so you can ensure that new feature is working exactly as intended. Excited to see it working, you quickly commit and push your changes. But you forgot to decrease the log level of FileA, and now your colleague sees a bunch of new log statements that don’t apply to his/her current development work…</p>
<p>It’s a typical situation. A bit annoying, with several unnecessary commits going back and forth, changing the log levels.</p>
<p>A better solution is using <strong>per-user</strong> log levels:</p>
<pre class="highlight objective_c"><code><span class="c1">// Log levels: off, error, warn, info, verbose
</span><span class="cp">#if defined(DEBUG) && defined(robbie_hanson)
</span> <span class="k">static</span> <span class="k">const</span> <span class="n">DDLogLevel</span> <span class="n">ddLogLevel</span> <span class="o">=</span> <span class="n">DDLogLevelVerbose</span><span class="p">;</span> <span class="c1">// Log level for robbie (debug)
</span><span class="cp">#elif defined(DEBUG)
</span> <span class="k">static</span> <span class="k">const</span> <span class="n">DDLogLevel</span> <span class="n">ddLogLevel</span> <span class="o">=</span> <span class="n">DDLogLevelInfo</span><span class="p">;</span> <span class="c1">// Log level for other team members (debug)
</span><span class="cp">#else
</span> <span class="k">static</span> <span class="k">const</span> <span class="n">DDLogLevel</span> <span class="n">ddLogLevel</span> <span class="o">=</span> <span class="n">DDLogLevelWarn</span><span class="p">;</span> <span class="c1">// Log level for release build
</span><span class="cp">#endif
</span></code></pre>
<p>(Different log levels per debug / release builds are explained in <a href="XcodeTricks.md">Xcode Tricks</a>)</p>
<p>This way, the developer who’s currently working on the file can have their own log level. And everyone else just gets the normal log level. The trick is defining that full_username preprocessor macro.</p>
<p>An example of how to do this is included in the repository under the <code>Xcode/PerUserLogLevels</code> project. Which I’ll explain here.</p>
<p>The first step is adding a new header file to your project. We’ll call it <code>LumberjackUser.h</code>. You can leave the file completely empty. But when it’s all said and done, the file will end up looking like this:</p>
<pre class="highlight objective_c"><code><span class="c1">// This file is automatically generated
</span><span class="cp">#define robbie_hanson 1
</span></code></pre>
<p>Of course, when you compile the project on your computer, <code>robbie_hanson</code> will get replaced with <code>whatever_your_full_username_is</code>.</p>
<p>Note: You should not add <code>LumberjackUser.h</code> to source control. But it does need to be added to the Xcode project.</p>
<p>Next we’re going to add a script to our project that will automatically generate/update the <code>LumberjackUser.h</code> file. I placed the script in a file named <code>LumberjackUser.bash</code>:</p>
<pre class="highlight shell"><code><span class="c">#!/bin/bash</span>
<span class="c"># Get full user name of current user</span>
<span class="c"># E.g. "Robbie Hanson"</span>
<span class="nv">full1</span><span class="o">=</span><span class="k">$(</span>osascript -e <span class="s2">"tell application </span><span class="se">\\</span><span class="s2">"</span>System Events<span class="se">\\</span><span class="s2">""</span> -e <span class="s2">"get the full name of the current user"</span> -e <span class="s2">"end tell"</span><span class="k">)</span>
<span class="c">#echo $full1</span>
<span class="c"># Convert to lower case</span>
<span class="c"># E.g. "robbie hanson"</span>
<span class="nv">full2</span><span class="o">=</span><span class="k">$(</span><span class="nb">echo</span> <span class="nv">$full1</span> | awk <span class="s1">'{print tolower($0)}'</span><span class="k">)</span>
<span class="c">#echo $full2</span>
<span class="c"># Replace spaces with underscores</span>
<span class="c"># E.g. "robbie_hanson"</span>
<span class="nv">full3</span><span class="o">=</span><span class="k">$(</span><span class="nb">echo</span> <span class="k">${</span><span class="nv">full2</span><span class="p">// /_</span><span class="k">})</span>
<span class="c">#echo $full3</span>
<span class="c"># Remove any characters that are illegal in a macro name</span>
<span class="nv">full4</span><span class="o">=</span><span class="k">$(</span><span class="nb">echo</span> <span class="nv">$full3</span> | sed <span class="s1">'s/[^0-9a-zA-Z_]*//g'</span><span class="k">)</span>
<span class="c">#echo $full4</span>
<span class="c"># If we output directly to our intended file, even when nothing has changed,</span>
<span class="c"># then we'll essentially be doing a touch on the file.</span>
<span class="c"># The compiler will see this, and recompile any files that include the header.</span>
<span class="c"># This may mean recompiling every single source file, every single time we do a build!</span>
<span class="c"># So instead we're going to output to a temporary file, and use diff to detect changes.</span>
<span class="nv">temp_filepath</span><span class="o">=</span><span class="s2">"</span><span class="k">${</span><span class="nv">SRCROOT</span><span class="k">}</span><span class="s2">/PerUserLogLevels/LumberjackUser.temp.h"</span>
<span class="nv">final_filepath</span><span class="o">=</span><span class="s2">"</span><span class="k">${</span><span class="nv">SRCROOT</span><span class="k">}</span><span class="s2">/PerUserLogLevels/LumberjackUser.h"</span>
<span class="nb">echo</span> <span class="s2">"// This file is automatically generated"</span> > <span class="k">${</span><span class="nv">temp_filepath</span><span class="k">}</span>
<span class="nb">echo</span> <span class="s2">"#define </span><span class="nv">$full4</span><span class="s2"> 1"</span> >> <span class="k">${</span><span class="nv">temp_filepath</span><span class="k">}</span>
<span class="k">if</span> <span class="o">[</span> -a <span class="k">${</span><span class="nv">final_filepath</span><span class="k">}</span> <span class="o">]</span>
<span class="k">then
</span><span class="nv">DIFF</span><span class="o">=</span><span class="k">$(</span>diff <span class="k">${</span><span class="nv">temp_filepath</span><span class="k">}</span> <span class="k">${</span><span class="nv">final_filepath</span><span class="k">})</span>
<span class="k">if</span> <span class="o">[</span> <span class="s2">"</span><span class="nv">$DIFF</span><span class="s2">"</span> !<span class="o">=</span> <span class="s2">""</span> <span class="o">]</span>
<span class="k">then
</span>cp -f <span class="k">${</span><span class="nv">temp_filepath</span><span class="k">}</span> <span class="k">${</span><span class="nv">final_filepath</span><span class="k">}</span>
<span class="k">fi
else
</span>cp -f <span class="k">${</span><span class="nv">temp_filepath</span><span class="k">}</span> <span class="k">${</span><span class="nv">final_filepath</span><span class="k">}</span>
<span class="k">fi</span>
</code></pre>
<p>Next we’re going to add a new “Run Script” Build Phase to our target, ensure it’s run before the Compile Sources phase, and have it execute our bash script from above:</p>
<p><img src="http://www.deusty.com/blog/CocoaLumberjack/PerUserLogLevels1.png" alt="Screenshot of Xcode"></p>
<p>Finally, you’ll want to add <code>LumberjackUser.h</code> and <code>LumberjackUser.temp.h</code> to <code>.gitignore</code></p>
<p>And that’s all there is to it. Happy Logging.</p>
</section>
</section>
<section id="footer">
<p>© 2020 <a class="link" href="https://github.com/CocoaLumberjack/CocoaLumberjack" target="_blank" rel="external">CocoaLumberjack</a>. All rights reserved. (Last updated: 2020-11-21)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</div>
</html>