Class BulkheadMetrics

java.lang.Object

io.github.resilience4j.metrics.BulkheadMetrics

All Implemented Interfaces:

com.codahale.metrics.Metric, com.codahale.metrics.MetricSet

public class BulkheadMetrics
extends Object
implements com.codahale.metrics.MetricSet

An adapter which exports Bulkhead.Metrics as Dropwizard Metrics Gauges.

Field Summary

Fields

Modifier and Type	Field	Description
private com.codahale.metrics.MetricRegistry	metricRegistry

Constructor Summary

Constructors

Modifier	Constructor	Description
private	BulkheadMetrics(Iterable<io.github.resilience4j.bulkhead.Bulkhead> bulkheads)
private	BulkheadMetrics(String prefix, Iterable<io.github.resilience4j.bulkhead.Bulkhead> bulkheads, com.codahale.metrics.MetricRegistry metricRegistry)

Method Summary

Modifier and Type	Method	Description
Map<String, com.codahale.metrics.Metric>	getMetrics()
static BulkheadMetrics	ofBulkhead(io.github.resilience4j.bulkhead.Bulkhead bulkhead)	Creates a new instance of BulkheadMetrics BulkheadMetrics with a bulkhead as a source.
static BulkheadMetrics	ofBulkheadRegistry(io.github.resilience4j.bulkhead.BulkheadRegistry bulkheadRegistry)	Creates a new instance BulkheadMetrics BulkheadMetrics with a BulkheadRegistry as a source.
static BulkheadMetrics	ofBulkheadRegistry(io.github.resilience4j.bulkhead.BulkheadRegistry bulkheadRegistry, com.codahale.metrics.MetricRegistry metricRegistry)	Creates a new instance BulkheadMetrics BulkheadMetrics with specified metrics names prefix and a BulkheadRegistry as a source.
static BulkheadMetrics	ofBulkheadRegistry(String prefix, io.github.resilience4j.bulkhead.BulkheadRegistry bulkheadRegistry)	Creates a new instance BulkheadMetrics BulkheadMetrics with specified metrics names prefix and a BulkheadRegistry as a source.
static BulkheadMetrics	ofBulkheadRegistry(String prefix, io.github.resilience4j.bulkhead.BulkheadRegistry bulkheadRegistry, com.codahale.metrics.MetricRegistry metricRegistry)	Creates a new instance BulkheadMetrics BulkheadMetrics with specified metrics names prefix and a BulkheadRegistry as a source.
static BulkheadMetrics	ofIterable(Iterable<io.github.resilience4j.bulkhead.Bulkhead> bulkheads)	Creates a new instance BulkheadMetrics BulkheadMetrics with an Iterable of bulkheads as a source.
static BulkheadMetrics	ofIterable(String prefix, Iterable<io.github.resilience4j.bulkhead.Bulkhead> bulkheads)	Creates a new instance BulkheadMetrics BulkheadMetrics with an Iterable of bulkheads as a source.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

metricRegistry

private com.codahale.metrics.MetricRegistry metricRegistry

Constructor Details

BulkheadMetrics

private BulkheadMetrics(Iterable<io.github.resilience4j.bulkhead.Bulkhead> bulkheads)

BulkheadMetrics

private BulkheadMetrics(String prefix,
 Iterable<io.github.resilience4j.bulkhead.Bulkhead> bulkheads,
 com.codahale.metrics.MetricRegistry metricRegistry)

Method Details

ofBulkheadRegistry

public static BulkheadMetrics ofBulkheadRegistry(String prefix,
 io.github.resilience4j.bulkhead.BulkheadRegistry bulkheadRegistry,
 com.codahale.metrics.MetricRegistry metricRegistry)

Creates a new instance BulkheadMetrics BulkheadMetrics with specified metrics names prefix and a BulkheadRegistry as a source.

Parameters:

prefix - the prefix of metrics names

bulkheadRegistry - the registry of bulkheads

metricRegistry - the metric registry

ofBulkheadRegistry

public static BulkheadMetrics ofBulkheadRegistry(String prefix,
 io.github.resilience4j.bulkhead.BulkheadRegistry bulkheadRegistry)

Creates a new instance BulkheadMetrics BulkheadMetrics with specified metrics names prefix and a BulkheadRegistry as a source.

Parameters:

prefix - the prefix of metrics names

bulkheadRegistry - the registry of bulkheads

ofBulkheadRegistry

public static BulkheadMetrics ofBulkheadRegistry(io.github.resilience4j.bulkhead.BulkheadRegistry bulkheadRegistry,
 com.codahale.metrics.MetricRegistry metricRegistry)

Creates a new instance BulkheadMetrics BulkheadMetrics with specified metrics names prefix and a BulkheadRegistry as a source.

Parameters:

bulkheadRegistry - the registry of bulkheads

metricRegistry - the metric registry

ofBulkheadRegistry

public static BulkheadMetrics ofBulkheadRegistry(io.github.resilience4j.bulkhead.BulkheadRegistry bulkheadRegistry)

Creates a new instance BulkheadMetrics BulkheadMetrics with a BulkheadRegistry as a source.

Parameters:

bulkheadRegistry - the registry of bulkheads

ofIterable

public static BulkheadMetrics ofIterable(Iterable<io.github.resilience4j.bulkhead.Bulkhead> bulkheads)

Creates a new instance BulkheadMetrics BulkheadMetrics with an Iterable of bulkheads as a source.

Parameters:

bulkheads - the bulkheads

ofIterable

public static BulkheadMetrics ofIterable(String prefix,
 Iterable<io.github.resilience4j.bulkhead.Bulkhead> bulkheads)

Creates a new instance BulkheadMetrics BulkheadMetrics with an Iterable of bulkheads as a source.

Parameters:

bulkheads - the bulkheads

ofBulkhead

public static BulkheadMetrics ofBulkhead(io.github.resilience4j.bulkhead.Bulkhead bulkhead)

Creates a new instance of BulkheadMetrics BulkheadMetrics with a bulkhead as a source.

Parameters:

bulkhead - the circuit breaker

getMetrics

public Map<String, com.codahale.metrics.Metric> getMetrics()

Specified by:

getMetrics in interface com.codahale.metrics.MetricSet