magic.lambda.logging 17.2.0

dotnet add package magic.lambda.logging --version 17.2.0
NuGet\Install-Package magic.lambda.logging -Version 17.2.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="magic.lambda.logging" Version="17.2.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add magic.lambda.logging --version 17.2.0
#r "nuget: magic.lambda.logging, 17.2.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install magic.lambda.logging as a Cake Addin
#addin nuget:?package=magic.lambda.logging&version=17.2.0

// Install magic.lambda.logging as a Cake Tool
#tool nuget:?package=magic.lambda.logging&version=17.2.0

magic.lambda.logging - Log support in Hyperlambda

This project contains logging wrapper slots for Magic. More specifically, this project provides the following slots allowing you to create log entries.

  • [log.info] - Information log entries, typically smaller pieces of information
  • [log.debug] - Debug log entries, typically additional debugging information not enabled in production
  • [log.error] - Error log entries, typically exceptions
  • [log.fatal] - Fatal log entries, from which the application cannot recover from

In addition to the above slots there are also slots that allows you to retrieve log items, and/or some basic statistics from your log. These can be found below.

  • [log.count] - Counts number of log items, optionally matching the specified filter condition
  • [log.get] - Returns the log item with the specified id
  • [log.query] - Returns a list of log items according to its arguments
  • [log.capabilities] - Returns the capabilities of the log implementation

By default, this project will log into your magic.log_entries database/table, using either MySQL, PostgreSQL, Microsoft SQL Server or SQLite. This allows you to use SQL to generate statistics on top of your logs. An example of creating a log entry can be found below.

log.info:Howdy world from magic.lambda.logging

You can of course exchange the above [log.info] with [log.error], [log.debug] or [log.fatal].

Children nodes will be assumed to be "meta information" associated with the invocation, allowing you to log data such as follows.

log.info:Some log entry
   username:foo
   ip:123.123.123.123

The above will log "some log entry" for you, and associate [username] and [ip] with your log entry as meta data. This allows you to use the same log entry for similar log types, and parametrise your log entry with meta information, giving you aggregate capabilities on log entries having the same content, while still preserving meta information unique to each log entry. Notice, if you don't provide a value to your log invocation, no meta data will be associated with your log entry, but all arguments will rather be concatenated as a single string and end up in the "content" parts of your log entry after having been evaluated.

Exception logging

The [log.error] and [log.fatal] slots give you the option of logging an exception stack trace, by parametrising your invocation with an [exception] argument, which will not be assumed to be meta information, but rather end up in the "exception" column as you create the log item. All other parameters will still be evaluated or used as meta information.

Log level configuration

The slots [log.debug], [log.info], [log.error], and [log.fatal] are actually logging with their last parts becoming the "type" of log item. This is similar to how Log4Net and Log4J works, and can be turned on and off as you see fit. The level is an increasing leverage type of value, applied in the following order.

  • debug
  • info
  • error
  • fatal

This implies that if you set the level to for instance "error" no invocations to [log.debug] or [log.info] will log anything into your log, allowing you to "turn up and down" the level of logging you need as a configuration setting through your "appsetting.json" file. Below is an example configuration setting the level to "info". The default value for log level is "debug". In a production environment you might want to increase this to at least "info".

{
  "magic": {
    "logging": {
      "level": "info"
    }
  }
}

The above value will for instance log everything except invocations to [log.debug].

Querying your log

Notice - To see the capabilities of your particular log implementation please invoke [log.capabilities] and verify your particular log implementation can actually do what you need for it to do, since not all implementations have the same capabilities - Implying things such as filtering log items according to content, and/or timeshifting log items, etc, might not be implemented for your particular implementation.

To retrieve log items sequentially you can use [log.query]. This slot can optionally take a [from] argument being the id of an existing log item from where to start retrieving items, and a [max] argument being the maximum number of records to return. If no [max] argument is specified, the default value of this is 10. In addition the invocation can be fiven a string as its value, which if given must match the content of your log items for an item to be returned. Below is an example of usage.

