Seq integration

Seq is the intelligent search, analysis, and alerting server built for structured log data. The Aspire Seq integration enables you to connect to existing Seq instances or create new instances from Aspire with the datalust/seq container image.

Hosting integration

The Seq hosting integration models a Seq resource as the SeqResource type. To access this type and APIs, add the 📦 Aspire.Hosting.Seq NuGet package in your AppHost project:

Aspire CLI

Aspire CLI — Aspire.Hosting.Seq パッケージを追加

aspire add seq

Aspire CLI は対話的です。求められたら適切な結果を選択してください:

Aspire CLI — 出力例

Select an integration to add:

> seq (Aspire.Hosting.Seq)
> Other results listed as selectable options...

ノート

結果が 1 つだけなら自動的に選択されます。バージョンは確認が必要です。

apphost.cs (C# file-based app)

C# — AppHost.cs

#:package Aspire.Hosting.Seq@*

PackageReference (*.csproj)

XML — Aspire.Hosting.Seq パッケージ参照を追加

<PackageReference Include="Aspire.Hosting.Seq" Version="*" />

Add a Seq resource

In your AppHost project, call AddSeq to add and return a Seq resource builder:

C# — AppHost.cs

var builder = DistributedApplication.CreateBuilder(args);

var seq = builder.AddSeq("seq")
                 .ExcludeFromManifest()
                 .WithLifetime(ContainerLifetime.Persistent)
                 .WithEnvironment("ACCEPT_EULA", "Y");

var myService = builder.AddProject<Projects.ExampleProject>()
                       .WithReference(seq)
                       .WaitFor(seq);

ノート

The Seq container may be slow to start, so it’s best to use a persistent lifetime to avoid unnecessary restarts. For more information, see Container resource lifetime.

Accept the Seq End User License Agreement (EULA)

You must accept the Seq EULA for Seq to start. To accept the agreement in code, pass the environment variable ACCEPT_EULA to the Seq container, and set its value to Y.

Seq in the Aspire manifest

Seq shouldn’t be part of the Aspire deployment manifest, hence the chained call to ExcludeFromManifest. It’s recommended you set up a secure production Seq server outside of Aspire for your production environment.

Persistent logs and traces

Register Seq with a data directory in your AppHost project to retain Seq’s data and configuration across application restarts:

var seq = builder.AddSeq("seq", seqDataDirectory: "./seqdata")
                 .ExcludeFromManifest()
                 .WithLifetime(ContainerLifetime.Persistent);

The directory specified must already exist.

Add a Seq resource with a data volume

To add a data volume to the Seq resource, call the WithDataVolume method:

C# — AppHost.cs

var builder = DistributedApplication.CreateBuilder(args);

var seq = builder.AddSeq("seq")
                 .WithDataVolume()
                 .ExcludeFromManifest()
                 .WithLifetime(ContainerLifetime.Persistent);

var myService = builder.AddProject<Projects.ExampleProject>()
                       .WithReference(seq)
                       .WaitFor(seq);

The data volume is used to persist the Seq data outside the lifecycle of its container.

Connection properties

When you reference a Seq resource using WithReference, the following connection properties are made available to the consuming project:

Seq

The Seq resource exposes the following connection properties:

Property Name	Description
Host	The hostname or IP address of the Seq server
Port	The port number the Seq server is listening on
Uri	The connection URI, with the format http://{Host}:{Port}

Example connection string:

Uri: http://localhost:5341

ノート

Aspire exposes each property as an environment variable named [RESOURCE]_[PROPERTY]. For instance, the Uri property of a resource called seq becomes SEQ_URI.

Client integration

To get started with the Seq client integration, install the 📦 Aspire.Seq NuGet package in the client-consuming project:

.NET CLI

.NET CLI — Add Aspire.Seq package

dotnet add package Aspire.Seq

Program.cs (C# file-based app)

Program.cs

#:package Aspire.Seq@*

PackageReference (*.csproj)

XML — Add Aspire.Seq package reference

<PackageReference Include="Aspire.Seq" Version="*" />

Add a Seq client

In the Program.cs file of your client-consuming project, call the AddSeqEndpoint extension method to register OpenTelemetry Protocol exporters to send logs and traces to Seq:

builder.AddSeqEndpoint(connectionName: "seq");

ヒント

The connectionName parameter must match the name used when adding the Seq resource in the AppHost project.

Configuration

The Seq integration provides multiple options to configure the connection to Seq.

Use configuration providers

The Seq integration supports Microsoft.Extensions.Configuration. It loads the SeqSettings from configuration using the Aspire:Seq key. Example appsettings.json:

{
  "Aspire": {
    "Seq": {
      "DisableHealthChecks": true,
      "ServerUrl": "http://localhost:5341"
    }
  }
}

Use named configuration

The Seq integration supports named configuration for multiple instances:

{
  "Aspire": {
    "Seq": {
      "seq1": {
        "ServerUrl": "http://seq1:5341",
        "DisableHealthChecks": true
      },
      "seq2": {
        "ServerUrl": "http://seq2:5341",
        "DisableHealthChecks": false
      }
    }
  }
}

Use the connection names when calling AddSeqEndpoint:

builder.AddSeqEndpoint("seq1");
builder.AddSeqEndpoint("seq2");

Use inline delegates

You can pass the Action<SeqSettings> delegate to set up options inline:

builder.AddSeqEndpoint("seq", static settings =>
{
    settings.DisableHealthChecks  = true;
    settings.ServerUrl = "http://localhost:5341";
});

Client integration health checks

By default, Aspire integrations enable health checks for all services. The Seq integration:

• Adds the health check when DisableHealthChecks is false, which attempts to connect to the Seq server’s /health endpoint.
• Integrates with the /health HTTP endpoint.

Observability and telemetry

Logging

The Seq integration uses the following log categories:

• Seq

Tracing and Metrics

The Seq integration doesn’t emit tracing activities or metrics because it’s a telemetry sink, not a telemetry source.