Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/captainqwerty/write-log

A basic module to assist with creating a log within your project.
https://github.com/captainqwerty/write-log

log logging powershell powershell-module

Last synced: 1 day ago
JSON representation

A basic module to assist with creating a log within your project.

Awesome Lists containing this project

README 

        





[![Contributors][contributors-shield]][contributors-url]

[![Forks][forks-shield]][forks-url]

[![Stargazers][stars-shield]][stars-url]

[![Issues][issues-shield]][issues-url]

[![LinkedIn][linkedin-shield]][linkedin-url]






Write-Log



  


    A simple project to easily add a log to your projects

    


    Releases -

    Report Bug

  





## About The Project



This project was to just offer people a easy way to quickly add the ability to output a nice, simple log within their own projects. There are two versions in this project known as the *Class Version* and the *Module Version*.



### Class Version



The class Version is the preferred version however this version is limited to PowerShell Version 5.0 and greater and utilises the *Using* statement.



### Module Version



The Module Version is available for those prefering to use *Import-Module* and those using older versions of PowerShell as the Class version will not work on PowerShell versions prior to 5.0.



(Back to top)



## Getting Started



### Prerequisites



* PowerShell version 2.0 or greater - Module Version.

* PowerShell version 5.0 or greater - Either version.



### Installation of Class Version



1. Download the latest release.

2. Extract the zipped folder.

3. Place the "Write-Log" folder in your project's folder or in a location the script can access under the context it will be ran.

4. Add the Using statement pointing to the Write-Log-Class.psm1 file. Please note, using statements must be the very first lines of your script.  In this example the Write-Log folder containing the file is in the root folder with the script calling it.

```ps1

using module ".\Write-Log\Write-Log-Class.psm1"

```

5. See Class Version Usage section for examples on how to configure the log location and add entries.



### Installation of Module Version



1. Download the latest release.

2. Extract the zipped folder.

3. Ensure the Write-log.psm1 remains in a folder called "Write-Log" and place the Write-Log folder in your project's folder or in a location the script can access under the context it will be ran.

4. Import the Module. In this example the Write-Log folder is in the root of the project folder. 

```ps1

$module = "$PSScriptRoot\Write-Log"

if(!(test-path $module)){

    write-host "$module not found" -ForegroundColor Red

    exit

}

Import-Module $module

```

5. See Module Version Usage section for examples on how to configure the log location and add entries.

6. Add the Remove-Module line to the bottom of your script.

```ps1

Remove-Module Write-Log

```



(Back to top)



## Usage of the Class Version

```ps1

using module ".\Class\Write-Log\Write-Log-Class.psm1"



$Log = [WriteLog]::New("C:\Example\mylog.log")



$Log.AddInfo("Something occurred that was worth making an info log about")

$Log.AddError("There was a huge error!")

$Log.AddWarning("Oh dear, I should really warn you about this!")

$Log.AddEntry("Testing","Test Severity") #This method is hidden but can be used for custom severities

```

The below example shows having mutliple Write-Log objects to store different types or log entries in different logs.



```ps1

using module ".\Class\Write-Log\Write-Log-Class.psm1"



$InfoLog = [WriteLog]::New("C:\Example\Info.log")

$ErrorLog = [WriteLog]::New("C:\Example\Errors.log")

$WarningLog = [WriteLog]::New("C:\Example\Warning.log")



$InfoLog.AddInfo("Something occurred that was worth making an info log about")

$ErrorLog.AddError("There was a huge error!")

$WarningLog.AddWarning("Oh dear, I should really warn you about this!")

```



## Usage of the Module version

```ps1

$module = "$PSScriptRoot\Module\Write-Log"

if(!(test-path $module)){

    write-host "$module not found" -ForegroundColor Red

    exit

}

Import-Module $module



$logLocation = "C:\Example\Log.log"



write-log "This is an example Info" -logLocation $logLocation

write-log "This is an example Error" -severity "Error" -logLocation $logLocation

write-log "This is an example Warning" -severity "Warning" -logLocation $logLocation



Remove-Module Write-Log

```

Below is an example of having seperate logs for Info, Error and Warning entries.

```ps1

$module = "$PSScriptRoot\Module\Write-Log"

if(!(test-path $module)){

    write-host "$module not found" -ForegroundColor Red

    exit

}

Import-Module $module



$InfoLog = "C:\Example\Log.log"

$ErrorLog = "C:\Example\Errors.log"

$WarningLog = "C:\Example\Warning.log"



write-log "This is an example Info" -logLocation $InfoLog

write-log "This is an example Error" -severity "Error" -logLocation $ErrorLog

write-log "This is an example Warning" -severity "Warning" -logLocation $WarningLog



Remove-Module Write-Log

```

(Back to top)



## Contributing



Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.



If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

Don't forget to give the project a star! Thanks again!



1. Fork the Project

2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)

3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)

4. Push to the Branch (`git push origin feature/AmazingFeature`)

5. Open a Pull Request



(Back to top)



## Acknowledgments



* [Othneildrew's Best-README-Template](https://github.com/othneildrew/Best-README-Template)

* [matthewjdegarmo](https://github.com/matthewjdegarmo) - Excellent suggestion on moving from ValidationSet in the module version and improvements / corrections to the ReadMe

* [SeidChr](https://github.com/SeidChr) - For prompting the addition of .txt

* [sean2390](https://github.com/sean2390) - Further spelling and grammar corrections in the ReadMe.



(Back to top)



[contributors-shield]: https://img.shields.io/github/contributors/captainqwerty/Write-Log.svg?style=for-the-badge

[contributors-url]: https://github.com/captainqwerty/Write-Log/graphs/contributors

[forks-shield]: https://img.shields.io/github/forks/captainqwerty/Write-Log.svg?style=for-the-badge

[forks-url]: https://github.com/captainqwerty/Write-Log/network/members

[stars-shield]: https://img.shields.io/github/stars/captainqwerty/Write-Log.svg?style=for-the-badge

[stars-url]: https://github.com/captainqwerty/Write-Log/stargazers

[issues-shield]: https://img.shields.io/github/issues/captainqwerty/Write-Log.svg?style=for-the-badge

[issues-url]: https://github.com/captainqwerty/Write-Log/issues

[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555

[linkedin-url]: https://www.linkedin.com/in/antonybragg/