Class DiagnosticsSurface
Namespace: Cephalon.AspNetCore.Diagnostics
Assembly: Cephalon.AspNetCore.dll
Describes the operator-facing diagnostics surface exposed by a Cephalon ASP.NET Core host.
public sealed record DiagnosticsSurface : IEquatable<DiagnosticsSurface>Inheritance
Section titled “Inheritance”Implements
Section titled “Implements”IEquatable<DiagnosticsSurface>
Inherited Members
Section titled “Inherited Members”object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()
Constructors
Section titled “Constructors”DiagnosticsSurface(string, string, IReadOnlyList<string>, IReadOnlyList<DiagnosticsConvention>, RuntimeHealthReport, RuntimeHealthReport, string, string, string)
Section titled “ DiagnosticsSurface(string, string, IReadOnlyList<string>, IReadOnlyList<DiagnosticsConvention>, RuntimeHealthReport, RuntimeHealthReport, string, string, string)”Describes the operator-facing diagnostics surface exposed by a Cephalon ASP.NET Core host.
public DiagnosticsSurface(string MeterName, string ActivitySourceName, IReadOnlyList<string> Counters, IReadOnlyList<DiagnosticsConvention> Conventions, RuntimeHealthReport Liveness, RuntimeHealthReport Readiness, string SummaryPath, string LivenessPath, string ReadinessPath)Parameters
Section titled “Parameters”MeterName string
The meter name used for engine metrics.
ActivitySourceName string
The activity source name used for engine tracing.
Counters IReadOnlyList<string>
The built-in counter names exposed by the engine.
Conventions IReadOnlyList<DiagnosticsConvention>
The published diagnostics conventions and event-id catalogs visible to the current host.
Liveness RuntimeHealthReport
The current liveness report.
Readiness RuntimeHealthReport
The current readiness report.
SummaryPath string
The aggregate health endpoint path.
LivenessPath string
The liveness endpoint path.
ReadinessPath string
The readiness endpoint path.
Properties
Section titled “Properties”ActivitySourceName
Section titled “ ActivitySourceName”The activity source name used for engine tracing.
public string ActivitySourceName { get; init; }Property Value
Section titled “Property Value”Conventions
Section titled “ Conventions”The published diagnostics conventions and event-id catalogs visible to the current host.
public IReadOnlyList<DiagnosticsConvention> Conventions { get; init; }Property Value
Section titled “Property Value”IReadOnlyList<DiagnosticsConvention>
Counters
Section titled “ Counters”The built-in counter names exposed by the engine.
public IReadOnlyList<string> Counters { get; init; }Property Value
Section titled “Property Value”Liveness
Section titled “ Liveness”The current liveness report.
public RuntimeHealthReport Liveness { get; init; }Property Value
Section titled “Property Value”RuntimeHealthReport
LivenessPath
Section titled “ LivenessPath”The liveness endpoint path.
public string LivenessPath { get; init; }Property Value
Section titled “Property Value”MeterName
Section titled “ MeterName”The meter name used for engine metrics.
public string MeterName { get; init; }Property Value
Section titled “Property Value”Readiness
Section titled “ Readiness”The current readiness report.
public RuntimeHealthReport Readiness { get; init; }Property Value
Section titled “Property Value”RuntimeHealthReport
ReadinessPath
Section titled “ ReadinessPath”The readiness endpoint path.
public string ReadinessPath { get; init; }Property Value
Section titled “Property Value”SummaryPath
Section titled “ SummaryPath”The aggregate health endpoint path.
public string SummaryPath { get; init; }