Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/PoShLog/PoShLog

:nut_and_bolt: PoShLog is PowerShell cross-platform logging module. It allows you to log structured event data into console, file and much more places easily. It's built upon great C# logging library Serilog - https://serilog.net/
https://github.com/PoShLog/PoShLog

enrichers error-log error-reporting event events log logger logging logs module powershell powershell-logging-module powershell-module serilog serilog-extension serilog-for-powershell serilog-sink sinks wrapper

Last synced: about 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/PoShLog/PoShLog
Owner: PoShLog
License: mit
Created: 2019-07-28T07:50:29.000Z (about 5 years ago)
Default Branch: master
Last Pushed: 2022-11-21T09:49:12.000Z (almost 2 years ago)
Last Synced: 2024-04-28T02:37:18.475Z (5 months ago)
Topics: enrichers, error-log, error-reporting, event, events, log, logger, logging, logs, module, powershell, powershell-logging-module, powershell-module, serilog, serilog-extension, serilog-for-powershell, serilog-sink, sinks, wrapper
Language: PowerShell
Homepage:
Size: 623 KB
Stars: 187
Watchers: 10
Forks: 19
Open Issues: 12
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-powershell - PoshLog - A PowerShell module that lets you log to files, the console, and more. 🚧 (🔍 Logging)
jimsghstars - PoShLog/PoShLog - :nut_and_bolt: PoShLog is PowerShell cross-platform logging module. It allows you to log structured event data into console, file and much more places easily. It's built upon great C# logging library (PowerShell)

README

        [![icon](https://github.com/PoShLog/PoShLog/blob/master/images/icons/poshlog-icon-64.png?raw=true)](https://github.com/PoShLog/PoShLog)

# PoShLog

[![psgallery](https://img.shields.io/powershellgallery/v/poshlog.svg)](https://www.powershellgallery.com/packages/PoShLog/) [![psgallery](https://img.shields.io/powershellgallery/dt/poshlog.svg)](https://www.powershellgallery.com/packages/PoShLog/) [![Discord](https://img.shields.io/discord/693754316305072199?color=orange&label=discord)](https://discord.gg/FVdVxuw) [![Build Status](https://tomlabscloud.visualstudio.com/PoShLog/_apis/build/status/PoShLog.PoShLog%20-%20BuildOnly?branchName=master)](https://tomlabscloud.visualstudio.com/PoShLog/_build/latest?definitionId=17&branchName=master) [![Support](https://img.shields.io/badge/%24-Support-blueviolet)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=GRARVRTVNEUHS)

>Serilog for powershell

PoShLog is powershell cross-platform logging module. PoShLog allows you to log structured event data into **console**, **file** and much more [places](https://github.com/PoShLog/PoShLog/wiki/Sinks) easily.

It's built upon great C# logging library [Serilog](https://serilog.net/).

## Key Features

* [x] Structured log event data

* [x] Clean and easy to use [API](https://github.com/PoShLog/PoShLog/wiki/Cmdlets)

* [x] Cross-platform

* [x] Easily extensible

## Getting started

If you are familiar with PowerShell, skip to [Installation](#installation) section. For more detailed installation instructions check out [Getting started](https://github.com/PoShLog/PoShLog/wiki/Getting-started) wiki.

### Installation

To install PoShLog, run following snippet from powershell:

```ps1

Install-Module PoShLog

```

## Usage

Setup logger using pipeline fluent API and write some log messages(*in this case into file and console*):

```ps1

Import-Module PoShLog

# Create new logger

# This is where you customize, when and how to log

New-Logger |

    Set-MinimumLevel -Value Verbose | # You can change this value later to filter log messages

    # Here you can add as many sinks as you want - see https://github.com/PoShLog/PoShLog/wiki/Sinks for all available sinks

    Add-SinkConsole |   # Tell logger to write log messages to console

    Add-SinkFile -Path 'C:\Data\my_awesome.log' | # Tell logger to write log messages into file

    Start-Logger

# Test all log levels

Write-VerboseLog 'Test verbose message'

Write-DebugLog 'Test debug message'

Write-InfoLog 'Test info message'

Write-WarningLog 'Test warning message'

Write-ErrorLog 'Test error message'

Write-FatalLog 'Test fatal message'

Close-Logger

```

![poshlog_example_fullversion](images/poshlog_example_fullversion.png)

[*For detailed documentation see wiki*](https://github.com/PoShLog/PoShLog/wiki)

You can(*and you should*) log formatted data:

```ps1

Write-InfoLog 'Current date and time is {DateTime}' -PropertyValues (Get-Date)

# Some example data

$position = @{

    Latitude = 25

    Longitude = 134

}

$elapsedMs = 34

Write-InfoLog 'Processed {@Position} in {Elapsed:000} ms.' -PropertyValues $position, $elapsedMs

```

![poshlog_example_simplest_console](images/poshlog_example_structured_data.png)

Fluent API is too bulky? You don't need extra sinks? Use short setup version(*logs into console and [file](poshlog_example_simplest_file.png)*):

```ps1

# Create and start new logger

Start-Logger -FilePath 'C:\Data\my_awesome.log' -Console

Write-InfoLog 'Hurrray, my first log message!'

# Don't forget to close the logger

Close-Logger

```

![poshlog_example_simplest_console](images/poshlog_example_simplest_console.png)

### Extendability

PoShLog is extensible just like Serilog. All available extensions can be found [here](https://github.com/PoShLog/PoShLog/wiki/Extension-modules).

### Documentation

These examples are just to get you started fast. For more detailed documentation please check [wiki](https://github.com/PoShLog/PoShLog/wiki).

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

### Show your support

* :star: Star the PoShLog repository. This is the least you can do to support this project.

* :thumbsup: Give us some feedback or suggest features using [Discussions](https://github.com/PoShLog/PoShLog/discussions) or [discord](https://discord.gg/FVdVxuw)

* :mag_right: Test PoShLog and raise [issues](https://github.com/PoShLog/PoShLog/issues)

* Contribute :rocket: you can start with [good first issues](https://github.com/PoShLog/PoShLog/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)

### Contributors

* [Michael Zimmerli](https://github.com/gitbute)

* [Martin Dennhardt](https://github.com/mamidenn)

* [Brady Shober](https://github.com/BradyShober)

* [Chris Hunt](https://github.com/cdhunt)

### Building Locally

1. Install PoShLog.Tools

        Install-Module -Name PoShLog.Tools -Force -Verbose -Scope CurrentUser

2. Import PoShLog.Tools

        Import-Module -Name PoShLog.Tools

3. Bootstrap the required modules

        Bootstrap '.\cd\RequiredModules.psd1'

4. Run the build script

        Invoke-Build '.\src\PoShLog.Build.ps1' -Configuration '(Dev/Prod)' -Task Clean, BuildDependencies, CopyModuleFiles -ModuleVersion "$(MajorVersion).$(MinorVersion).$(BugfixVersion)"

        

## Authors

* [**Tomáš Bouda**](http://tomasbouda.cz)

## Release Notes

* [v2.1.1](releaseNotes/v2.1.1.md)

* [v2.1.0](releaseNotes/v2.1.0.md)

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Credits

* Serilog - [serilog.net](https://serilog.net/)

* Icon made by [Smashicons](https://smashicons.com/) from [www.flaticon.com](https://www.flaticon.com/).