View Source

Interface ILogViewer

Namespace: Umbraco.Cms.Core.Logging.Viewer
Assembly: Umbraco.Infrastructure.dll
Syntax
public interface ILogViewer

Properties

View Source

CanHandleLargeLogs

Declaration
bool CanHandleLargeLogs { get; }
Property Value
Type Description
System.Boolean

Methods

View Source

AddSavedSearch(String, String)

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

Declaration
IReadOnlyList<SavedLogSearch>? AddSavedSearch(string name, string query)
Parameters
Type Name Description
System.String name
System.String query
Returns
Type Description
System.Nullable<IReadOnlyList<SavedLogSearch>>
View Source

CheckCanOpenLogs(LogTimePeriod)

Declaration
bool CheckCanOpenLogs(LogTimePeriod logTimePeriod)
Parameters
Type Name Description
LogTimePeriod logTimePeriod
Returns
Type Description
System.Boolean
View Source

DeleteSavedSearch(String, String)

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

Declaration
IReadOnlyList<SavedLogSearch>? DeleteSavedSearch(string name, string query)
Parameters
Type Name Description
System.String name
System.String query
Returns
Type Description
System.Nullable<IReadOnlyList<SavedLogSearch>>
View Source

GetLogLevel()

Gets the current Serilog minimum log level

Declaration
string GetLogLevel()
Returns
Type Description
System.String
View Source

GetLogLevelCounts(LogTimePeriod)

Returns a number of the different log level entries

Declaration
LogLevelCounts GetLogLevelCounts(LogTimePeriod logTimePeriod)
Parameters
Type Name Description
LogTimePeriod logTimePeriod
Returns
Type Description
LogLevelCounts
View Source

GetLogs(LogTimePeriod, Int32, Int32, Direction, String, String[])

Returns the collection of logs

Declaration
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
System.Int32 pageNumber
System.Int32 pageSize
Direction orderDirection
System.String filterExpression
System.String[] logLevels
Returns
Type Description
PagedResult<LogMessage>
View Source

GetMessageTemplates(LogTimePeriod)

Returns a list of all unique message templates and their counts

Declaration
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
System.Int32
View Source

GetSavedSearches()

Get all saved searches from your chosen data source

Declaration
IReadOnlyList<SavedLogSearch>? GetSavedSearches()
Returns
Type Description
System.Nullable<IReadOnlyList<SavedLogSearch>>