Class LuceneIndexDiagnostics

Inheritance

object

Namespace: Umbraco.Cms.Infrastructure.Examine

Assembly: Umbraco.Examine.Lucene.dll

Syntax

public class LuceneIndexDiagnostics : IIndexDiagnostics

Constructors

View Source

LuceneIndexDiagnostics(LuceneIndex, ILogger<LuceneIndexDiagnostics>, IHostingEnvironment, IOptionsMonitor<LuceneDirectoryIndexOptions>?)

Declaration

public LuceneIndexDiagnostics(LuceneIndex index, ILogger<LuceneIndexDiagnostics> logger, IHostingEnvironment hostingEnvironment, IOptionsMonitor<LuceneDirectoryIndexOptions>? indexOptions)

Parameters

Type	Name	Description
LuceneIndex	index
ILogger<LuceneIndexDiagnostics>	logger
IHostingEnvironment	hostingEnvironment
IOptionsMonitor<LuceneDirectoryIndexOptions>	indexOptions

Properties

View Source

Index

Declaration

public LuceneIndex Index { get; }

Property Value

Type	Description
LuceneIndex

View Source

Logger

Declaration

public ILogger<LuceneIndexDiagnostics> Logger { get; }

Property Value

Type	Description
ILogger<LuceneIndexDiagnostics>

View Source

Metadata

A key/value collection of diagnostic properties for the index

Declaration

public virtual IReadOnlyDictionary<string, object?> Metadata { get; }

Property Value

Type	Description
IReadOnlyDictionary<string, object>

Remarks

Used to display in the UI

Methods

View Source

GetDocumentCount()

Declaration

public long GetDocumentCount()

Returns

Type	Description
long

View Source

GetFieldNames()

Declaration

public IEnumerable<string> GetFieldNames()

Returns

Type	Description
IEnumerable<string>

View Source

IsHealthy()

If the index can be open/read

Declaration

public Attempt<string?> IsHealthy()

Returns

Type	Description
Attempt<string>	A successful attempt if it is healthy, else a failed attempt with a message if unhealthy