log.query:"We successfully authenticated user 'root'"
   from:555
   max:20

The above will return log items starting from id 554 and down, and return only 20 records, and all returned records will have a content value of "We successfully authenticated user 'root'". To return a single log item you can use [log.get] and pass in the id of the log item you want to retrieve as its value.

Notice - If your particular log implementation does not support querying you cannot query items according to content as illustrated above, but rather only page items. Invoke [log.capabilities] to see if your implementation supports querying before relying upon its existence.

Magic's GitHub project page

Magic is 100% Open Source and you can find the primary project GitHub page here.

Project website for magic.lambda.logging

The source code for this repository can be found at github.com/polterguy/magic.lambda.logging, and you can provide feedback, provide bug reports, etc at the same place.

  • Build status
  • Quality Gate Status
  • Bugs
  • Code Smells
  • Coverage
  • Duplicated Lines (%)
  • Lines of Code
  • Maintainability Rating
  • Reliability Rating
  • Security Rating
  • Technical Debt
  • Vulnerabilities

The projects is copyright Thomas Hansen 2023 - 2024, and professionally maintained by AINIRO.IO.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (4)

Showing the top 4 NuGet packages that depend on magic.lambda.logging:

Package Downloads
magic.library

Helper project for Magic to wire up everything easily by simply adding one package, and invoking two simple methods. When using Magic, this is (probably) the only package you should actually add, since this package pulls in everything else you'll need automatically, and wires up everything sanely by default. To use package go to https://polterguy.github.io

magic.lambda.scheduler

Helper slots for Magic to allow you to dynamically create tasks, either as a part of your custom workflow, and/or as scheduled tasks intended to be executed at some interval, or future time. To use package go to https://polterguy.github.io

magic.lambda.sockets

Web socket helper project for Magic, giving you support for web sockets connections from and to Hyperlambda. To use package go to https://polterguy.github.io

magic.data.cql

