elastic/elasticsearch

Improve logging for circuit breakers

Open

#62,452 opened on Sep 16, 2020

View on GitHub
 (8 comments) (0 reactions) (0 assignees)Java (25,882 forks)batch import
:Core/Infra/Circuit Breakers:Core/Infra/Logging>enhancementTeam:Core/Infrahelp wanted

Repository metrics

Stars
 (76,700 stars)
PR merge metrics
 (Avg merge 2d 5h) (1,000 merged PRs in 30d)

Description

Logs should be more detailed about the circuit breaker when tripped.

Existing log example:

"Caused by: org.elasticsearch.common.breaker.CircuitBreakingException: [parent] Data too large, data for [cluster:monitor/nodes/info[n]] would be [33958682092/31.6gb], which is larger than the limit of [32386737766/30.1gb], real usage: [33958603128/31.6gb], new bytes reserved: [78964/77.1kb], usages [request=0/0b, fielddata=0/0b, in_flight_requests=78964/77.1kb, accounting=0/0b]",

Log should include name of circuit breaker that was broken, [parent] is not descriptive enough. Should include information about the request that tripped the circuit breaker. When you have hundreds of requests per second, it is nearly impossible to tell which request or request type tripped the breaker.

Contributor guide

Research direction
Examine the `CircuitBreaker` interface and its implementations in the Elasticsearch source code. The `CircuitBreakingException` is thrown in the `check` method; modify it to include the breaker name and relevant request details from the current search request context.
Tech stack
java
Domain
backendobservability
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70