🥣

ASP.NET CoreにSerilogを導入する - 初心者向けガイド

gushwell

2025/08/06に公開

 はじめにSerilogは、構造化されたログを簡単に記録できる強力なロギングライブラリです。これを使うことで、アプリケーションの動作を監視したり、問題をデバッグしたりする際に役立つ詳細なログを残せます。
この記事では、ASP.NET CoreアプリケーションにSerilogを導入する方法を、わかりやすく解説します。

Serilog公式サイトやSerilogのGitHubリポジトリのドキュメントを参考にしています。
https://serilog.net/
https://github.com/serilog/serilog-aspnetcore

 なぜSerilogを使うのか？ASP.NET Coreには標準のロギング機能がありますが、Serilogは以下のような利点があります。

構造化ログ: ログを単なるテキストではなく、JSON形式などの構造化データとして保存可能。これにより、ログの検索や分析が容易に。

豊富な出力先: コンソール、ファイル、データベース、クラウドサービスなど、さまざまな出力先（シンク）にログを送信可能。

カスタマイズ性: ログに追加情報（例: マシン名やリクエスト情報）を簡単に付加できる。

ASP.NET Coreとの統合: ASP.NET CoreのロギングAPIとシームレスに連携。
初心者でも簡単に利用開始できるので、早速始めてみましょう！

 ステップ1: プロジェクトの準備まず、ASP.NET Coreプロジェクトが必要です。以下の手順で新しいプロジェクトを作成します（すでにプロジェクトがある場合はスキップ可能）。
Visual Studioまたはターミナルでプロジェクトを作成:
dotnet new webapi -n SerilogSample
cd SerilogSample
この記事では、WebAPIプロジェクトで説明しますが、Razor Pages、MVCでも手順は同じです。
プロジェクトをVisual Studio or VS Codeで開く:
code .
これで、基本的なASP.NET Core Web APIプロジェクトが準備できました。

 ステップ2: SerilogのNuGetパッケージをインストールSerilogをプロジェクトに追加するには、必要なNuGetパッケージをインストールします。以下のコマンドをターミナルで実行します。あるいはVisual StudioのNuGetパッケージマネージャーでインストールします。
dotnet add package Serilog.AspNetCore
dotnet add package Serilog.Sinks.Console
dotnet add package Serilog.Sinks.File

Serilog.AspNetCore: ASP.NET CoreとSerilogを統合するためのパッケージ。

Serilog.Sinks.Console: ログをコンソールに出力するためのシンク。

Serilog.Sinks.File: ログをファイルに出力するためのシンク。

 ステップ3: Serilogの設定Program.csを編集し、Serilogの設定をします。以下は、基本的な設定例です。
program.cs
using Microsoft.AspNetCore.Builder;
using Microsoft.Extensions.Hosting;
using Serilog;

var builder = WebApplication.CreateBuilder(args);

// Serilogの設定
builder.Host.UseSerilog((context, configuration) =>
{
    configuration
        .WriteTo.Console() // コンソールにログを出力
        .WriteTo.File("Logs/log-.txt", rollingInterval: RollingInterval.Day) // ファイルにログを出力（日次ローテーション）
        .Enrich.FromLogContext() // コンテキスト情報を追加
        .MinimumLevel.Information(); // ログの最低レベルをInformationに設定
});

// サービスを追加
builder.Services.AddControllers();

var app = builder.Build();

// Serilogのリクエストロギングミドルウェアを追加
app.UseSerilogRequestLogging();

app.UseHttpsRedirection();
app.UseAuthorization();
app.MapControllers();

app.Run();

 コードの要点
UseSerilog: Serilogをホストに統合します。

WriteTo.Console(): ログをコンソールに出力。

WriteTo.File(): ログをLogs/log-.txtに日次で保存（例: log-20250718.txt）。

Enrich.FromLogContext(): ログにコンテキスト情報（例: リクエストID）を追加。

UseSerilogRequestLogging(): HTTPリクエストのログを簡潔に記録するミドルウェア。

 ステップ4: ログを記録するログを記録するには、ILogger<T>をコントローラーやサービスに注入して使用します。以下は、簡単なコントローラーの例です。
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Logging;

namespace SerilogSample.Controllers
{
    [ApiController]
    [Route("[controller]")]
    public class WeatherForecastController : ControllerBase
    {
        private readonly ILogger<WeatherForecastController> _logger;

        public WeatherForecastController(ILogger<WeatherForecastController> logger)
        {
            _logger = logger;
        }

