io.confluent.log4j.redactor

Interface LogRedactorMetrics

public interface LogRedactorMetrics

A pluggable metrics interface for log redactor to write metrics. It provides three methods:

• count: called when an event occurs.
• timer: called after measuring the time elapsed for an event.
• gauge: called after measuring a "current" value.

Each metric has a name and zero or more tags. Tags are key-value pairs of Strings. Metric names and tag keys contain only letters, numbers, and underscores. Tag values may potentially contain any String. Implementors of the interface must escape and truncate tag values to fit their own validation requirements.

Field Summary

Fields

Modifier and Type	Field and Description
static String	COUNT_ERROR
static String	COUNT_MATCHED_LOG_STATEMENTS
static String	COUNT_MATCHES
static String	COUNT_POLICY_UPDATE
static String	COUNT_REDACTED_LOG_STATEMENTS
static String	COUNT_REDACTIONS
static String	COUNT_SCANNED_LOG_STATEMENTS
static String	GAUGE_POLICY_RULE_COUNT
static LogRedactorMetrics	NOOP A no-op implementation, that ignores all metrics rather than collecting them.
static String	TIMER_READ_POLICY_SECONDS

Method Summary

Modifier and Type	Method and Description
void	count(String metricName, Map<String,String> tags) Called when an event occurs.
void	gauge(double value, String metricName, Map<String,String> tags) Called after measuring a "current" value.
void	timer(double value, String metricName, Map<String,String> tags) Called after measuring the time elapsed for an event.

Field Detail

COUNT_POLICY_UPDATE

static final String COUNT_POLICY_UPDATE

See Also:

Constant Field Values

COUNT_ERROR

static final String COUNT_ERROR

See Also:

Constant Field Values

COUNT_REDACTIONS

static final String COUNT_REDACTIONS

See Also:

Constant Field Values

COUNT_MATCHES

static final String COUNT_MATCHES

See Also:

Constant Field Values

COUNT_SCANNED_LOG_STATEMENTS

static final String COUNT_SCANNED_LOG_STATEMENTS

See Also:

Constant Field Values

COUNT_REDACTED_LOG_STATEMENTS

static final String COUNT_REDACTED_LOG_STATEMENTS

See Also:

Constant Field Values

COUNT_MATCHED_LOG_STATEMENTS

static final String COUNT_MATCHED_LOG_STATEMENTS

See Also:

Constant Field Values

TIMER_READ_POLICY_SECONDS

static final String TIMER_READ_POLICY_SECONDS

See Also:

Constant Field Values

GAUGE_POLICY_RULE_COUNT

static final String GAUGE_POLICY_RULE_COUNT

See Also:

Constant Field Values

NOOP

static final LogRedactorMetrics NOOP

A no-op implementation, that ignores all metrics rather than collecting them.

Method Detail

count

void count(String metricName,
           Map<String,String> tags)

Called when an event occurs.

Parameters:

metricName - The name of the metric. May contain alpha-numerics and underscore.

tags - Key-value pairs.

timer

void timer(double value,
           String metricName,
           Map<String,String> tags)

Called after measuring the time elapsed for an event.

Parameters:

value - Elapsed time, in seconds.

metricName - The name of the metric. May contain alpha-numerics and underscore.

tags - Key-value pairs.

gauge

void gauge(double value,
           String metricName,
           Map<String,String> tags)

Called after measuring a "current" value.

Parameters:

value - The "current" value, as measured.

metricName - The name of the metric. May contain alpha-numerics and underscore.

tags - Key-value pairs.