App.Metrics.Abstractions by Allan Hardy and Contributors

<PackageReference Include="App.Metrics.Abstractions" Version="4.2.0-preview.0.19" />

---

API Diff between 4.2.0-preview.0.19 and 3.0.0

108 Additions 11 Removals

App.Metrics

• public enum BucketHistogramFields
  • Bucket = 2
  • Count = 0
  • Sum = 1
• public class ContextualMetricTagProviders : Dictionary<string, Func<string>>
  • public ContextualMetricTagProviders(Dictionary<string, Func<string>> tagProviders)
  • public ContextualMetricTagProviders()
  • public Dictionary<string, string> ComputeTagValues()
• public interface IBuildMetrics
  • IBuildBucketHistogramMetrics BucketHistogram { get; }
  • IBuildBucketTimerMetrics BucketTimer { get; }
• public interface IMeasureMetrics
  • IMeasureBucketHistogramMetrics BucketHistogram { get; }
  • IMeasureBucketTimerMetrics BucketTimer { get; }
• public interface IProvideMetrics
  • IProvideBucketTimerMetrics BucketTimer { get; }
• public class MetricFields
  • public IDictionary<BucketHistogramFields, string> BucketHistogram { get; }
• public sealed class MetricsContextValueSource
  • public IEnumerable<BucketHistogramValueSource> BucketHistograms { get; }
  • public IEnumerable<BucketTimerValueSource> BucketTimers { get; }
  • public MetricsContextValueSource(string context, IEnumerable<GaugeValueSource> gauges, IEnumerable<CounterValueSource> counters, IEnumerable<MeterValueSource> meters, IEnumerable<HistogramValueSource> histograms, IEnumerable<TimerValueSource> timers, IEnumerable<ApdexValueSource> apdexScores)
  • public MetricsContextValueSource(string context, IEnumerable<GaugeValueSource> gauges, IEnumerable<CounterValueSource> counters, IEnumerable<MeterValueSource> meters, IEnumerable<HistogramValueSource> histograms, IEnumerable<BucketHistogramValueSource> bucketHistograms, IEnumerable<TimerValueSource> timers, IEnumerable<BucketTimerValueSource> bucketTimers, IEnumerable<ApdexValueSource> apdexScores)
• public class MetricsOptions
  • public ContextualMetricTagProviders ContextualTags { get; set; }
• public enum MetricType
  • BucketHistogram = 4
  • BucketTimer = 6
• public static class MetricValueExtensions
  • public static void AddBucketHistogramValues(this BucketHistogramValue histogram, IDictionary<string, object> values, IDictionary<string, string> fields)
  • public static void AddBucketTimerValues(this BucketTimerValue timer, IDictionary<string, object> values, IDictionary<string, string> fields)
• public abstract class MetricValueOptionsBase
  • public bool ResetOnReporting { get; set; }
• public abstract class MetricValueSourceBase<T>
  • public bool ResetOnReporting { get; }
  • protected MetricValueSourceBase(string name, IMetricValueProvider<T> valueProvider, Unit unit, MetricTags tags)
  • protected MetricValueSourceBase(string name, IMetricValueProvider<T> valueProvider, Unit unit, MetricTags tags, bool resetOnReporting = false)

App.Metrics.Apdex

• public class ApdexOptions : MetricValueWithSamplingOption
  • public bool ResetOnReporting { get; set; }

App.Metrics.BucketHistogram

• public class BucketHistogramOptions : MetricValueOptionsBase
  • public IEnumerable<double> Buckets { get; set; }
  • public BucketHistogramOptions()
• public sealed class BucketHistogramValue
  • public IReadOnlyDictionary<double, double> Buckets { get; }
  • public long Count { get; }
  • public double Sum { get; }
  • public BucketHistogramValue(long count, double sum, IReadOnlyDictionary<double, double> buckets)
  • public BucketHistogramValue Scale(double factor)
• public sealed class BucketHistogramValueSource : MetricValueSourceBase<BucketHistogramValue>
  • public BucketHistogramValueSource(string name, IMetricValueProvider<BucketHistogramValue> valueProvider, Unit unit, MetricTags tags)
• public interface IBucketHistogram : IHistogram, IResetableMetric
• public interface IBucketHistogramMetric : IBucketHistogram, IHistogram, IResetableMetric, IMetricValueProvider<BucketHistogramValue>, IDisposable
• public interface IBuildBucketHistogramMetrics
  • IBucketHistogramMetric Build(IEnumerable<double> buckets)
