final case class MetricsConfig(reporters: Seq[MetricsReporterConfig] = Seq.empty, jvmMetrics: Option[JvmMetrics] = None, histograms: Seq[HistogramDefinition] = Seq.empty, cardinality: PositiveInt = PositiveInt.tryCreate(MetricStorage.DEFAULT_MAX_CARDINALITY), qualifiers: Seq[MetricQualification] = Seq[MetricQualification]( MetricQualification.Errors, MetricQualification.Latency, MetricQualification.Saturation, MetricQualification.Traffic, )) extends UniformCantonConfigValidation with Product with Serializable

Configure metric instrumentiation

reporters

which reports should be used to report metric output

jvmMetrics

if true, then JvmMetrics will be reported

histograms

customized histogram definitions

qualifiers

which metric qualifiers to include generally. by default, all except Debug metrics are included. The qualifier filtering takes precedence over the individual reporter filters

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MetricsConfig
  2. Serializable
  3. Product
  4. Equals
  5. UniformCantonConfigValidation
  6. CustomCantonConfigValidation
  7. CantonConfigValidation
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new MetricsConfig(reporters: Seq[MetricsReporterConfig] = Seq.empty, jvmMetrics: Option[JvmMetrics] = None, histograms: Seq[HistogramDefinition] = Seq.empty, cardinality: PositiveInt = PositiveInt.tryCreate(MetricStorage.DEFAULT_MAX_CARDINALITY), qualifiers: Seq[MetricQualification] = Seq[MetricQualification]( MetricQualification.Errors, MetricQualification.Latency, MetricQualification.Saturation, MetricQualification.Traffic, ))

    reporters

    which reports should be used to report metric output

    jvmMetrics

    if true, then JvmMetrics will be reported

    histograms

    customized histogram definitions

    qualifiers

    which metric qualifiers to include generally. by default, all except Debug metrics are included. The qualifier filtering takes precedence over the individual reporter filters

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val cardinality: PositiveInt
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  7. final def doValidate(edition: CantonEdition): Seq[CantonConfigValidationError]

    Returns all validation errors that are specific to this Canton configuration class.

    Returns all validation errors that are specific to this Canton configuration class. Successful validation should return an empty sequence.

    Validation errors of subconfigurations should not be reported by this method, but via the type class derivation.

    Attributes
    protected
    Definition Classes
    UniformCantonConfigValidationCustomCantonConfigValidation
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  10. val globalFilters: Seq[MetricsFilterConfig]
  11. val histograms: Seq[HistogramDefinition]
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. val jvmMetrics: Option[JvmMetrics]
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  17. def productElementNames: Iterator[String]
    Definition Classes
    Product
  18. val qualifiers: Seq[MetricQualification]
  19. val reporters: Seq[MetricsReporterConfig]
  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. final def validate[T >: MetricsConfig.this.type](edition: CantonEdition)(implicit validator: CantonConfigValidator[T]): Either[NonEmpty[Seq[CantonConfigValidationError]], Unit]
    Definition Classes
    CantonConfigValidation
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from CantonConfigValidation

Inherited from AnyRef

Inherited from Any

Ungrouped