Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs on metrics (wiki) are misleading #2538

Closed
hkupty opened this issue Oct 27, 2023 · 1 comment
Closed

Docs on metrics (wiki) are misleading #2538

hkupty opened this issue Oct 27, 2023 · 1 comment
Labels
type: documentation A documentation update

Comments

@hkupty
Copy link

hkupty commented Oct 27, 2023

Bug Report

The metrics page, on micrometer's settings, point out that targetPercentiles default to 50.0, 90.0, 95.0, 99.0, 99.9 as percent values, but this can be interpreted as the input values being on the range of 0.0 to 100.0

Current Behavior

image

Of course setting up the wrong values lead to an error

Input Code

Repo not shared as it is private

Input Code
            val options = MicrometerOptions
                .builder()
                .histogram(true)
                .targetPercentiles(doubleArrayOf(50.0, 95.0, 99.0))
                .build()

Expected behavior/code

Docs show us input value in the actual format they need to be supplied, for example 0.5, 0.9, 0.95, 0.99, 0.999.

Environment

  • Lettuce version(s): 6.1.5.RELEASE
  • Redis version: N/A

Possible Solution

Update the docs

Additional context

If this is described elsewhere, say in a docs/ folder or in a javadoc-style page, it should be linked in the wiki as well.

@mp911de mp911de added the type: documentation A documentation update label Oct 27, 2023
@mp911de
Copy link
Collaborator

mp911de commented Oct 27, 2023

Thanks for the hint. That's fixed now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation A documentation update
Projects
None yet
Development

No branches or pull requests

2 participants