micrometer-metrics/micrometer

Document metrics that need to close the MeterBinder

Open

#4,624 opened on Jan 17, 2020

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Java (4,220 stars) (935 forks)batch import
doc-updatehelp wantedmodule: micrometer-core

Description

See https://github.com/micrometer-metrics/micrometer/issues/1492#issuecomment-574535110

Contributor guide

Tech stack
java
Domain
documentationbackend
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
mostly clear
Prerequisites
JavaMicrometer basicsMeterBinder concept
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
Review the referenced comment in issue #1492 to identify which metrics require closing a MeterBinder. Then locate the appropriate documentation files in the micrometer repository, likely under the `micrometer core/src/main/java/io/micrometer/core/instrument/binder` directory, and add documentation explaining the need to close those MeterBinders.