PoShLog.Enrichers

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

PoShLog.Enrichers

★ 9 Open GitHub ↗

Extension module for PoShLog logging module. Contains lot of helpful enricher methods, useful when enriching log messages with more properties.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# PoShLog.Enrichers

[![psgallery](https://img.shields.io/powershellgallery/v/PoShLog.Enrichers.svg)](https://www.powershellgallery.com/packages/PoShLog.Enrichers) [![PowerShell Gallery](https://img.shields.io/powershellgallery/p/PoShLog.Enrichers?color=blue)](https://www.powershellgallery.com/packages/PoShLog.Enrichers) [![psgallery](https://img.shields.io/powershellgallery/dt/PoShLog.Enrichers.svg)](https://www.powershellgallery.com/packages/PoShLog.Enrichers) [![Discord](https://img.shields.io/discord/693754316305072199?color=orange&label=discord)](https://discord.gg/6USF98)

PoShLog.Enrichers is extension module for [PoShLog](https://github.com/PoShLog/PoShLog) logging module. Contains lot of helpful enricher methods, useful when enriching log messages with more properties.

## 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.Enrichers, run following snippet from powershell:

```ps1
Install-Module -Name PoShLog.Enrichers
```

## Usage

```ps1
Import-Module PoShLog
Import-Module PoShLog.Enrichers

New-Logger |
    Add-EnrichWithEnvironment |
    Add-EnrichWithExceptionDetails |
    Add-SinkConsole -OutputTemplate "[{MachineName} {Timestamp:HH:mm:ss} {Level:u3}] {Message:lj}{NewLine}{Exception}" |
    Start-Logger

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

# Don't forget to close the logger
Close-Logger
```

Outputs(*Notice the machine name added automatically*):

```
[DESKTOP-PQ6409S 11:16:20 INF] Hurrray, my first log message!
```
### All cmdlets

* [**Add-EnrichWithEnvironment**](https://github.com/PoShLog/PoShLog/wiki/Add-EnrichWithEnvironment) - Adds `MachineName` and `EnvironmentUserName` properties to log events
* [**Add-EnrichWithExceptionDetails**](https://github.com/PoShLog/PoShLog/wiki/Add-EnrichWithExceptionDetails) - Adds additional structured properties from exceptions into log events
* [**Add-EnrichWithProcessId**](https://github.com/PoShLog/PoShLog/wiki/Add-EnrichWithProcessId) - Enriches log events with current `ProcessId` property
* [**Add-EnrichWithProcessName**](https://github.com/PoShLog/PoShLog/wiki/Add-EnrichWithProcessName) - Enriches log events with current `ProcessName` property

### 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.

## Authors

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

## License

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

## Credits

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

PoShLog.Enrichers

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README