ResourceLoggerService Methods

ClassMethods11 members

A service that provides loggers for resources to write to.

ClearBacklog(string)

Clears the log stream's backlog for the resource.

public class ResourceLoggerService
{
    public void ClearBacklog(
        string resourceName)
    {
        // ...
    }
}

ResourceLoggerService.cs#L304-L310

Parameters

resourceNamestring

Complete(IResource)

Completes the log stream for the resource.

public class ResourceLoggerService
{
    public void Complete(
        IResource resource)
    {
        // ...
    }
}

ResourceLoggerService.cs#L273-L283

Parameters

resourceIResourceThe IResource.

Complete(string)

Completes the log stream for the resource.

public class ResourceLoggerService
{
    public void Complete(
        string name)
    {
        // ...
    }
}

ResourceLoggerService.cs#L291-L297

Parameters

namestringThe name of the resource.

Dispose

Disposes the service and completes all log streams.

public class ResourceLoggerService
{
    public void Dispose()
    {
        // ...
    }
}

ResourceLoggerService.cs#L639-L653

GetAllAsync(IResource)IAsyncEnumerable<IReadOnlyList<LogLine>>

Get all logs for a resource. This will return all logs that have been written to the log stream for the resource and then complete.

public class ResourceLoggerService
{
    public IAsyncEnumerable<IReadOnlyList<LogLine>> GetAllAsync(
        IResource resource)
    {
        // ...
    }
}

ResourceLoggerService.cs#L159-L168

Parameters

resourceIResourceThe resource to get all logs for.

Returns

IAsyncEnumerable<IReadOnlyList<LogLine>>An async enumerable that returns all logs that have been written to the log stream and then completes.

GetAllAsync(string)IAsyncEnumerable<IReadOnlyList<LogLine>>

Get all logs for a resource. This will return all logs that have been written to the log stream for the resource and then complete.

public class ResourceLoggerService
{
    public IAsyncEnumerable<IReadOnlyList<LogLine>> GetAllAsync(
        string resourceName)
    {
        // ...
    }
}

ResourceLoggerService.cs#L199-L201

Parameters

resourceNamestringThe resource name

Returns

IAsyncEnumerable<IReadOnlyList<LogLine>>An async enumerable that returns all logs that have been written to the log stream and then completes.

GetLogger(IResource)ILogger

Gets the logger for the resource to write to.

public class ResourceLoggerService
{
    public ILogger GetLogger(
        IResource resource)
    {
        // ...
    }
}

ResourceLoggerService.cs#L51-L67

Parameters

resourceIResourceThe resource name

Returns

ILoggerAn Logging.ILogger which represents the resource.

GetLogger(string)ILogger

Gets the logger for the resource to write to.

public class ResourceLoggerService
{
    public ILogger GetLogger(
        string resourceName)
    {
        // ...
    }
}

ResourceLoggerService.cs#L135-L137

Parameters

resourceNamestringThe name of the resource from the Aspire application model.

Returns

ILoggerAn Logging.ILogger which represents the named resource.

WatchAnySubscribersAsync(CancellationToken)IAsyncEnumerable<LogSubscriber>

Watch for subscribers to the log stream for a resource.

public class ResourceLoggerService
{
    public IAsyncEnumerable<LogSubscriber> WatchAnySubscribersAsync(
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

ResourceLoggerService.cs#L225-L265

Parameters

cancellationTokenCancellationTokenoptional

Returns

IAsyncEnumerable<LogSubscriber> An async enumerable that returns when the first subscriber is added to a log, or when the last subscriber is removed.

WatchAsync(IResource)IAsyncEnumerable<IReadOnlyList<LogLine>>

Watch for changes to the log stream for a resource.

public class ResourceLoggerService
{
    public IAsyncEnumerable<IReadOnlyList<LogLine>> WatchAsync(
        IResource resource)
    {
        // ...
    }
}

ResourceLoggerService.cs#L179-L188

Parameters

resourceIResourceThe resource to watch for logs.

Returns

IAsyncEnumerable<IReadOnlyList<LogLine>>An async enumerable that returns the logs as they are written.

WatchAsync(string)IAsyncEnumerable<IReadOnlyList<LogLine>>

Watch for changes to the log stream for a resource.

public class ResourceLoggerService
{
    public IAsyncEnumerable<IReadOnlyList<LogLine>> WatchAsync(
        string resourceName)
    {
        // ...
    }
}

ResourceLoggerService.cs#L211-L213

Parameters

resourceNamestringThe resource name

Returns

IAsyncEnumerable<IReadOnlyList<LogLine>>An async enumerable that returns the logs as they are written.