App Metrics Fork me on GitHub
Show / Hide Table of Contents

Class AppMetricsOptions

Top level container for all configuration settings of AppMetrics

Inheritance
System.Object
AppMetricsOptions
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace:App.Metrics.Configuration
Assembly:cs.temp.dll.dll
Syntax
public sealed class AppMetricsOptions

Properties

AddDefaultGlobalTags

Gets or sets a value indicating whether or not to [add default global tags]. e.g. app, server, env

Declaration
public bool AddDefaultGlobalTags { get; set; }
Property Value
Type Description
System.Boolean

true if [add default global tags]; otherwise, false.

DefaultContextLabel

Gets or sets the default context label using for grouping metrics in contexts.

Declaration
public string DefaultContextLabel { get; set; }
Property Value
Type Description
System.String

The default context label used for grouping metrics within the .

Remarks

Defaults to "Application"

GlobalTags

Gets or sets the global tags to apply on all metrics when reporting.

Declaration
public GlobalMetricTags GlobalTags { get; set; }
Property Value
Type Description
GlobalMetricTags

The global tags applied to on all metrics when reporting.

MetricsEnabled

Gets or sets a value indicating whether [metrics tracking enabled]. This will also avoid registering all metric tracking middleware if using App.Metrics.Extensions.Middleware.

Declaration
public bool MetricsEnabled { get; set; }
Property Value
Type Description
System.Boolean

true if [metrics enabled]; otherwise, false.

Remarks

If disabled no metrics will be recorded or stored in memory

ReportingEnabled

Gets or sets a value indicating whether [reporting enabled].

Declaration
public bool ReportingEnabled { get; set; }
Property Value
Type Description
System.Boolean

true if [reporting enabled]; otherwise, false.

Back to top Copyright © 2017 Allan Hardy
Generated by DocFX