• public interface IMeasureBucketHistogramMetrics
  • void Update(BucketHistogramOptions options, long value)
  • void Update(BucketHistogramOptions options, MetricTags tags, long value)
• public interface IProvideBucketHistogramMetrics
  • IBucketHistogram Instance(BucketHistogramOptions options)
  • IBucketHistogram Instance<T>(BucketHistogramOptions options, Func<T> builder) where T : IBucketHistogramMetric
  • IBucketHistogram Instance(BucketHistogramOptions options, MetricTags tags)
  • IBucketHistogram Instance<T>(BucketHistogramOptions options, MetricTags tags, Func<T> builder) where T : IBucketHistogramMetric

App.Metrics.BucketTimer

• public class BucketTimerOptions : MetricValueOptionsBase
  • public IEnumerable<double> Buckets { get; set; }
  • public TimeUnit DurationUnit { get; set; }
  • public TimeUnit RateUnit { get; set; }
  • public BucketTimerOptions()
• public sealed class BucketTimerValue
  • public long ActiveSessions { get; }
  • public TimeUnit DurationUnit { get; }
  • public BucketHistogramValue Histogram { get; }
  • public MeterValue Rate { get; }
  • public BucketTimerValue(MeterValue rate, BucketHistogramValue histogram, long activeSessions, TimeUnit durationUnit)
  • public BucketTimerValue Scale(TimeUnit rate, TimeUnit duration)
• public sealed class BucketTimerValueSource : MetricValueSourceBase<BucketTimerValue>
  • public TimeUnit DurationUnit { get; }
  • public TimeUnit RateUnit { get; }
  • public BucketTimerValueSource(string name, IMetricValueProvider<BucketTimerValue> value, Unit unit, TimeUnit rateUnit, TimeUnit durationUnit, MetricTags tags)
• public interface IBucketTimerMetric : ITimer, IResetableMetric, IMetricValueProvider<BucketTimerValue>
• public interface IBuildBucketTimerMetrics
  • IBucketTimerMetric Build(IBucketHistogramMetric histogram, IClock clock, TimeUnit timeUnit)
  • IBucketTimerMetric Build(IEnumerable<double> buckets, IClock clock, TimeUnit timeUnit)
  • IBucketTimerMetric Build(IBucketHistogramMetric histogram, IMeterMetric meter, IClock clock, TimeUnit timeUnit)
  • IBucketTimerMetric Build(IEnumerable<double> buckets, IMeterMetric meter, IClock clock, TimeUnit timeUnit)
• public interface IMeasureBucketTimerMetrics
  • void Time(BucketTimerOptions options, Action action)
  • void Time(BucketTimerOptions options, MetricTags tags, Action action)
  • void Time(BucketTimerOptions options, Action action, string userValue)
  • void Time(BucketTimerOptions options, MetricTags tags, Action action, string userValue)
  • TimerContext Time(BucketTimerOptions options, MetricTags tags, string userValue)
  • TimerContext Time(BucketTimerOptions options, string userValue)
  • TimerContext Time(BucketTimerOptions options, MetricTags tags)
  • TimerContext Time(BucketTimerOptions options)
• public interface IProvideBucketTimerMetrics
  • ITimer Instance(BucketTimerOptions options)
  • ITimer Instance(BucketTimerOptions options, MetricTags tags)
  • ITimer Instance<T>(BucketTimerOptions options, Func<T> builder) where T : IBucketTimerMetric
  • ITimer Instance<T>(BucketTimerOptions options, MetricTags tags, Func<T> builder) where T : IBucketTimerMetric
  • ITimer WithHistogram<T>(BucketTimerOptions options, Func<T> histogramMetricBuilder) where T : IBucketHistogramMetric
  • ITimer WithHistogram<T>(BucketTimerOptions options, MetricTags tags, Func<T> histogramMetricBuilder) where T : IBucketHistogramMetric

App.Metrics.Counter

• public class CounterOptions : MetricValueOptionsBase
  • public bool ResetOnReporting { get; set; }
• public sealed class CounterValueSource : MetricValueSourceBase<CounterValue>
  • public bool ResetOnReporting { get; }

App.Metrics.Filters

