Logger
This page is about the Logger class available in PeyrSharp.Env. You can find here all of its methods.
INFO
This class is static.
Compatibility
The Logger class is part of the PeyrSharp.Env module, and is compatible with all of these frameworks and platforms:
| Package/Platform | Windows | macOS | Linux + others |
|---|---|---|---|
| Env | ✅ | ✅ | ✅ |
| Framework | .NET 5 | .NET 6 | .NET 7 |
| Env | ✅ | ✅ | ✅ |
WARNING
Some methods, classes or features of PeyrSharp.Env might not be available in all platforms.
Methods
Log(message, filePath, dateTime)
Definition
The Log() method logs a specific message alongside a timestamp into a file. This method does not return a value (void).
INFO
You can call this method multiple times on the same file and it will append the message to it.
Arguments
| Type | Name | Meaning |
|---|---|---|
string | message | The message or text that needs to be logged. |
string | filePath | The path where the file should be written. |
DateTime | dateTime | The timestamp of the log, the time when the log was made. |
Usage
c#
using PeyrSharp.Env;
Logger.Log("Hello", @"C:\Logs\log1.txt", DateTime.Now)
// The line above will generate a file with the following content:
// [10/31/2022 09:23:18] Hellousing PeyrSharp.Env;
Logger.Log("Hello", @"C:\Logs\log1.txt", DateTime.Now)
// The line above will generate a file with the following content:
// [10/31/2022 09:23:18] HelloLog(message, filePath, formatString)
Definition
Logs a formatted message to a file. This method does not return a value.
Arguments
| Type | Name | Meaning |
|---|---|---|
string | message | The log message to be written. |
string | filePath | The path to the log file. Must contain an extension. |
object[] | formatString | An object array that contains zero or more objects to format. |
Usage
c#
using PeyrSharp.Env;
string message = "This is a log message. Date: {0}.";
string filePath = @"C:\Logs\log.txt";
DateTime date = DateTime.Now;
Logger.Log(message, filePath, date);using PeyrSharp.Env;
string message = "This is a log message. Date: {0}.";
string filePath = @"C:\Logs\log.txt";
DateTime date = DateTime.Now;
Logger.Log(message, filePath, date);Log(message, filePath, dateTime, logLevel)
Definition
Logs a message with the specified severity level, file path, and timestamp. This method does not return a value.
Arguments
| Type | Name | Meaning |
|---|---|---|
string | message | The message to log. |
string | filePath | The path to the file where the message was logged. |
DateTime | dateTime | The timestamp for the log message. |
LogLevel | logLevel | The severity level for the log message. |
Usage
c#
using PeyrSharp.Enums;
using PeyrSharp.Env;
string message = "This is a log message.";
string filePath = @"C:\Logs\log.txt";
DateTime date = DateTime.Now;
LogLevel logLevel = LogLevel.Warning;
Logger.Log(message, filePath, date, logLevel);using PeyrSharp.Enums;
using PeyrSharp.Env;
string message = "This is a log message.";
string filePath = @"C:\Logs\log.txt";
DateTime date = DateTime.Now;
LogLevel logLevel = LogLevel.Warning;
Logger.Log(message, filePath, date, logLevel);