File: SeqSettings.cs
Web Access
Project: src\src\Components\Aspire.Seq\Aspire.Seq.csproj (Aspire.Seq)
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
 
using OpenTelemetry.Exporter;
 
namespace Aspire.Seq;
 
/// <summary>
/// Provides the client configuration settings for connecting telemetry to a Seq server.
/// </summary>
public sealed class SeqSettings
{
    /// <summary>
    /// Gets or sets a boolean value that indicates whether the Seq server health check is disabled or not.
    /// </summary>
    /// <value>
    /// The default value is <see langword="false"/>.
    /// </value>
    public bool DisableHealthChecks { get; set; }
 
    /// <summary>
    /// Gets or sets a Seq <i>API key</i> that authenticates the client to the Seq server.
    /// </summary>
    public string? ApiKey { get; set; }
 
    /// <summary>
    /// Gets or sets the base URL of the Seq server (including protocol and port). E.g. "https://example.seq.com:6789. Overrides endpoints set on <c>Logs</c> and <c>Traces</c>."
    /// </summary>
    public string? ServerUrl { get; set; }
 
    /// <summary>
    /// Gets OTLP exporter options for logs.
    /// </summary>
    public OtlpExporterOptions Logs { get; } = new ();
 
    /// <summary>
    /// Gets OTLP exporter options for traces.
    /// </summary>
    public OtlpExporterOptions Traces { get; } = new ();
}