Resilience4j

Supported OS Linux Mac OS Windows

Integration version1.1.0

Overview

Resilience4j is a lightweight fault tolerance library inspired by Netflix Hystrix, but designed for functional programming. This check monitors Resilience4j through the Datadog Agent.

Setup

Installation

To install the Resilience4j check on your host:

  1. Install the [developer toolkit] (https://docs.datadoghq.com/developers/integrations/python/) on any machine.

  2. Run ddev release build resilience4j to build the package.

  3. Download the Datadog Agent.

  4. Upload the build artifact to any host with an Agent, and run datadog-agent integration install -w path/to/resilience4j/dist/<ARTIFACT_NAME>.whl.

Configuration

  1. Edit the resilience4j/conf.yaml file in the conf.d/ folder at the root of your Agent’s configuration directory to start collecting your Resilience4j performance data. See the sample resilience4j/conf.yaml for all available configuration options.

  2. Restart the Agent.

Validation

Run the Agent’s status subcommand and look for resilience4j under the Checks section.

Data Collected

Metrics

resilience4j.bulkhead.available.concurrent.calls
(gauge)		The number of available permissions
resilience4j.bulkhead.core.thread.pool.size
(gauge)		The core size of the bulkhead thread pool
resilience4j.bulkhead.max.allowed.concurrent.calls
(gauge)		The maximum number of available permissions
resilience4j.bulkhead.max.thread.pool.size
(gauge)		The maximum allowed size of the thread pool
resilience4j.bulkhead.queue.capacity
(gauge)		The maximum allowed size of the queue
resilience4j.bulkhead.queue.depth
(gauge)		The number of tasks in the queue
resilience4j.bulkhead.thread.pool.size
(gauge)		The current size of the thread pool
resilience4j.circuitbreaker.buffered.calls
(gauge)		The number of buffered failed calls stored in the ring buffer
resilience4j.circuitbreaker.calls
(count)		Total number of calls
Shown as unit
resilience4j.circuitbreaker.calls.seconds.bucket
(count)		Sum of number of successful calls
Shown as second
resilience4j.circuitbreaker.calls.seconds.count
(count)		Count of number of successful calls
Shown as second
resilience4j.circuitbreaker.calls.seconds.max
(gauge)		Max of number of successful calls
Shown as second
resilience4j.circuitbreaker.calls.seconds.sum
(count)		Sum of number of successful calls
Shown as second
resilience4j.circuitbreaker.failure.rate
(gauge)		The failure rate of the circuit breaker
resilience4j.circuitbreaker.max.buffered.calls
(gauge)		The maximum number of buffered calls which can be stored in the ring buffer
resilience4j.circuitbreaker.not.permitted.calls
(count)		Total number of not permitted calls
Shown as unit
resilience4j.circuitbreaker.not.permitted.calls.count
(count)		Count of number of not permitted calls
Shown as unit
resilience4j.circuitbreaker.slow.call.rate
(gauge)		The slow call rate of the circuit breaker
resilience4j.circuitbreaker.state
(gauge)		The states of the circuit breaker
resilience4j.ratelimiter.available.permissions
(gauge)		The number of available permissions
resilience4j.ratelimiter.waiting.threads
(gauge)		The number of threads waiting for permission
resilience4j.retry.calls
(gauge)		The number of successful calls without a retry attempt
resilience4j.retry.calls.count
(count)		The number of successful calls without a retry attempt
resilience4j.timelimiter.calls
(count)		Total number of calls which were successful
Shown as unit

Service Checks

resilience4j.openmetrics.health

Returns CRITICAL if the Agent is unable to connect to the Resilience4j OpenMetrics endpoint, otherwise returns OK.

Statuses: ok, critical

Events

Resilience4j does not include any events.

Troubleshooting

Need help? Contact the maintainer of this integration.