Simple and very flexible tool for development with .NET Core. Saves logs to a file, or a database where you want. Also gives opportunity to receive logs via email with the proper configuration. SimpLog.FileLog is for those who want to use only the functionality of saving into a file.
| Type | Description |
|---|---|
| Trace | This should be used during development to track bugs, but never committed to your VCS. |
| Debug | Log at this level about anything that happens in the program. This is mostly used during debugging, and I’d advocate trimming down the number of debug statement before entering the production stage, so that only the most meaningful entries are left, and can be activated during troubleshooting. |
| Info | Log at this level all actions that are user-driven, or system specific (ie regularly scheduled operations…) |
| Notice | This will certainly be the level at which the program will run when in production. Log at this level all the notable events that are not considered an error. |
| Warn | Log at this level all events that could potentially become an error. For instance if one database call took more than a predefined time, or if an in-memory cache is near capacity. This will allow proper automated alerting, and during troubleshooting will allow to better understand how the system was behaving before the failure. |
| Error | Log every error condition at this level. That can be API calls that return errors or internal error conditions. |
| Fatal | Too bad, it’s doomsday. Use this very scarcely, this shouldn’t happen a lot in a real program. Usually logging at this level signifies the end of the program. For instance, if a network daemon can’t bind a network socket, log at this level and exit is the only sensible thing to do. |
| Features | Description |
|---|---|
| 📃 Log into a file | With SimpLog you can save logs into a file where you want on your local machine. |
| 🕷 Support Debug | If you have any issues with the library, it has its log into a file. Just send us the content from there and we will take care of the rest. The configuration is in SimpLog:Main fields in appsettings.json. |
In Program.cs In Program.cs only if you use buffer type for saving into a log file. In other cases it is not needed at all.
await ServicesExtensions.SimpLog();
In Controller
private SimpLog _simpLog = new SimpLog();
and call the log like
_simpLog.Trace("place your message here");
options are as follows
_simpLog.Info({1}, {2}, {3}, {4});
and only {1} is required
| Option | Short Description | Full Description |
|---|---|---|
| {1} | Message | The message you want to log. |
| {2} | Save file type | There are three types of save type. See the table below |
| {3} | Path to save log | If you need this instance to be saved in a different path, here place the new path of the log file. If it is null, file path will be taken from appsettings.json. The default path, if not set anywhere is the temp folder of the current user on the local machine. |
| {4} | Log file name | If you need for this instance log file to be saved in a separate file with specific filename, set it here. If it is null, filename will be taken from appsettings.json. If no value is set here or in the appsettings.json the file will be with name SimpLog_ and todays number of the day of the year. If the log has been created on the first of February, then the filename if not set nowhere, by default will be SimpLog_32.txt |
File Save Types
| Name | Description |
|---|---|
| DontSave | This option disables saving into a file only when called for the specific case! |
| Standart | Opens file, saves it and closes file. On every request it opens and closes again the file |
| BufferMemory | Creates buffer memory and a background process is also working in this case. When the information in the buffer become more than 95 characters, opens log file, saves the content and closes it. It is not on every request but on 95 symbols or every minute. Possible data loss in this case! |
In simplog.json
Create simplog.json file in the root folder of your startup project. On the same level where is appsettings.json. Please have in mind that every configuration in simplog.json is optional
"SimpLog": { -> all of the below fields are optional
"Main": {
"WhyLogIsNotWorkingPath": string, -> If you want it to be saved somewhere else, just place here the path. Default value is
"WhyLogIsNotWorkingFileName": string, -> The file name of the custom log for the SimpLog library. If you need our support, needs to be send the content of this file.
"Disable_Log": bool -> If you want to disable SimpLog library log for library issues, then turn it to true. Default value is
},
"File_Configuration": { -> The configuration for log into a file.
"PathToSaveLogs": string, -> Path to save the log. Default is Temp folder for the user in local machine.
"LogFileName": string, -> Log name of the log. Default value is "SimpLog_" + DateTime.Now.DayOfYear.ToString()
"Enable_File_Log": bool -> Default value is true. If you want to disable the file log, should be set to false.
},
"LogType": {
"Trace": { -> TYPE OF LOG == Trace.
"Log": true, -> For the type Trace, should be enabled or disabled logging into a file. Default value is true.
},
"Debug": { -> Analogically TYPE OF LOG here is Debug
"Log": true
},
"Info": { -> Analogically TYPE OF LOG here is Info
"Log": true
},
"Notice": { -> Analogically TYPE OF LOG here is Notice
"Log": true
},
"Warn": { -> Analogically TYPE OF LOG here is Warn
"Log": true
},
"Error": { -> Analogically TYPE OF LOG here is Error
"Log": true
},
"Fatal": { -> Analogically TYPE OF LOG here is Fatal
"Log": true
}
}
}
- If path was not set by you nowhere, check in Temp folder for your user in the local machine
- If name was not set nowhere, the default one is "SimpLog_" + DateTime.Now.DayOfYear.ToString()
Hope you enjoy the NuGet Package! 😉