Packages

final case class Csv(directory: File, interval: NonNegativeFiniteDuration = NonNegativeFiniteDuration.ofSeconds(5), contextKeys: Set[String] = Set("node", "synchronizer"), filters: Seq[MetricsFilterConfig] = Seq.empty) extends MetricsReporterConfig with UniformCantonConfigValidation with Product with Serializable

CSV metrics reporter configuration

This reporter will write the given metrics into respective csv files. Please note that you should use filters as otherwise, you'll get many files

directory

where to write the csv files to

interval

how often to write the csv files

contextKeys

which context keys to include in the name. defaults to node names

filters

which metrics to include

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

Instance Constructors

  1. new Csv(directory: File, interval: NonNegativeFiniteDuration = NonNegativeFiniteDuration.ofSeconds(5), contextKeys: Set[String] = Set("node", "synchronizer"), filters: Seq[MetricsFilterConfig] = Seq.empty)

    directory

    where to write the csv files to

    interval

    how often to write the csv files

    contextKeys

    which context keys to include in the name. defaults to node names

    filters

    which metrics to include

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. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  6. val contextKeys: Set[String]
  7. val directory: File
  8. 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
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. val filters: Seq[MetricsFilterConfig]
    Definition Classes
    CsvMetricsReporterConfig
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  12. val interval: NonNegativeFiniteDuration
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  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. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  19. final def validate[T >: Csv.this.type](edition: CantonEdition)(implicit validator: CantonConfigValidator[T]): Either[NonEmpty[Seq[CantonConfigValidationError]], Unit]
    Definition Classes
    CantonConfigValidation
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  22. 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 MetricsReporterConfig

Inherited from AnyRef

Inherited from Any

Ungrouped