# CanaryOptions

> Tracon documentation. Tracon is a .NET package family that adds a control
> plane on Microsoft Agent Framework, published as NuGet packages that run
> inside your own ASP.NET Core application.
>
> Page: https://tracon.dev/api/tracon.canaryoptions/
> Summary: CanaryOptions: Options for the canary evaluation background service.

<div class="api-provenance">Namespace Tracon · Assembly <code>Tracon.Core.dll</code></div>

Options for the canary evaluation background service.

```csharp
public sealed class CanaryOptions
```

<dl class="api-relations"><dt>Inheritance</dt><dd><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ← <a href="/api/tracon.canaryoptions/">CanaryOptions</a></dd><dt>Inherited Members</dt><dd><a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>, <a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>, <a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>, <a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>, <a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>, <a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a></dd></dl>

## Remarks

Reads values from the `Tracon:Canary` configuration section.

## Constructors

### <a id="Tracon_CanaryOptions__ctor"></a> CanaryOptions\(\)

```csharp
public CanaryOptions()
```

## Fields

### <a id="Tracon_CanaryOptions_SectionName"></a> SectionName

The configuration section name.

```csharp
public const string SectionName = "Tracon:Canary"
```

#### Field Value

 [string](https://learn.microsoft.com/dotnet/api/system.string)

## Properties

### <a id="Tracon_CanaryOptions_AutoRollbackEnabled"></a> AutoRollbackEnabled

Gets or sets a value that enables automatic rollback. The default is
[false](https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool). No experiment stops itself or changes weight
until this is enabled, even when a [CanaryPolicy](/api/tracon.canarypolicy/) exists.

```csharp
public bool AutoRollbackEnabled { get; set; }
```

#### Property Value

 [bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="Tracon_CanaryOptions_ScanInterval"></a> ScanInterval

The evaluation interval for running experiments that define a canary policy.

```csharp
public TimeSpan ScanInterval { get; set; }
```

#### Property Value

 [TimeSpan](https://learn.microsoft.com/dotnet/api/system.timespan)