Add documentation for custom_values usage in NHCB #16757
Conversation
4506693 to
3429940
Compare
|
Thanks for doing this. However, we do not explain the histogram details in this file anyway, so just explaining NHCB feel out of place. I think we should just extend the documentation in docs/configuration/unit_testing_rules.md , which in referenced in promql/promqltest/README.md . Just adding a line for |
13f8767 to
a857278
Compare
|
Thanks for the clarification. I’ve now moved the change to the correct file and added the custom_values line as you suggested. Let me know if anything else needs updating. |
|
✅ Fixed the indentation for the custom_values field comment. Let me know if there’s anything else you’d like changed! |
|
I think what we have to change is the description of the We need to add the case of -53 and say that in that case upper bucket boundaries are defined in custom_values like for classic histograms and you shouldn't use z_bucket, z_bucket_w, n_buckets, n_offset. |
Signed-off-by: rishi-jat <rishijat098@gmail.com> Signed-off-by: Rishi Jat <rishijat098@gmail.com>
Signed-off-by: Rishi Jat <rishijat098@gmail.com>
Signed-off-by: Rishi Jat <rishijat098@gmail.com>
Signed-off-by: Rishi Jat <rishijat098@gmail.com>
Co-authored-by: George Krajcsovits <krajorama@users.noreply.github.com> Signed-off-by: Rishi Jat <rishijat098@gmail.com>
Co-authored-by: George Krajcsovits <krajorama@users.noreply.github.com> Signed-off-by: Rishi Jat <rishijat098@gmail.com>
Signed-off-by: Rishi Jat <rishijat098@gmail.com>
29f52c7 to
e398fea
Compare
|
I’ve made the changes to the schema field as suggested. Please have a look and let me know if there’s anything else to add. |
|
Hi @krajorama / @roidelapluie, |
Co-authored-by: George Krajcsovits <krajorama@users.noreply.github.com> Signed-off-by: Rishi Jat <rishijat098@gmail.com>
Co-authored-by: George Krajcsovits <krajorama@users.noreply.github.com> Signed-off-by: Rishi Jat <rishijat098@gmail.com>
|
Hi @roidelapluie, just checking in to see if you might have a moment to review this PR. It now includes the changes @krajorama suggested and all checks are passing. Happy to make any further updates if needed. |
This PR updates
docs/configuration/unit_testing_rules.mdto document the usage of thecustom_valuesfield for manually defining native histogram buckets.custom_valuesunder the native histogram formatFixes: #16755