Package com.inductiveautomation.ignition.common.logging

Interface LogFilterSettings

All Known Subinterfaces:

GatewayLoggingManager, MonitoringSession

All Known Implementing Classes:

LoggingManagerImpl

public interface LogFilterSettings

Created by colby.clegg on 5/5/2016.

Method Summary

Modifier and Type	Method	Description
void	addPropertyFilter(String key, String value)	Restricts collected events to only those that have the matching value, IF the key is present in the MDC context.
void	clearPropertyLevel(String key, String value)	Removes a specific key/value level from the logging system.
void	clearPropertyLevels()	Clears all property levels defined in the system.
Map<String,Map<String,Level>>	propertyFilterSettings()	Returns a map of the property keys currently applied, as well as their values and the Level set for each value
void	removePropertyFilter(String key, String value)	Removes a filter previously registered with addPropertyFilter.
void	setLevel(String logger, Level level)	Sets the level for the specified logger.
void	setPropertyLevel(String key, String value, Level level)	Sets a level for a specific MDC property/value, creating the property/value if necessary.

Method Details

setLevel

void setLevel(String logger,
 Level level)

Sets the level for the specified logger.

setPropertyLevel

void setPropertyLevel(String key,
 String value,
 Level level)

Sets a level for a specific MDC property/value, creating the property/value if necessary. This will cause events with matching properties to be collected at this level by the monitoring session, even if the logger level is more restrictive. This setting will not affect other monitoring sessions.

Parameters:

key - the name of the MDC property key

value - the specific value belonging to the key that the Level should apply to.

level - The level to set the MDC key value to.

clearPropertyLevel

void clearPropertyLevel(String key,
 String value)

Removes a specific key/value level from the logging system.

clearPropertyLevels

void clearPropertyLevels()

Clears all property levels defined in the system.

propertyFilterSettings

Map<String,Map<String,Level>> propertyFilterSettings()

Returns a map of the property keys currently applied, as well as their values and the Level set for each value

addPropertyFilter

void addPropertyFilter(String key,
 String value)

Restricts collected events to only those that have the matching value, IF the key is present in the MDC context. In other words, this filter is not applied to events that do not have the key present.

Parameters:

key - name of the property filter to add

value - the value for the given key that should be filtered for

removePropertyFilter

void removePropertyFilter(String key,
 String value)

Removes a filter previously registered with addPropertyFilter.