CQL data adapters for Magic to store files and folders, etc. To use package go to https://polterguy.github.io

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
17.2.0 357 1/22/2024
17.1.7 221 1/12/2024
17.1.6 205 1/11/2024
17.1.5 216 1/5/2024
17.0.1 264 1/1/2024
17.0.0 679 12/14/2023
16.11.5 674 11/12/2023
16.9.0 680 10/9/2023
16.7.0 1,098 7/11/2023
16.4.1 908 7/2/2023
16.4.0 948 6/22/2023
16.3.1 972 6/7/2023
16.3.0 950 5/28/2023
16.1.9 1,276 4/30/2023
15.10.11 1,243 4/13/2023
15.9.1 1,331 3/27/2023
15.9.0 1,218 3/24/2023
15.8.2 1,243 3/20/2023
15.7.0 1,183 3/6/2023
15.5.0 2,592 1/28/2023
15.2.0 1,735 1/18/2023
15.1.0 2,253 12/28/2022
14.5.7 1,831 12/13/2022
14.5.5 1,990 12/6/2022
14.5.1 1,937 11/23/2022
14.5.0 1,880 11/18/2022
14.4.5 2,157 10/22/2022
14.4.1 2,179 10/22/2022
14.4.0 2,138 10/17/2022
14.3.1 2,570 9/12/2022
14.3.0 1,934 9/10/2022
14.1.3 2,250 8/7/2022
14.1.2 1,957 8/7/2022
14.1.1 1,863 8/7/2022
14.0.14 1,975 7/26/2022
14.0.12 1,939 7/24/2022
14.0.11 1,951 7/23/2022
14.0.10 1,975 7/23/2022
14.0.9 1,962 7/23/2022
14.0.8 1,999 7/17/2022
14.0.5 2,034 7/11/2022
14.0.4 2,064 7/6/2022
14.0.3 2,032 7/2/2022
14.0.2 1,945 7/2/2022
14.0.0 2,201 6/25/2022
13.4.0 3,572 5/31/2022
13.3.4 2,702 5/9/2022
13.3.1 2,043 5/1/2022
13.3.0 2,028 5/1/2022
13.2.0 2,491 4/21/2022
13.1.0 2,329 4/7/2022
13.0.0 2,026 4/5/2022
11.0.5 2,752 3/2/2022
11.0.4 2,051 2/22/2022
11.0.3 2,107 2/9/2022
11.0.2 2,097 2/6/2022
11.0.1 490 2/5/2022
11.0.0 2,089 2/5/2022
10.0.21 2,088 1/28/2022
10.0.20 2,112 1/27/2022
10.0.19 2,040 1/23/2022
10.0.18 1,811 1/17/2022
10.0.16 717 1/14/2022
10.0.15 1,563 12/31/2021
10.0.14 1,307 12/28/2021
10.0.7 2,105 12/22/2021
10.0.5 1,442 12/18/2021
9.9.9 2,268 11/29/2021
9.9.3 1,676 11/9/2021
9.9.2 1,386 11/4/2021
9.9.0 1,538 10/30/2021
9.8.9 864 10/29/2021
9.8.7 824 10/27/2021
9.8.6 789 10/27/2021
9.8.5 869 10/26/2021
9.8.0 1,501 10/20/2021
9.7.9 731 10/19/2021
9.7.5 1,618 10/14/2021
9.7.0 1,022 10/9/2021
9.6.6 1,193 8/14/2021
9.2.0 6,487 5/26/2021
9.1.4 1,424 4/21/2021
9.1.0 1,183 4/14/2021
9.0.0 982 4/5/2021
8.9.9 1,145 3/30/2021
8.9.3 1,711 3/19/2021
8.9.2 1,176 1/29/2021
8.9.1 1,177 1/24/2021
8.9.0 1,238 1/22/2021
8.6.9 3,142 11/8/2020
8.6.7 1,198 11/4/2020
8.6.6 1,412 11/2/2020
8.6.0 4,171 10/28/2020
8.5.0 2,052 10/23/2020
8.4.0 5,733 10/13/2020
8.3.1 2,979 10/5/2020
8.3.0 1,401 10/3/2020
8.2.2 2,210 9/26/2020
8.2.1 1,535 9/25/2020
8.2.0 1,422 9/25/2020
8.1.17 6,820 9/13/2020
8.1.16 633 9/13/2020
8.1.15 2,225 9/12/2020
8.1.11 2,690 9/11/2020
8.1.10 1,482 9/6/2020
8.1.9 1,499 9/3/2020
8.1.8 1,438 9/2/2020
8.1.7 1,377 8/28/2020
8.1.4 1,385 8/25/2020
8.1.3 1,391 8/18/2020
8.1.2 1,422 8/16/2020
8.1.1 1,486 8/15/2020
8.1.0 546 8/15/2020
8.0.1 2,632 8/7/2020
8.0.0 1,230 8/7/2020
7.0.1 1,350 6/28/2020
7.0.0 1,197 6/28/2020
5.0.1 3,276 5/29/2020
5.0.0 4,641 2/25/2020
4.0.4 7,775 1/27/2020
4.0.3 1,236 1/27/2020
4.0.2 1,383 1/16/2020
4.0.1 1,380 1/11/2020
4.0.0 1,355 1/5/2020
3.1.0 6,230 11/10/2019
3.0.0 3,800 10/23/2019
2.0.1 8,095 10/15/2019
2.0.0 1,586 10/13/2019
1.1.9 1,313 10/11/2019
1.1.8 1,288 10/10/2019
1.1.7 568 10/9/2019
1.1.6 550 10/6/2019
1.1.5 592 10/6/2019
1.1.4 593 10/6/2019
1.1.2 581 10/5/2019
1.0.0 624 9/26/2019