View Source

Interface ILogViewer

Namespace: Umbraco.Cms.Core.Logging.Viewer
Assembly: Umbraco.Infrastructure.dll
Syntax
[Obsolete("Use ILogViewerService instead. Scheduled removal in Umbraco 18.")]
public interface ILogViewer

Properties

View Source

CanHandleLargeLogs

Declaration
bool CanHandleLargeLogs { get; }
Property Value
Type Description
bool

Methods

View Source

AddSavedSearch(string, string)

Adds a new saved search to chosen data source and returns the updated searches

Declaration
[Obsolete("Use ILogViewerService.AddSavedLogQueryAsync instead. Scheduled for removal in Umbraco 15.")]
IReadOnlyList<SavedLogSearch> AddSavedSearch(string name, string query)
Parameters
Type Name Description
string name
string query
Returns
Type Description
IReadOnlyList<SavedLogSearch>
View Source

CheckCanOpenLogs(LogTimePeriod)

Declaration
[Obsolete("Use ILogViewerService.CanViewLogsAsync instead. Scheduled for removal in Umbraco 15.")]
bool CheckCanOpenLogs(LogTimePeriod logTimePeriod)
Parameters
Type Name Description
LogTimePeriod logTimePeriod
Returns
Type Description
bool
View Source

DeleteSavedSearch(string)

Deletes a saved search to chosen data source and returns the remaining searches

Declaration
[Obsolete("Use ILogViewerService.DeleteSavedLogQueryAsync instead. Scheduled for removal in Umbraco 15.")]
IReadOnlyList<SavedLogSearch> DeleteSavedSearch(string name)
Parameters
Type Name Description
string name
Returns
Type Description
IReadOnlyList<SavedLogSearch>
View Source

GetLogLevelCounts(LogTimePeriod)

Returns a number of the different log level entries

Declaration
[Obsolete("Use ILogViewerService.GetLogLevelCounts instead. Scheduled for removal in Umbraco 15.")]
LogLevelCounts GetLogLevelCounts(LogTimePeriod logTimePeriod)
Parameters
Type Name Description
LogTimePeriod logTimePeriod
Returns
Type Description
LogLevelCounts
View Source

GetLogs(LogTimePeriod, int, int, Direction, string?, string[]?)

Returns the collection of logs

Declaration
[Obsolete("Use ILogViewerService.GetPagedLogs instead. Scheduled for removal in Umbraco 15.")]
PagedResult<LogMessage> GetLogs(LogTimePeriod logTimePeriod, int pageNumber = 1, int pageSize = 100, Direction orderDirection = Direction.Descending, string? filterExpression = null, string[]? logLevels = null)
Parameters
Type Name Description
LogTimePeriod logTimePeriod
int pageNumber
int pageSize
Direction orderDirection
string filterExpression
string[] logLevels
Returns
Type Description
PagedResult<LogMessage>
View Source

GetLogsAsPagedModel(LogTimePeriod, int, int, Direction, string?, string[]?)

Declaration
[Obsolete("Use ILogViewerService.GetPagedLogs instead. Scheduled for removal in Umbraco 15.")]
PagedModel<LogMessage> GetLogsAsPagedModel(LogTimePeriod logTimePeriod, int skip, int take, Direction orderDirection = Direction.Descending, string? filterExpression = null, string[]? logLevels = null)
Parameters
Type Name Description
LogTimePeriod logTimePeriod
int skip
int take
Direction orderDirection
string filterExpression
string[] logLevels
Returns
Type Description
PagedModel<LogMessage>
View Source

GetMessageTemplates(LogTimePeriod)

Returns a list of all unique message templates and their counts

Declaration
[Obsolete("Use ILogViewerService.GetMessageTemplates instead. Scheduled for removal in Umbraco 15.")]
IEnumerable<LogTemplate> GetMessageTemplates(LogTimePeriod logTimePeriod)
Parameters
Type Name Description
LogTimePeriod logTimePeriod
Returns
Type Description
IEnumerable<LogTemplate>
View Source

GetNumberOfErrors(LogTimePeriod)

A count of number of errors By counting Warnings with Exceptions, Errors & Fatal messages

Declaration
int GetNumberOfErrors(LogTimePeriod logTimePeriod)
Parameters
Type Name Description
LogTimePeriod logTimePeriod
Returns
Type Description
int
View Source

GetSavedSearches()

Get all saved searches from your chosen data source

Declaration
[Obsolete("Use ILogViewerService.GetSavedLogQueriesAsync instead. Scheduled for removal in Umbraco 15.")]
IReadOnlyList<SavedLogSearch> GetSavedSearches()
Returns
Type Description
IReadOnlyList<SavedLogSearch>