        [HttpGet]
        public IActionResult Get()
        {
            _logger.LogInformation("天気予報APIが呼び出されました");
            _logger.LogWarning("これは警告ログの例です");
            
            var forecast = $"天気予報データ: Date = {DateTime.Now}, TemperatureC = 25, Summary = \"Sunny\"";
            _logger.LogInformation(forecast);

            return Ok(forecast);
        }
    }
}

 コードの要点
ILogger<T>: ASP.NET Coreの標準ロギングインターフェースを使用。Serilogが裏で処理。

LogInformation: 通常の情報ログを記録。

LogWarning: 警告ログを記録。

 ステップ5: アプリケーションを実行してログを確認プロジェクトを実行します：
dotnet run
APIテスト:

ブラウザやPostmanでhttps://localhost:5001/WeatherForecastにアクセスし、ログを確認。
コンソールログ:

ターミナルにログが出力されます。例：
[2025-07-27 16:38:12 INF] 天気予報APIが呼び出されました
[2025-07-27 16:38:12 WRN] これは警告ログの例です
[2025-07-27 16:38:12 INF] 天気予報データ: Date = 2025/07/27 14:14:22, TemperatureC = 25, Summary = "Sunny"
ファイルログ:

Logsフォルダにlog-YYYYMMDD.txtが作成され、同じログが記録されます。

 ステップ6: appsettings.jsonで設定を管理ログ設定をコードではなくappsettings.jsonで管理することもできます。以下はその例です。
{
  "Serilog": {
    "Using": [ "Serilog.Sinks.Console", "Serilog.Sinks.File" ],
    "MinimumLevel": {
      "Default": "Information",
      "Override": {
        "Microsoft": "Warning",
        "System": "Warning"
      }
    },
    "WriteTo": [
      { "Name": "Console" },
      {
        "Name": "File",
        "Args": {
          "path": "Logs/log-.txt",
          "rollingInterval": "Day"
        }
      }
    ],
    "Enrich": [ "FromLogContext", "WithMachineName", "WithThreadId" ],
    "Properties": {
      "Application": "SerilogSample"
    }
  }
}

上記設定では、Microsoft, System名前空間のログは、Warning以上だけが出力されるようにフィルタリングしています。
上記設定を読み込むようにProgram.csを変更します。
program.cs
using Microsoft.AspNetCore.Builder;
using Microsoft.Extensions.Hosting;
using Serilog;

var builder = WebApplication.CreateBuilder(args);

// Serilogの設定をappsettings.jsonから読み込む
builder.Host.UseSerilog((context, configuration) =>
{
    configuration.ReadFrom.Configuration(context.Configuration);
});

// サービスを追加
builder.Services.AddControllers();

var app = builder.Build();

// Serilogのリクエストロギングミドルウェアを追加
app.UseSerilogRequestLogging();

app.UseHttpsRedirection();
app.UseAuthorization();
app.MapControllers();

app.Run();

 コードの要点
ReadFrom.Configuration: appsettings.jsonのSerilogセクションを読み込み。

 ステップ7: 構造化ログをファイルに出力するこれで基本的なログ出力ができるようになりました。次に、ログをJSON形式（構造化フォーマット）で保存する設定を追加します。

 1. 必要なNuGetパッケージのインストールSerilog にはいくつかのJSON フォーマッタが提供されていますが、この記事では、Serilog.Formatting.Compactパッケージを利用します。
以下のコマンドでインストールします：
dotnet add package Serilog.Formatting.Compact
ただし、すでにインストールしている Serilog.AspNetCore パッケージには、Serilog.Formatting.Compactパッケージが含まれていますので、上記コマンドは実行しなくても問題ありません。
Serilog.Formatting.Compact : ログをコンパクトなJSON形式（CLEF: Compact Log Event Format）で出力。

 2. 構成ファイルの設定appsettings.jsonの"WriteTo"を以下のように書き換えます。
appsettings.json
    "WriteTo": [
      { "Name": "Console" },
      {
        "Name": "File",
        "Args": {
          "path": "Logs/log-.txt",
          "rollingInterval": "Day",
+         "formatter": "Serilog.Formatting.Compact.CompactJsonFormatter, Serilog.Formatting.Compact" // この行を追加
        }
      }
    ],

 3. 構造化ログの記録コントローラーで構造化ログを記録するには、ILogger<T>を使用して@付きプレースホルダーでオブジェクトをログに含めます。以下は例です：
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Logging;

