Serilog.Sinks.Unity3D

KO | EN

gitlite — search

#python #react #ai #typescript #llm #machine-learning #rust #linux #docker #windows #cli #awesome-list #vue #open-source

Serilog.Sinks.Unity3D

(★ 52)

Serilog Sink for Unity 3D Debug log

Serilog.Sinks.Unity3D 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Serilog.Sinks.Unity3D

[![openUPM](https://img.shields.io/npm/v/com.serilog.sinks.unity3d?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.serilog.sinks.unity3d/)

Serilog sink for Unity3D, logs to Unity Debugger

## Usage

### Installation
Install it through OpenUPM or use the UnityPackage from the [Releases](https://github.com/KuraiAndras/Serilog.Sinks.Unity3D/releases) page.

```bash
openupm add com.serilog.sinks.unity3d
```

### Dependencies

You need add Serilog[^SerilogVersion] to your project. Your usual options:
- [Xoofx's UnityNuGet server](https://github.com/xoofx/UnityNuGet) (preferred)
- Manual add the Serilog DLL to your assets folder
- [NuGetForUnity](https://github.com/GlitchEnzo/NuGetForUnity)

### Creating the logger

```csharp
var logger = new LoggerConfiguration()
    .MinimumLevel.Information()
    .WriteTo.Unity3D()
    .CreateLogger();
```

If you have a custom implementation of Unity's `ILogger` interface, then you can log to that:

```csharp
ILogger myCustomLogger = new MyCustomLogger();

var logger = new LoggerConfiguration()
    .MinimumLevel.Information()
    .WriteTo.Unity3D(unityLogger: myCustomLogger)
    .CreateLogger();
```

If no logger is provided the library will use `UnityEngine.Debug.unityLogger` (which is equivalent of using `UnityEngine.Debug.Log()` methods)

### Unity log extras

You can provide the `UnityEngine.Object` context[^EnrichUnityContext] and tag parameters for the logger:

```csharp
public class MyObject : MonoBehaviour
{
    // ...
    private ILogger _logger = new();

public void DoLog()
    {
        _logger
            .ForContext(this)
            .WithUnityTag("My custom tag")
            .Information("This is an info log");
    }
}
```

## Migration guide

### For versions before 2.0.0

Set up [MainThreadDispatcher.Unity](https://github.com/KuraiAndras/MainThreadDispatcher.Unity)

### Upgrade from 1.0.0 to 1.0.1

You need to provide the following DLLs:

- Serilog
- MainThreadDispatcher

[^EnrichUnityContext]: This is done with a new extension method override which explicitly accepts `UnityEngine.Object`.
[^SerilogVersion]: Version 2.12.0 or later

Serilog.Sinks.Unity3D

Serilog.Sinks.Unity3D 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Serilog.Sinks.Unity3D

Serilog.Sinks.Unity3D 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README