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

[Visualizations] Metrics chart not converting averages properly #152014

Closed
Tracked by #150550
crespocarlos opened this issue Feb 23, 2023 · 8 comments · Fixed by #153389
Closed
Tracked by #150550

[Visualizations] Metrics chart not converting averages properly #152014

crespocarlos opened this issue Feb 23, 2023 · 8 comments · Fixed by #153389
Assignees
Labels
enhancement New value added to drive a business result Feature:Lens impact:medium Addressing this issue will have a medium level of impact on the quality/strength of our product. Team:Visualizations Visualization editors, elastic-charts and infrastructure

Comments

@crespocarlos
Copy link
Contributor

Describe the feature
On the metrics chart type, the average displayed on the bottom right side is not correctly converted to the right unit for large numbers

e.g: 225,092.2T should be 230Pbit instead:

image

The same is not observed with small numbers

image

@crespocarlos crespocarlos added bug Fixes for quality problems that affect the customer experience Team:Visualizations Visualization editors, elastic-charts and infrastructure Feature:Lens labels Feb 23, 2023
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-visualizations @elastic/kibana-visualizations-external (Team:Visualizations)

@stratoula stratoula added the impact:medium Addressing this issue will have a medium level of impact on the quality/strength of our product. label Feb 24, 2023
@dej611
Copy link
Contributor

dej611 commented Feb 24, 2023

Had a quick investigation on this, as it looks a pretty quick fix, but actually found that the problem here is very specific to the Metric visualization and the Bit (1000) format.
In detail, the Metric visualization leverages the EC39 Intl.NumberFormat for a compact representation of the value.

Looking at the list of valid unit values for the bits realm can go up to the terabit option, which is apparently also the higher unit in the UNICODE supported unit list, so even providing the right unit as petabit in the code leads to this JS error:

Uncaught RangeError: Invalid unit argument for Intl.NumberFormat() 'petabit'

My proposal would be to go here with the Numeraljs when using the Bit formatter, at least till the number of supported units in the EC39 standard would increase to include also higher values.

@drewdaemon
Copy link
Contributor

I don't like the complexity of the hybrid approach but if this is a necessary feature I can't think of a better option. 🤷‍♂️

@stratoula
Copy link
Contributor

I am changing this to enhancement

@stratoula stratoula added enhancement New value added to drive a business result and removed bug Fixes for quality problems that affect the customer experience labels Feb 24, 2023
@markov00
Copy link
Member

Looking at the list of valid unit values for the bits realm can go up to the terabit option, which is apparently also the higher unit in the UNICODE supported unit list, so even providing the right unit as petabit in the code leads to this JS