namespace SerilogSample.Controllers
{
    [ApiController]
    [Route("[controller]")]
    public class WeatherForecastController : ControllerBase
    {
        private readonly ILogger<WeatherForecastController> _logger;

        public WeatherForecastController(ILogger<WeatherForecastController> logger)
        {
            _logger = logger;
        }

        [HttpGet]
        public IActionResult Get()
        {
            var forecast = new { Date = DateTime.Now, TemperatureC = 25, Summary = "Sunny" };
            _logger.LogInformation("天気予報データ: {@Forecast}", forecast);
            return Ok(forecast);
        }
    }
}

 ポイント{@Forecast}: プレースホルダーに{@}を付けてオブジェクトをログに埋め込むと、そのオブジェクトのプロパティが型情報付きで保存されます。示した例では、forecastオブジェクトのプロパティ（Date, TemperatureC, Summary）がJSON形式で保持されます。

これにより、単なる文字列のログメッセージでは失われがちなデータの型や構造がそのまま保持され、後で詳細な解析や加工をしやすくなります。

 4. ログファイルの確認アプリケーションを実行（dotnet run）し、APIを呼び出すと、Logsフォルダにlog-YYYYMMDD.txtが作成されます。ログファイルの内容は以下のようなJSON形式になります：
{"@t":"2025-07-22T05:16:55.4884051Z","@mt":"天気予報データ: {@Forecast}","@tr":"7961cb5b8e70a7475d1ecd4ecf0145ba","@sp":"eb124c7f42ecffb2","Forecast":{"Date":"2025-07-22T14:16:55.4883004+09:00","TemperatureC":25,"Summary":"Sunny"},"SourceContext":"SerilogTest.Pages.PrivacyModel","ActionId":"06f92c9e-ae65-43c0-b324-ec658cf8ccd5","ActionName":"/Privacy","RequestId":"0HNE8RROBGB7K:00000015","RequestPath":"/Privacy","ConnectionId":"0HNE8RROBGB7K","Application":"SerilogSample"}
整形したものを以下に示します。
{
  "@t": "2025-07-27T05:16:55.4884051Z",
  "@mt": "天気予報データ: {@Forecast}",
  "@tr": "7961cb5b8e70a7475d1ecd4ecf0145ba",
  "@sp": "eb124c7f42ecffb2",
  "Forecast": {
    "Date": "2025-07-27T14:16:55.4883004+09:00",
    "TemperatureC": 25,
    "Summary": "Sunny"
  },
  "SourceContext": "SerilogTest.Pages.PrivacyModel",
  "ActionId": "06f92c9e-ae65-43c0-b324-ec658cf8ccd5",
  "ActionName": "/Privacy",
  "RequestId": "0HNE8RROBGB7K:00000015",
  "RequestPath": "/Privacy",
  "ConnectionId": "0HNE8RROBGB7K",
  "Application": "SerilogSample"
}
@t: タイムスタンプ
@mt: メッセージテンプレート
Forecast: 構造化データとして保存されたオブジェクト

このJSON形式は、Seqのようなログ解析ツールで分析できます。
https://datalust.co/

 5. コードでSerilogの設定をする（オプション）appsettings.jsonの代わりにProgram.csで構造化ログの設定をすることも可能です。
program.cs
using Microsoft.AspNetCore.Builder;
using Microsoft.Extensions.Hosting;
using Serilog;
using Serilog.Formatting.Compact;

var builder = WebApplication.CreateBuilder(args);

// Serilogの設定
builder.Host.UseSerilog((context, configuration) =>
{
    configuration
        .WriteTo.Console() // コンソールにも出力（オプション）
        .WriteTo.File(
            new CompactJsonFormatter(), // JSON形式でログをフォーマット
            "Logs/log-.txt", // ログファイルのパス（日次ローテーション）
            rollingInterval: RollingInterval.Day
        )
        .Enrich.FromLogContext() // コンテキスト情報を追加
        .MinimumLevel.Information(); // ログの最低レベル
});

// サービスを追加
builder.Services.AddControllers();

var app = builder.Build();

// Serilogのリクエストロギングミドルウェアを追加
app.UseSerilogRequestLogging();

app.UseHttpsRedirection();
app.UseAuthorization();
app.MapControllers();

app.Run();

 コードの要点
CompactJsonFormatter: ログをコンパクトなJSON形式で出力。これにより、ログが構造化データとして解析しやすくなります。

WriteTo.File: Logs/log-.txtに日次でログファイルを作成（例: log-20250718.txt）。

Enrich.FromLogContext: リクエストIDやカスタムプロパティをログに追加。

 補足情報: File シンクのオプション

