Share via


IStoreUpdateLoggerWithAmbientContext Interface

Definition

Adds ambient context to an IStoreUpdateLogger. Ambient context is implemented via the SetContext(StoreLogPropertyInstance[]) method, which allows the caller to supply properties which will be set on all events emitted within the current execution context until the returned IDisposable is disposed.

public interface class IStoreUpdateLoggerWithAmbientContext : Microsoft::VisualStudio::Settings::IStoreUpdateLogger
public interface IStoreUpdateLoggerWithAmbientContext : Microsoft.VisualStudio.Settings.IStoreUpdateLogger
type IStoreUpdateLoggerWithAmbientContext = interface
    interface IStoreUpdateLogger
Public Interface IStoreUpdateLoggerWithAmbientContext
Implements IStoreUpdateLogger
Implements

Methods

BeginNoisyOperation()

Signals the beginning of an operation that may log a large number of updates. The logger may choose to handle the logging differently during this operation, e.g. batching the updates for telemetry and posting a single event at the end.

(Inherited from IStoreUpdateLogger)
LogClearSettingsAsync(String, String, Nullable<Boolean>)

Logs a record of clearing all settings from a specific store.

(Inherited from IStoreUpdateLogger)
LogClearSettingsFailureAsync(Exception, String, String, Nullable<Boolean>)

Logs a record of a failure to clear a specific store.

(Inherited from IStoreUpdateLogger)
LogSettingDeletionAsync(String, String, String, Nullable<Boolean>, Nullable<Boolean>)

Logs a record of a deletion in a specific setting store.

(Inherited from IStoreUpdateLogger)
LogSettingDeletionFailureAsync(Exception, String, String, String, Nullable<Boolean>, Nullable<Boolean>)

Logs a record of a failure to delete a specific setting from a specific store.

(Inherited from IStoreUpdateLogger)
LogSettingUpdateAsync(String, String, String, Boolean, String, Nullable<Int32>, Nullable<Int32>, String, Nullable<Boolean>, Nullable<Boolean>)

Logs a record of an update to a specific setting store.

(Inherited from IStoreUpdateLogger)
LogSettingUpdateFailureAsync(Exception, String, String, String, Boolean, String, Nullable<Int32>, Nullable<Int32>, String, Nullable<Boolean>, Nullable<Boolean>)

Logs a record of a failure to update a specific setting in a specific store.

(Inherited from IStoreUpdateLogger)
LogSettingUpdateFailureAsync(String, String, String, String, Boolean, Boolean, String, Nullable<Int32>, Nullable<Int32>, String, Nullable<Boolean>, Nullable<Boolean>)

Logs a record of a failure to update a specific setting in a specific store.

(Inherited from IStoreUpdateLogger)
SetContext(StoreLogPropertyInstance[])

Sets one or more ambient property values that will be added to all store logging (unless overridden by local parameters) until the returned IDisposable is disposed. These apply only to the current execution context, so other threads or async execution flows running concurrently, even against the same logger instance, will not be affected.

Applies to