That looks like just an oversight of unicode, the terabyte and terabit exist, then exist petabyte but not petabit...why? :( I don't see a valid reason for that

@drewdaemon
Copy link
Contributor

I agree @markov00 ... very strange.

@dej611
Copy link
Contributor

dej611 commented Feb 28, 2023

Actually I would even use numeral.js even for bytes as the unit support is pretty limited not just for the Bit version, but also for the binary version Bytes.

@dej611
Copy link
Contributor

dej611 commented Mar 1, 2023

Decided to go and use numeral.js here.

@dej611 dej611 self-assigned this Mar 21, 2023
dej611 added a commit that referenced this issue Mar 27, 2023
## Summary

Fixes #152014 

This PR switches the formatter in the Metric visualization type from the
`Intl.NumberFormat` back to the `numeral.js` one which supports more
units for the `bytes` and `bit` format types.

While fixing the referenced issue, this PR also introduced some changes
in how the `bytes` number format is displayed to the user, mainly:

* below the `1024` threshold, the `B` format is used instead of the full
word `bytes` -- see the ⚠️ below
* The `k` for kilo is **not capitalized** when using `bytes` as
[documented for binary values for the entire Kibana
project](https://www.elastic.co/guide/en/kibana/current/numeral.html#_bytes_and_bits)
-- see the ⚠️ below
* The `K` for kilo is **capitalized** when using `bytes` as documented
[documented for binary values for the entire Kibana
project](https://www.elastic.co/guide/en/kibana/current/numeral.html#_bytes_and_bits)

Comparison table

| Raw value  | 8.6 | PR | Changes |
| ------------- | ------------- | ------------- | ------------- |
| 1023 bytes | <img width="320" alt="Screenshot 2023-03-21 at 16 29 09"
src="https://user-images.githubusercontent.com/924948/226687094-eac5b9a3-fc3f-4be5-b400-9e40ab15c92f.png">
| <img width="303" alt="Screenshot 2023-03-21 at 16 27 17"
src="https://user-images.githubusercontent.com/924948/226686883-77c7f79d-6346-4fc3-a401-c25761532598.png">
| ⚠️ |
| 1024 bytes | <img width="322" alt="Screenshot 2023-03-21 at 16 29 17"
src="https://user-images.githubusercontent.com/924948/226687220-38fa6d18-c3d2-4230-ac78-e15e1964d1e0.png">
| <img width="304" alt="Screenshot 2023-03-21 at 16 27 27"
src="https://user-images.githubusercontent.com/924948/226687269-ac250346-d6f7-415c-8d2a-19f057401e4d.png">
| ⚠️ |
| 1024 ^ 2 bytes | <img width="343" alt="Screenshot 2023-03-21 at 16 29
28"
src="https://user-images.githubusercontent.com/924948/226687439-da4fe335-d69e-4115-b728-bcee76f9ba1e.png">
| <img width="308" alt="Screenshot 2023-03-21 at 16 27 39"
src="https://user-images.githubusercontent.com/924948/226687509-29d81baa-25ab-445d-9375-c1c2414f3472.png">
| = |
| 1024 ^ 6 bytes | <img width="323" alt="Screenshot 2023-03-21 at 16 29
36"
src="https://user-images.githubusercontent.com/924948/226687645-8dc4c65f-5eeb-4049-ac94-afbf35bf6d3a.png">
| <img width="304" alt="Screenshot 2023-03-21 at 16 27 47"
src="https://user-images.githubusercontent.com/924948/226687673-2be028f6-ef54-45be-850a-b48d16d8b661.png">
| ✅ |
| 1024 ^ 9 bytes | <img width="324" alt="Screenshot 2023-03-21 at 16 29
45"
src="https://user-images.githubusercontent.com/924948/226687780-88cba5ed-baa6-4c94-9e5b-24efd8970ab5.png">
| <img width="307" alt="Screenshot 2023-03-21 at 16 28 08"
src="https://user-images.githubusercontent.com/924948/226687816-92ff4a72-bfcc-4a0c-92a8-48b0d7a68c5f.png">
| ✅ |
| 999 bits | <img width="327" alt="Screenshot 2023-03-21 at 17 55 12"
src="https://user-images.githubusercontent.com/924948/226687945-6b66ef65-a7e1-4bb1-92e3-038bfe2b40ba.png">
| <img width="308" alt="Screenshot 2023-03-21 at 16 27 00"
src="https://user-images.githubusercontent.com/924948/226688011-cebef661-f2e9-475c-840f-c808fc367965.png">
| ✅ |
| 1000 bits | <img width="333" alt="Screenshot 2023-03-21 at 17 55 04"
src="https://user-images.githubusercontent.com/924948/226688119-e783c243-9269-41ba-a695-a93e0f63afdf.png">
| <img width="302" alt="Screenshot 2023-03-21 at 16 26 52"
src="https://user-images.githubusercontent.com/924948/226688182-08a67dc4-c8e6-4416-83ab-3a4a13eb7904.png">
| ✅ |
| 1000 ^ 2 bits | <img width="329" alt="Screenshot 2023-03-21 at 17 54
54"
src="https://user-images.githubusercontent.com/924948/226688267-f310246d-61bb-4e88-9b14-42a9e49d5b5b.png">
| <img width="317" alt="Screenshot 2023-03-21 at 16 26 40"
src="https://user-images.githubusercontent.com/924948/226688312-fc51bec2-78a1-4f02-89dc-e8d3dcaa8971.png">
| ✅ |
| 1000 ^ 6 bits | <img width="322" alt="Screenshot 2023-03-21 at 16 30
06"
src="https://user-images.githubusercontent.com/924948/226688489-596ec3ee-1d64-407a-a9cc-6d559d312e87.png">
| <img width="295" alt="Screenshot 2023-03-21 at 16 26 25"
src="https://user-images.githubusercontent.com/924948/226688635-0290bc74-f66d-460f-ade8-dbc57b6f7263.png">
| ✅ |
| 1000 ^ 9 bits | <img width="329" alt="Screenshot 2023-03-21 at 16 29
59"
src="https://user-images.githubusercontent.com/924948/226688779-e127440d-bb1a-495e-b3e3-2c3572781517.png">
| <img width="301" alt="Screenshot 2023-03-21 at 16 28 25"
src="https://user-images.githubusercontent.com/924948/226688834-7716e433-6290-4719-b3ec-fef0bd776958.png">
| ✅ |



### Checklist

Delete any items that are not applicable to this PR.

- [ ] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)
- [ ]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
- [ ] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios
- [ ] Any UI touched in this PR is usable by keyboard only (learn more
about [keyboard accessibility](https://webaim.org/techniques/keyboard/))
- [ ] Any UI touched in this PR does not create any new axe failures
(run axe in browser:
[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/),
[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))
- [ ] If a plugin configuration key changed, check if it needs to be
allowlisted in the cloud and added to the [docker
list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)
- [ ] This renders correctly on smaller devices using a responsive
layout. (You can test this [in your
browser](https://www.browserstack.com/guide/responsive-testing-on-local-server))
- [ ] This was checked for [cross-browser
compatibility](https://www.elastic.co/support/matrix#matrix_browsers)


### Risk Matrix

Delete this section if it is not applicable to this PR.

Before closing this PR, invite QA, stakeholders, and other developers to
identify risks that should be tested prior to the change/feature
release.

When forming the risk matrix, consider some of the following examples
and how they may potentially impact the change:

| Risk | Probability | Severity | Mitigation/Notes |

|---------------------------|-------------|----------|-------------------------|
| Multiple Spaces&mdash;unexpected behavior in non-default Kibana Space.
| Low | High | Integration tests will verify that all features are still
supported in non-default Kibana Space and when user switches between
spaces. |
| Multiple nodes&mdash;Elasticsearch polling might have race conditions
when multiple Kibana nodes are polling for the same tasks. | High | Low
| Tasks are idempotent, so executing them multiple times will not result
in logical error, but will degrade performance. To test for this case we
add plenty of unit tests around this logic and document manual testing
procedure. |
| Code should gracefully handle cases when feature X or plugin Y are
disabled. | Medium | High | Unit tests will verify that any feature flag
or plugin combination still results in our service operational. |
| [See more potential risk
examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) |


### For maintainers

- [ ] This was checked for breaking API changes and was [labeled
appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)
@roshan-elastic roshan-elastic changed the title [Lens] Metrics chart not converting averages properly [Visualizations] Metrics chart not converting averages properly Jun 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New value added to drive a business result Feature:Lens impact:medium Addressing this issue will have a medium level of impact on the quality/strength of our product. Team:Visualizations Visualization editors, elastic-charts and infrastructure
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants