Skip to content

Conversation

@florent-leborgne
Copy link
Contributor

@florent-leborgne florent-leborgne commented Oct 24, 2025

Fixes #2543

Here is a draft of a page for metrics charts. Would like reviewers to advise on anything missing and inaccuracies in particular for the settings part where there may be more nuance to add in some places.

Let's finetune what we can and once we have a few different chart pages ready, we can release in small batches

Done:

  • Optimize structure for readability
  • Analyze competition, check discuss forums, test product and check existing materials to decide on optimal content depth
  • Extract best practices from EUI's dataviz guidelines
  • Test current content - doesn't mean the doc is exhaustive, just that what's in there is correctly reflecting the product, there may be more nuance to add edge cases.

Missing:

  • refine examples (various use cases but also various configuration setups) Done
  • visuals for examples Done
  • add some advanced, undocumented options that don't look so simple for defining values Done
  • Remove duplicated content from main Lens page - will do this once we agree with these changes
  • Have doc reviewed for completeness and accuracy

@github-actions
Copy link

github-actions bot commented Oct 24, 2025

🔍 Preview links for changed docs

@florent-leborgne florent-leborgne changed the base branch from main to chart-project-integration-branch October 29, 2025 15:34
@florent-leborgne florent-leborgne changed the base branch from chart-project-integration-branch to main October 29, 2025 15:41
@alaudazzi alaudazzi changed the base branch from main to lens-charts-all October 30, 2025 11:43
Copy link

@teresaalvarezsoler teresaalvarezsoler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @florent-leborgne great progress on this. I just left a few comments.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gvnmagni I don't think this is the green from our palette, is it? can we provide @florent-leborgne the same metric with the right color?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we have the same image but formatted this?
image


![Metric chart representing an SLO](../images/metric-chart.png "=30%")

## When to use metric charts

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed in the issue, let's remove this section entirely :)

* **Static**: Shows the secondary metric as a badge with a single color that you select
* **Dynamic**: Enables both color coding and directional icons based on the comparison

4. Select **Dynamic** coloring. More options appear.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I really think we need a screenshot here it's super difficult to find this option. I spent a lot of time the first time I used this. Until we can fix this problem let's at least document it.

- **Label position**: Choose to show the label **Before** or **After** the metric.
- **Color by value**: Apply colors to the chart. Choose between **None**, **Static** for a unique color and **Dynamic** for using different colors based on the metric's value. This option allows you to use the secondary metric as a comparison point to highlight trends. Refer to [](#metric-trends) for more details.

### Maximum value settings [max-value-options]

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we need a screenshot here too, this is an important setting and not very easy to use


The following examples show various configuration options that you can use for building impactful metrics.

**Executive dashboard KPI**

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's replace this with an O11y example


![Metric showing weekly visits with weekly comparison trend](../images/metric-website-views-weekly-trend-example.png "=70%")

**Sales per day of the week**

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replace this with an observability example

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Page for Metric charts

2 participants