オプション名
説明


path
出力ファイルのパス。log-.txt のように - を含めるとロールオーバー対応になります。

rollingInterval
ログファイルをローテーションする周期（Day, Hour, Minute, Infinite など）

outputTemplate
出力形式のテンプレート（ログの書式）

retainedFileCountLimit
保持するファイルの最大数。デフォルト：最新の31ファイルを保持。

fileSizeLimitBytes
1ファイルあたりの最大サイズ（バイト単位）。超えるとローテーションされます。

rollOnFileSizeLimit

trueにすると、fileSizeLimitBytesを超えたときにロールオーバーします。

shared
複数プロセスでログファイルを共有する場合はtrueに。単一プロセスならfalseでパフォーマンス向上。

buffered
'true'にすると、書き込みがバッファリングされる


 構成ファイルのサンプル    "WriteTo": [
      {
        "Name": "File",
        "Args": {
          "path": "Logs/log-.txt",
          "rollingInterval": "Day",
          "outputTemplate": "[{Timestamp:yyyy-MM-dd HH:mm:ss} {Level:u3}] {Message:lj}{NewLine}{Exception}",
          "retainedFileCountLimit": 7,
          "fileSizeLimitBytes": 10485760,
          "rollOnFileSizeLimit": true,
          "shared": false,
          "buffered": true
        }
      }
outputTemplateについて
{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz}

→ 例: 2024-06-01 14:30:15.123 +09:00

→ 日付と時刻（ミリ秒付き）、タイムゾーンオフセットを表示
[{Level:u3}]

→ 例: [INF], [WRN], [ERR]

→ ログレベルを3文字で短縮表示（Information, Warning, Error）
{Message:lj}

→ ログメッセージ部分をプレーンテキストで表示

→ :l フォーマット指定子は文字列の引用符を無効、

→ :j 埋め込まれた構造化データにはJSON形式でレンダリング。
{NewLine}{Exception}

→ ログメッセージ改行の後に例外情報を出力（例外がある場合のみ）

 まとめ本記事では、ASP.NET CoreにSerilogを導入する手順を初心者向けに丁寧に解説しました。Serilogを使うことで、構造化されたログを簡単に記録・管理でき、ログの分析やトラブルシューティングが格段に効率化します。構造化ログはログ解析ツールと連携しやすく、開発・運用双方で大きなメリットがあると言えます。
まずは基本の導入から始めて、徐々に設定を拡張しながら、自分のプロジェクトに最適なロギング環境を構築してみてはどうでしょう。

オプション名	説明
`path`	出力ファイルのパス。`log-.txt` のように `-` を含めるとロールオーバー対応になります。
`rollingInterval`	ログファイルをローテーションする周期（`Day`, `Hour`, `Minute`, `Infinite` など）
`outputTemplate`	出力形式のテンプレート（ログの書式）
`retainedFileCountLimit`	保持するファイルの最大数。デフォルト：最新の31ファイルを保持。
`fileSizeLimitBytes`	1ファイルあたりの最大サイズ（バイト単位）。超えるとローテーションされます。
`rollOnFileSizeLimit`	`true`にすると、`fileSizeLimitBytes`を超えたときにロールオーバーします。
`shared`	複数プロセスでログファイルを共有する場合は`true`に。単一プロセスなら`false`でパフォーマンス向上。
`buffered`	'true'にすると、書き込みがバッファリングされる

GitHubで編集を提案

株式会社ジードテックブログPublication

株式会社ジードはクラウド上で動作するWebアプリケーションの開発、Webサイトの制作およびクラウドの運用代行・監視を行う企業です。受託開発を行っています。幅広いニーズに対応可能です。利用技術は、Azure, .NET,C#,Vue,Svelte,JavaScript,Python,Flutterなど。

はじめに

なぜSerilogを使うのか？

ステップ1: プロジェクトの準備

ステップ2: SerilogのNuGetパッケージをインストール

ステップ3: Serilogの設定

コードの要点

ステップ4: ログを記録する

コードの要点

ステップ5: アプリケーションを実行してログを確認

ステップ6: appsettings.jsonで設定を管理

コードの要点

ステップ7: 構造化ログをファイルに出力する

1. 必要なNuGetパッケージのインストール

2. 構成ファイルの設定

3. 構造化ログの記録

ポイント

4. ログファイルの確認

5. コードでSerilogの設定をする（オプション）

コードの要点

補足情報: File シンクのオプション

構成ファイルのサンプル

まとめ

Discussion