Initial version of the library
Implemented: * basic features for logging with severity levels * lexically scoped properties * dynamically scoped properties * 3 output formats (textline, textblock and json) * optional timestamps To-do: * compile-time filtering of certaiin topics and severity levels (potentially removing all logging) * optional run-time filtering * specification of the log outputs/formats through a define * colorful output in the terminal * documentation
This commit is contained in:
Zahary Karadjov
commit
c9c7666cd5
|
|
@ -0,0 +1,8 @@
|
|||
# ignore all executable files
|
||||
*
|
||||
!*.*
|
||||
!*/
|
||||
*.exe
|
||||
|
||||
nimcache/
|
||||
|
||||
|
|
@ -0,0 +1,201 @@
|
|||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright 2018 Status Research & Development GmbH
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2018 Status Research & Development GmbH
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
|
|
@ -0,0 +1,112 @@
|
|||
import
|
||||
macros, tables,
|
||||
chronicles/[scope_helpers, dynamic_scope, log_output]
|
||||
|
||||
export
|
||||
dynamic_scope, log_output
|
||||
|
||||
template lexScopeSymbolsIMPL* =
|
||||
0 # scope revision number
|
||||
|
||||
type
|
||||
BindingsSet = Table[string, NimNode]
|
||||
|
||||
proc actualBody(n: NimNode): NimNode =
|
||||
# skip over the double StmtList node introduced in `mergeScopes`
|
||||
result = n.body
|
||||
if result.kind == nnkStmtList and result[0].kind == nnkStmtList:
|
||||
result = result[0]
|
||||
|
||||
proc scopeRevision(scopeSymbols: NimNode): int =
|
||||
# get the revision number from a `lexScopeSymbolsIMPL` sym
|
||||
assert scopeSymbols.kind == nnkSym
|
||||
var revisionNode = scopeSymbols.getImpl.actualBody[0]
|
||||
result = int(revisionNode.intVal)
|
||||
|
||||
proc lastScopeHolder(scopes: NimNode): NimNode =
|
||||
# get the most recent `lexScopeSymbolsIMPL` from a symChoice node
|
||||
if scopes.kind in {nnkClosedSymChoice, nnkOpenSymChoice}:
|
||||
var bestScopeRev = 0
|
||||
assert scopes.len > 0
|
||||
for scope in scopes:
|
||||
let rev = scope.scopeRevision
|
||||
if result == nil or rev > bestScopeRev:
|
||||
result = scope
|
||||
bestScopeRev = rev
|
||||
else:
|
||||
result = scopes
|
||||
|
||||
assert result.kind == nnkSym
|
||||
|
||||
macro mergeScopes(scopes: typed, newBindings: untyped): untyped =
|
||||
var
|
||||
bestScope = scopes.lastScopeHolder
|
||||
bestScopeRev = bestScope.scopeRevision
|
||||
|
||||
var finalBindings = initTable[string, NimNode]()
|
||||
for k, v in assignments(bestScope.getImpl.actualBody, skip = 1):
|
||||
finalBindings[k] = v
|
||||
|
||||
for k, v in assignments(newBindings):
|
||||
finalBindings[k] = v
|
||||
|
||||
var newScopeDefinition = newStmtList(newLit(bestScopeRev + 1))
|
||||
|
||||
for k, v in finalBindings:
|
||||
newScopeDefinition.add newAssignment(newIdentNode(k), v)
|
||||
|
||||
result = quote:
|
||||
template lexScopeSymbolsIMPL = `newScopeDefinition`
|
||||
|
||||
template logScope*(newBindings: untyped) {.dirty.} =
|
||||
bind bindSym, mergeScopes, brForceOpen
|
||||
mergeScopes(bindSym("lexScopeSymbolsIMPL", brForceOpen),
|
||||
newBindings)
|
||||
|
||||
macro logImpl(severity: LogLevel, scopes: typed,
|
||||
logStmtProps: varargs[untyped]): untyped =
|
||||
let lexicalScope = scopes.lastScopeHolder.getImpl.actualBody
|
||||
var finalBindings = initOrderedTable[string, NimNode]()
|
||||
|
||||
for k, v in assignments(lexicalScope, skip = 1):
|
||||
finalBindings[k] = v
|
||||
|
||||
for k, v in assignments(logStmtProps, skip = 1):
|
||||
finalBindings[k] = v
|
||||
|
||||
finalBindings.sort(system.cmp)
|
||||
|
||||
let eventName = logStmtProps[0]
|
||||
assert eventName.kind in {nnkStrLit}
|
||||
let record = genSym(nskVar, "record")
|
||||
|
||||
let threadId = when compileOption("threads"): newCall("getThreadId")
|
||||
else: newLit(0)
|
||||
|
||||
result = quote:
|
||||
var `record`: LogOutput
|
||||
setEventName(`record`, `severity`, `eventName`)
|
||||
setFirstProperty(`record`, "thread", `threadId`)
|
||||
|
||||
for k, v in finalBindings:
|
||||
result.add newCall(newIdentNode"setProperty", record, newLit(k), v)
|
||||
|
||||
result.add newCall(newIdentNode"logAllDynamicProperties", record)
|
||||
result.add newCall(newIdentNode"flushRecord", record)
|
||||
|
||||
template log*(severity: LogLevel, props: varargs[untyped]) {.dirty.} =
|
||||
bind logImpl, bindSym, brForceOpen
|
||||
logImpl(severity, bindSym("lexScopeSymbolsIMPL", brForceOpen), props)
|
||||
|
||||
template logFn(name, severity) =
|
||||
template `name`*(props: varargs[untyped]) =
|
||||
bind log
|
||||
log(severity, props)
|
||||
|
||||
logFn debug , LogLevel.DEBUG
|
||||
logFn info , LogLevel.INFO
|
||||
logFn notice, LogLevel.NOTICE
|
||||
logFn warn , LogLevel.WARN
|
||||
logFn error , LogLevel.ERROR
|
||||
logFn fatal , LogLevel.FATAL
|
||||
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
mode = ScriptMode.Verbose
|
||||
|
||||
packageName = "chronicles"
|
||||
version = "0.1.0"
|
||||
author = "Status Research & Development GmbH"
|
||||
description = "The premier structured logging library for Nim"
|
||||
license = "Apache License 2.0"
|
||||
skipDirs = @["tests"]
|
||||
|
||||
requires "nim >= 0.19.0"
|
||||
|
||||
proc configForTests() =
|
||||
--hints: off
|
||||
--debuginfo
|
||||
--path: "."
|
||||
--run
|
||||
|
||||
task test, "run CPU tests":
|
||||
configForTests()
|
||||
setCommand "c", "tests/all.nim"
|
||||
|
||||
|
|
@ -0,0 +1,58 @@
|
|||
import
|
||||
macros, log_output, scope_helpers
|
||||
|
||||
type
|
||||
ScopeBindingBase = ref object of RootObj
|
||||
name: string
|
||||
appender: LogAppender
|
||||
|
||||
LogAppender = proc(x: var LogOutput, valueAddr: ScopeBindingBase)
|
||||
|
||||
ScopeBinding[T] = ref object of ScopeBindingBase
|
||||
value: T
|
||||
|
||||
proc appenderIMPL[T](log: var LogOutput, valueAddr: ScopeBindingBase) =
|
||||
let v = ScopeBinding[T](valueAddr)
|
||||
log.setProperty v.name, v.value
|
||||
|
||||
var dynamicProperties {.threadvar.}: seq[ScopeBindingBase]
|
||||
|
||||
proc chroniclesThreadInit* =
|
||||
# This must be called in each thread that is going to use logging
|
||||
newSeq(dynamicProperties, 0)
|
||||
|
||||
proc addDynamicProp[T](name: string, value: T) =
|
||||
dynamicProperties.add ScopeBinding[T](name: name,
|
||||
value: value,
|
||||
appender: appenderIMPL[T])
|
||||
|
||||
proc logAllDynamicProperties*(log: var LogOutput) =
|
||||
# This proc is intended for internal use only
|
||||
for p in dynamicProperties: p.appender(log, p)
|
||||
|
||||
macro dynamicLogScope*(args: varargs[untyped]): untyped =
|
||||
# XXX: open question: should we support overriding
|
||||
# of dynamic props inside inner scopes. This will
|
||||
# have some run-time overhead.
|
||||
let body = args[^1]
|
||||
args.del(args.len - 1)
|
||||
|
||||
if body.kind != nnkStmtList:
|
||||
error "dynamicLogScope expects a block"
|
||||
|
||||
let addDynamicProp = bindSym"addDynamicProp"
|
||||
|
||||
var setProps = newTree(nnkStmtList)
|
||||
for name, value in assignments(args):
|
||||
setProps.add newCall(addDynamicProp, newLit(name), value)
|
||||
|
||||
result = quote:
|
||||
var currentDynamicScopesEntries = dynamicProperties.len
|
||||
try:
|
||||
`setProps`
|
||||
`body`
|
||||
finally:
|
||||
dynamicProperties.setLen currentDynamicScopesEntries
|
||||
|
||||
chroniclesThreadInit()
|
||||
|
||||
|
|
@ -0,0 +1,174 @@
|
|||
import
|
||||
times, strutils
|
||||
|
||||
const
|
||||
chronicles_timestamps {.strdefine.} = "on"
|
||||
chronicles_sinks {.strdefine.} = ""
|
||||
chronicles_indent {.intdefine.} = 2
|
||||
|
||||
enableTimestamps = chronicles_timestamps.toLowerAscii == "on"
|
||||
indent = repeat(' ', chronicles_indent)
|
||||
|
||||
when chronicles_timestamps.toLowerAscii notin ["on", "off"]:
|
||||
{.error: "chronicles_timestamps must be set to either 'on' or 'off'".}
|
||||
|
||||
type
|
||||
FileOutput = object
|
||||
|
||||
LogLevel* = enum
|
||||
ALL,
|
||||
DEBUG,
|
||||
INFO,
|
||||
NOTICE,
|
||||
WARN,
|
||||
ERROR,
|
||||
FATAL,
|
||||
NONE
|
||||
|
||||
TextlineRecord[Output] = object
|
||||
output: Output
|
||||
|
||||
TextblockRecord[Output] = object
|
||||
output: Output
|
||||
|
||||
JsonRecord[Output] = object
|
||||
output: Output
|
||||
|
||||
var
|
||||
logOutput: File
|
||||
|
||||
when chronicles_sinks.len > 0:
|
||||
{.error: "X".}
|
||||
else:
|
||||
type
|
||||
LogOutput* = TextblockRecord[FileOutput]
|
||||
|
||||
template append(o: var FileOutput, s: string) =
|
||||
logOutput.write s
|
||||
|
||||
template setStyle(o: var FileOutput, lvl: LogLevel) =
|
||||
append(o, "[")
|
||||
append(o, $lvl)
|
||||
append(o, "] ")
|
||||
|
||||
template resetStyle(o: var FileOutput) =
|
||||
discard
|
||||
|
||||
template flushOutput(o: var FileOutput) =
|
||||
logOutput.flushFile
|
||||
|
||||
template append(o: var string, s: string) =
|
||||
o.add(s)
|
||||
|
||||
template flushOutput(o: var string) =
|
||||
discard
|
||||
|
||||
template setStyle(o: var string, lvl: LogLevel) =
|
||||
append(o, "[")
|
||||
append(o, $lvl)
|
||||
append(o, "] ")
|
||||
|
||||
template resetStyle(o: var string) =
|
||||
discard
|
||||
|
||||
proc appendTimestamp(o: var auto) =
|
||||
var ts = now()
|
||||
append(o, $ts.year)
|
||||
append(o, "-")
|
||||
append(o, intToStr(ord(ts.month), 2))
|
||||
append(o, "-")
|
||||
append(o, intToStr(ts.monthday, 2))
|
||||
append(o, " ")
|
||||
append(o, intToStr(ts.hour, 2))
|
||||
append(o, ":")
|
||||
append(o, intToStr(ts.minute, 2))
|
||||
append(o, ":")
|
||||
append(o, intToStr(ts.second, 2))
|
||||
|
||||
# Text line record
|
||||
|
||||
template setEventName*(r: var TextlineRecord, lvl: LogLevel, name: string) =
|
||||
when enableTimestamps:
|
||||
append(r.output, "[")
|
||||
appendTimestamp(r.output)
|
||||
append(r.output, "] ")
|
||||
setStyle(r.output, lvl)
|
||||
append(r.output, name & ":")
|
||||
|
||||
template setFirstProperty*(r: var TextlineRecord, key: string, val: auto) =
|
||||
append(r.output, " ")
|
||||
append(r.output, key)
|
||||
append(r.output, "=")
|
||||
append(r.output, $val)
|
||||
|
||||
template setProperty*(r: var TextlineRecord, key: string, val: auto) =
|
||||
append(r.output, ",")
|
||||
setFirstProperty(r, key, val)
|
||||
|
||||
template flushRecord*(r: var TextlineRecord) =
|
||||
append(r.output, "\n")
|
||||
flushOutput(r.output)
|
||||
resetStyle(r.output)
|
||||
|
||||
# Textblock records
|
||||
|
||||
template setEventName*(r: var TextblockRecord, lvl: LogLevel, name: string) =
|
||||
when enableTimestamps:
|
||||
append(r.output, "[")
|
||||
appendTimestamp(r.output)
|
||||
append(r.output, "] ")
|
||||
setStyle(r.output, lvl)
|
||||
append(r.output, name & "\n")
|
||||
resetStyle(r.output)
|
||||
|
||||
template setFirstProperty*(r: var TextblockRecord, key: string, val: auto) =
|
||||
append(r.output, indent)
|
||||
append(r.output, key)
|
||||
append(r.output, ": ")
|
||||
append(r.output, $val)
|
||||
append(r.output, "\n")
|
||||
|
||||
template setProperty*(r: var TextblockRecord, key: string, val: auto) =
|
||||
setFirstProperty(r, key, val)
|
||||
|
||||
template flushRecord*(r: var TextblockRecord) =
|
||||
append(r.output, "\n")
|
||||
flushOutput(r.output)
|
||||
|
||||
# JSON output
|
||||
|
||||
import json
|
||||
|
||||
template jsonEncode(x: auto): string = $(%x)
|
||||
|
||||
template setEventName*(r: var JsonRecord, lvl: LogLevel, name: string) =
|
||||
append(r.output, """{"msg": """ & name.jsonEncode &
|
||||
""", "lvl": """ & ($lvl).jsonEncode)
|
||||
|
||||
when enableTimestamps:
|
||||
var ts: string
|
||||
appendTimestamp(ts)
|
||||
append(r.output, ""","ts": """)
|
||||
append(r.output, ts.jsonEncode)
|
||||
|
||||
template setFirstProperty*(r: var JsonRecord, key: string, val: auto) =
|
||||
append(r.output, ", ")
|
||||
append(r.output, key.jsonEncode)
|
||||
append(r.output, ": ")
|
||||
append(r.output, val.jsonEncode)
|
||||
|
||||
template setProperty*(r: var JsonRecord, key: string, val: auto) =
|
||||
setFirstProperty(r, key, val)
|
||||
|
||||
template flushRecord*(r: var JsonRecord) =
|
||||
append(r.output, "}\n")
|
||||
flushOutput(r.output)
|
||||
|
||||
template optimizeLogWrites*{
|
||||
write(f, x)
|
||||
write(f, y)
|
||||
}(x, y: string{lit}, f: File) =
|
||||
write(f, x & y)
|
||||
|
||||
logOutput = stdout
|
||||
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
import macros
|
||||
|
||||
iterator assignments*(n: NimNode, skip = 0): (string, NimNode) =
|
||||
# extract the assignment pairs from a block with assigments
|
||||
# or a call-site with keyword arguments.
|
||||
for i in skip ..< n.len:
|
||||
let child = n[i]
|
||||
if child.kind in {nnkAsgn, nnkExprEqExpr}:
|
||||
let name = $child[0]
|
||||
let value = child[1]
|
||||
yield (name, value)
|
||||
else:
|
||||
error "A scope definitions should consist only of key-value assignments"
|
||||
|
||||
|
|
@ -0,0 +1 @@
|
|||
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
import chronicles
|
||||
|
||||
logScope:
|
||||
topics = "main"
|
||||
|
||||
type
|
||||
Seconds = distinct int
|
||||
|
||||
proc `$`*(t: Seconds): string = $(t.int) & "s"
|
||||
proc `%`*(t: Seconds): string = $(t.int)
|
||||
|
||||
proc main =
|
||||
dynamicLogScope(reqId = 10, userId = 20):
|
||||
info "test"
|
||||
|
||||
warn("about to exit", timeSpent = 2.Seconds)
|
||||
|
||||
main()
|
||||
|
||||
|
|
@ -0,0 +1,26 @@
|
|||
import chronicles
|
||||
|
||||
logScope:
|
||||
a = 12
|
||||
b = "original-b"
|
||||
|
||||
logScope:
|
||||
x = 16
|
||||
b = "overriden-b"
|
||||
|
||||
logScope:
|
||||
c = 100
|
||||
|
||||
proc main =
|
||||
logScope:
|
||||
c = 10
|
||||
|
||||
logScope:
|
||||
z = 20
|
||||
|
||||
info("main started", a = 10, b = "inner-b", d = "some-d")
|
||||
|
||||
main()
|
||||
|
||||
info("exiting", msg = "bye bye")
|
||||
|
||||
Loading…
Reference in New Issue