• public interface IFilterMetrics
  • bool IsBucketHistogramMatch(BucketHistogramValueSource histogram)
  • bool IsBucketTimerMatch(BucketTimerValueSource timer)

App.Metrics.Gauge

• public sealed class GaugeValueSource : MetricValueSourceBase<double>
  • public GaugeValueSource(string name, IMetricValueProvider<double> value, Unit unit, MetricTags tags)
  • public GaugeValueSource(string name, IMetricValueProvider<double> value, Unit unit, MetricTags tags, bool restOnReporting = false)

App.Metrics.Histogram

• public sealed class HistogramValueSource : MetricValueSourceBase<HistogramValue>
  • public HistogramValueSource(string name, IMetricValueProvider<HistogramValue> valueProvider, Unit unit, MetricTags tags)
  • public HistogramValueSource(string name, IMetricValueProvider<HistogramValue> valueProvider, Unit unit, MetricTags tags, bool restOnReporting = false)

App.Metrics.Meter

• public sealed class MeterValueSource : MetricValueSourceBase<MeterValue>
  • public MeterValueSource(string name, IMetricValueProvider<MeterValue> value, Unit unit, TimeUnit rateUnit, MetricTags tags, bool reportSetItems = true)
  • public MeterValueSource(string name, IMetricValueProvider<MeterValue> value, Unit unit, TimeUnit rateUnit, MetricTags tags, bool resetOnReporting = false, bool reportSetItems = true)

App.Metrics.Registry

• public interface IMetricContextRegistry
  • IBucketHistogram BucketHistogram<T>(BucketHistogramOptions options, Func<T> builder) where T : IBucketHistogramMetric
  • IBucketHistogram BucketHistogram<T>(BucketHistogramOptions options, MetricTags tags, Func<T> builder) where T : IBucketHistogramMetric
  • ITimer BucketTimer<T>(BucketTimerOptions options, Func<T> builder) where T : IBucketTimerMetric
  • ITimer BucketTimer<T>(BucketTimerOptions options, MetricTags tags, Func<T> builder) where T : IBucketTimerMetric
• public interface IMetricRegistryManager
  • IEnumerable<BucketHistogramValueSource> BucketHistograms { get; }
  • IEnumerable<BucketTimerValueSource> BucketTimers { get; }
• public interface IMetricsRegistry
  • IBucketHistogram BucketHistogram<T>(BucketHistogramOptions options, Func<T> builder) where T : IBucketHistogramMetric
  • IBucketHistogram BucketHistogram<T>(BucketHistogramOptions options, MetricTags tags, Func<T> builder) where T : IBucketHistogramMetric
  • ITimer BucketTimer<T>(BucketTimerOptions options, Func<T> builder) where T : IBucketTimerMetric
  • ITimer BucketTimer<T>(BucketTimerOptions options, MetricTags tags, Func<T> builder) where T : IBucketTimerMetric

App.Metrics.Serialization

• public sealed class EnvironmentInfoSerializer
  • public void Serialize(IEnvInfoWriter writer, EnvironmentInfo envInfo)
  • public ValueTask Serialize(IEnvInfoWriter writer, EnvironmentInfo envInfo)
• public interface IEnvInfoWriter : IAsyncDisposable, IDisposable
  • void Write(EnvironmentInfo envInfo)
  • ValueTask Write(EnvironmentInfo envInfo)
• public static class MetricSnapshotWriterExtensions
  • public static void WriteBucketHistogram(this IMetricSnapshotWriter writer, string context, MetricValueSourceBase<BucketHistogramValue> valueSource, IDictionary<string, string> fields, DateTime timestamp)
  • public static void WriteBucketTimer(this IMetricSnapshotWriter writer, string context, MetricValueSourceBase<BucketTimerValue> valueSource, IDictionary<string, string> fields, DateTime timestamp)

App.Metrics.Timer

• public interface IMeasureTimerMetrics
  • void Time(TimerOptions options, MetricTags tags, long time)
  • void Time(TimerOptions options, long time)
• public sealed class TimerValueSource : MetricValueSourceBase<TimerValue>
  • public TimerValueSource(string name, IMetricValueProvider<TimerValue> value, Unit unit, TimeUnit rateUnit, TimeUnit durationUnit, MetricTags tags)
  • public TimerValueSource(string name, IMetricValueProvider<TimerValue> value, Unit unit, TimeUnit rateUnit, TimeUnit durationUnit, MetricTags tags, bool restOnReporting = false)