NoopMeter.d.ts 3.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  1. import { Meter } from './Meter';
  2. import { BatchObservableCallback, Counter, Gauge, Histogram, MetricAttributes, MetricOptions, Observable, ObservableCallback, ObservableCounter, ObservableGauge, ObservableUpDownCounter, UpDownCounter } from './Metric';
  3. /**
  4. * NoopMeter is a noop implementation of the {@link Meter} interface. It reuses
  5. * constant NoopMetrics for all of its methods.
  6. */
  7. export declare class NoopMeter implements Meter {
  8. constructor();
  9. /**
  10. * @see {@link Meter.createGauge}
  11. */
  12. createGauge(_name: string, _options?: MetricOptions): Gauge;
  13. /**
  14. * @see {@link Meter.createHistogram}
  15. */
  16. createHistogram(_name: string, _options?: MetricOptions): Histogram;
  17. /**
  18. * @see {@link Meter.createCounter}
  19. */
  20. createCounter(_name: string, _options?: MetricOptions): Counter;
  21. /**
  22. * @see {@link Meter.createUpDownCounter}
  23. */
  24. createUpDownCounter(_name: string, _options?: MetricOptions): UpDownCounter;
  25. /**
  26. * @see {@link Meter.createObservableGauge}
  27. */
  28. createObservableGauge(_name: string, _options?: MetricOptions): ObservableGauge;
  29. /**
  30. * @see {@link Meter.createObservableCounter}
  31. */
  32. createObservableCounter(_name: string, _options?: MetricOptions): ObservableCounter;
  33. /**
  34. * @see {@link Meter.createObservableUpDownCounter}
  35. */
  36. createObservableUpDownCounter(_name: string, _options?: MetricOptions): ObservableUpDownCounter;
  37. /**
  38. * @see {@link Meter.addBatchObservableCallback}
  39. */
  40. addBatchObservableCallback(_callback: BatchObservableCallback, _observables: Observable[]): void;
  41. /**
  42. * @see {@link Meter.removeBatchObservableCallback}
  43. */
  44. removeBatchObservableCallback(_callback: BatchObservableCallback): void;
  45. }
  46. export declare class NoopMetric {
  47. }
  48. export declare class NoopCounterMetric extends NoopMetric implements Counter {
  49. add(_value: number, _attributes: MetricAttributes): void;
  50. }
  51. export declare class NoopUpDownCounterMetric extends NoopMetric implements UpDownCounter {
  52. add(_value: number, _attributes: MetricAttributes): void;
  53. }
  54. export declare class NoopGaugeMetric extends NoopMetric implements Gauge {
  55. record(_value: number, _attributes: MetricAttributes): void;
  56. }
  57. export declare class NoopHistogramMetric extends NoopMetric implements Histogram {
  58. record(_value: number, _attributes: MetricAttributes): void;
  59. }
  60. export declare class NoopObservableMetric {
  61. addCallback(_callback: ObservableCallback): void;
  62. removeCallback(_callback: ObservableCallback): void;
  63. }
  64. export declare class NoopObservableCounterMetric extends NoopObservableMetric implements ObservableCounter {
  65. }
  66. export declare class NoopObservableGaugeMetric extends NoopObservableMetric implements ObservableGauge {
  67. }
  68. export declare class NoopObservableUpDownCounterMetric extends NoopObservableMetric implements ObservableUpDownCounter {
  69. }
  70. export declare const NOOP_METER: NoopMeter;
  71. export declare const NOOP_COUNTER_METRIC: NoopCounterMetric;
  72. export declare const NOOP_GAUGE_METRIC: NoopGaugeMetric;
  73. export declare const NOOP_HISTOGRAM_METRIC: NoopHistogramMetric;
  74. export declare const NOOP_UP_DOWN_COUNTER_METRIC: NoopUpDownCounterMetric;
  75. export declare const NOOP_OBSERVABLE_COUNTER_METRIC: NoopObservableCounterMetric;
  76. export declare const NOOP_OBSERVABLE_GAUGE_METRIC: NoopObservableGaugeMetric;
  77. export declare const NOOP_OBSERVABLE_UP_DOWN_COUNTER_METRIC: NoopObservableUpDownCounterMetric;
  78. /**
  79. * Create a no-op Meter
  80. */
  81. export declare function createNoopMeter(): Meter;
  82. //# sourceMappingURL=NoopMeter.d.ts.map