Class DbClientMetricBuilder

    • Constructor Detail

      • DbClientMetricBuilder

        public DbClientMetricBuilder()
    • Method Detail

      • name

        public T name​(String metricName)
        Configure a metric name.
        Parameters:
        metricName - name of the metric
        Returns:
        updated builder instance
      • metadata

        public T metadata​(Metadata meta)
        Configure metric metadata.
        Parameters:
        meta - metric metadata
        Returns:
        updated builder instance
      • nameFormat

        public T nameFormat​(String format)
        Configure a name format.

        The format can use up to two parameters - first is the DbStatementType as a string, second is the statement name.

        Parameters:
        format - format string expecting zero to two parameters that can be processed by String.format(String, Object...)
        Returns:
        updated builder instance
      • nameFormat

        public T nameFormat​(BiFunction<String,​DbStatementType,​String> function)
        Configure a name format function.

        The first parameter is the statement name.

        Parameters:
        function - function to use to create metric name
        Returns:
        updated builder instance
      • errors

        public T errors​(boolean measureErrors)
        Whether to measure failed statements.
        Parameters:
        measureErrors - set to false if errors should be ignored
        Returns:
        updated builder instance
      • success

        public T success​(boolean measureSuccess)
        Whether to measure successful statements.
        Parameters:
        measureSuccess - set to false if successes should be ignored
        Returns:
        updated builder instance
      • description

        public T description​(String description)
        Description of the metric used in metric metadata.
        Parameters:
        description - description
        Returns:
        updated builder instance
      • config

        public T config​(Config config)
        Configure a metric from configuration. The following configuration key are used:
        DB Metric configuration options
        key default description
        errors true Whether this metric triggers for error states
        success true Whether this metric triggers for successful executions
        name-format db.metric-type.statement-name A string format used to construct a metric name. The format gets two parameters: the statement name and the statement type
        description   Description of this metric, used in metric Metadata
        Overrides:
        config in class DbClientServiceBase.DbClientServiceBuilderBase<T extends io.helidon.dbclient.metrics.DbClientMetricBuilderBase<T>>
        Parameters:
        config - configuration to configure this metric
        Returns:
        updated builder instance