IStatusReporter Interface

Definition

Provides an abstraction for generating status information that feeds into the response provided by the DiagnosticsController. The information exposed by the DiagnosticsController is access controlled using the ConfigOptions instance. Be careful not to expose any private or confidential information.

public interface IStatusReporter
type IStatusReporter = interface
Public Interface IStatusReporter
Derived

Remarks

Any information provided must be serializable as it is exposed by the DiagnosticsController.

Properties

Name

Provides a concise name for the status report which can be used as a key. The name is used as part of the report to identify who generated the report.

Methods

GetStatus(HttpConfiguration, ApiServices, CancellationToken)

Provides status information in the form of an StatusReport to be included in the response of the DiagnosticsController. The information exposed by the DiagnosticsController is access controlled using the ConfigOptions instance. While the information is access controller, be careful not to expose any private or confidential information.

Applies to