https://github.com/tjc-tools/tjc.logging

Logging
https://github.com/tjc-tools/tjc.logging

logging logging-library nuget-package

Last synced: about 1 month ago
JSON representation

Logging

• Host: GitHub
• URL: https://github.com/tjc-tools/tjc.logging
• Owner: TJC-Tools
• License: mit
• Created: 2024-06-07T00:43:48.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-10-06T04:20:55.000Z (about 2 months ago)
• Last Synced: 2024-10-09T11:05:07.049Z (about 1 month ago)
• Topics: logging, logging-library, nuget-package
• Language: C#
• Homepage: https://www.nuget.org/packages/TJC.Logging/
• Size: 92.8 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![GitHub Tag](https://img.shields.io/github/v/tag/TJC-Tools/TJC.Logging) [![GitHub Release](https://img.shields.io/github/v/release/TJC-Tools/TJC.Logging)

](https://github.com/TJC-Tools/TJC.Logging/releases/latest) [![NuGet Version](https://img.shields.io/nuget/v/TJC.Logging)](https://www.nuget.org/packages/TJC.Logging)

[![NuGet Downloads](https://img.shields.io/nuget/dt/TJC.Logging)](https://www.nuget.org/packages/TJC.Logging) ![Size](https://img.shields.io/github/repo-size/TJC-Tools/TJC.Logging) [![License](https://img.shields.io/github/license/TJC-Tools/TJC.Logging.svg)](LICENSE)

## Table of Contents

- [Format](#format)

- [Extensions](#extensions)

  - [Trackers](#trackers)

  - [Get & Set](#get--set)

  - [Elapsed Time](#elapsed-time)

  - [Pluralize](#pluralize)

---

## Format

- Timestamp

- Location (`Namespace`, `Type Name`, `Member Name`, `Line Number`)

- Specialty (E.g. `Get`, `Set`, `Tracker`)

---

## Extensions

### Debugging

#### [ILogger.LogMark()](TJC.Logging/Extensions/LogMarkExtension.cs)

> Logs detailed information about the current execution location.

#### [ILogger.LogStep(int step)](TJC.Logging/Extensions/LogStepExtension.cs)

> Logs detailed information about the current execution location, including a step number for debugging purposes.

##### Example

```csharp

var step = 0; 

ILogger.LogStep(ref step);

// Do first step

ILogger.LogStep(ref step);

// Do second step

```

---

### Trackers

#### [ILogger.LogStart()](TJC.Logging/Extensions/Specialty/LogTrackerExtensions.cs)

> Returns a [LogTracker](TJC.Logging/Trackers/LogTracker.cs) that is used to track the duration & status of a process.

#### [ILogger.LogEnd(LogTracker, CompletionStatus, Exception)](TJC.Logging/Extensions/Specialty/LogTrackerExtensions.cs)

> Logs the duration & completion status of a process.

#### [ILogger.LogSuccess(LogTracker)](TJC.Logging/Extensions/Specialty/LogTrackerExtensions.cs)

> Logs the duration & completion status of a successful process.

#### [ILogger.LogFail(LogTracker, Exception)](TJC.Logging/Extensions/Specialty/LogTrackerExtensions.cs)

> Logs the duration & completion status of a failed process.

---

### Get & Set

#### [ILogger.LogGet\(T obj)](TJC.Logging/Extensions/Specialty/LogGetExtension.cs)

> Logs the value of an object and returns the object.

#### [ILogger.LogSet\(ref T obj, T value)](TJC.Logging/Extensions/Specialty/LogSetExtension.cs)

> Logs the before and after values of a property and set it when done.

---

### Elapsed Time

[TimeSpan.GetElapsedTime()](TJC.Logging\Extensions\ElapsedTime\ElapsedTimeExtensions.cs)

> Returns a formatted string of the elapsed time.

---

### Pluralize

[string.Pluralize()](TJC.Logging\Extensions\Pluralize\PluralizeExtensions.cs)

> Returns a pluralized string if the count is greater than 1.