opensearch-project / dashboards-observability

Visualize and explore your logs, traces and metrics data in OpenSearch Dashboards
https://opensearch.org/docs/latest/observability-plugin/index/
Apache License 2.0
14 stars 51 forks source link

[FEATURE]Support Display Metrics Exemplar #560

Open YANG-DB opened 1 year ago

YANG-DB commented 1 year ago

Is your feature request related to a problem? In the Metrics analytics view, we would like to see data-points that were taken as exemplars and are representation of the aggregation this metrics was build from

What solution would you like?

In order to navigate from metrics (which are an aggregation of data-points) into the traces / logs that are the basis of this metrics (data-points measurements) we would like to visualize the data-points exemplars that are stored along the metrics itself ( along the @time dimension )

Screenshot 2023-06-21 at 9 47 05 AM

The height of bars in the image represent the metrics values on the time axis, the diamond points are representing the exemplary data-points taken within the metrics and are available to review and step-into using the data-point id:

This correlation allows users to further investigate and diagnose issues that are reflected in the metrics values. All the dimensions that are carried by the metrics / exemplars are filterable and may be used to further narrow the correlation

Do you have any additional context?

vamsi-amazon commented 1 year ago

Q: Should we show exemplars by default or will there be a check box.

YANG-DB commented 1 year ago

Linking the exemplars data-points

The exemplars allow a specific trace representative of measurement taken in a given time interval.

The user can hover over the exemplar data-

image (3)

point and see the sampled data point details in a key, value like visual component.

The exemplar fields may be linked to additional resources such as:

Additional Context

nitincd commented 1 year ago

it would be useful if there is a pre-check that only displays exemplars for which related data actually exists in the indices, something like IfExists (trace-id). This would prevent user frustration from clicking on links that go nowhere in the trace interface. This check can also be done at the time of the getExemplars() call.

YANG-DB commented 1 year ago

Q: Should we show exemplars by default or will there be a check box. A: Checkbox was added

Q: add an IfExists (trace-id) to only display exemplars that exist ? A: I think its too complex for this version - lets start with simply assuming is exist - if not we need a detailed error message