Skip to content

[O11y][Redis Enterprise] Add description for panels #5737

Merged
kush-elastic merged 5 commits intoelastic:mainfrom
rajvi-patel-22:redis-enterprise-dashboard-description
Apr 4, 2023
Merged

[O11y][Redis Enterprise] Add description for panels #5737
kush-elastic merged 5 commits intoelastic:mainfrom
rajvi-patel-22:redis-enterprise-dashboard-description

Conversation

@rajvi-patel-22
Copy link
Copy Markdown
Contributor

@rajvi-patel-22 rajvi-patel-22 commented Mar 29, 2023 •
edited
Loading

  • Bug

What does this PR do?

  • Add panel description in Redis Enterprise migrated panels.
  • The description tooltip doesn't support for lens in Kibana older versions. However, It will be added in Kibana 8.7.

Checklist

  • I have reviewed tips for building integrations and this pull request is aligned with them.
  • I have added an entry to my package's changelog.yml file.
  • I have verified that Kibana version constraints are current according to guidelines.

Author's Checklist

  • Panel descriptions can be viewed and modified in Kibana 8.7.0

Related issues

Screenshots

image (13)

Note: We identified that adding description at embeddableConfig.attributes.description rather than adding at embeddableConfig.description will show tooltip in 8.3.0.

@rajvi-patel-22 rajvi-patel-22 requested a review from a team as a code owner March 29, 2023 14:26
This was referenced Mar 29, 2023
Closed
Closed
@elasticmachine
Copy link
Copy Markdown

elasticmachine commented Mar 29, 2023 •
edited
Loading

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2023-03-31T13:30:22.603+0000

  • Duration: 13 min 43 sec

Test stats 🧪

Test Results
Failed 0
Passed 5
Skipped 0
Total 5

🤖 GitHub comments

Expand to view the GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

@elasticmachine
Copy link
Copy Markdown

elasticmachine commented Mar 29, 2023 •
edited
Loading

🌐 Coverage report

Name Metrics % (covered/total) Diff
Packages 100.0% (0/0) 💚
Files 100.0% (0/0) 💚
Classes 100.0% (0/0) 💚
Methods 50.0% (4/8) 👎 -43.333
Lines 100.0% (0/0) 💚
Conditionals 100.0% (0/0) 💚

@agithomas
Copy link
Copy Markdown
Contributor

agithomas commented Mar 29, 2023

@rajvi-elastic , In the comment, it was mentioned the option to add description is not available in version until 8.6. In the PR, i do not see a kibana version change. Can you re-check on this point and clarify?

@agithomas
Copy link
Copy Markdown
Contributor

agithomas commented Mar 30, 2023

@rajvi-elastic , please link the PR to the redis enterprise migration issue for purpose of ease of tracking

@rajvi-patel-22
Copy link
Copy Markdown
Contributor Author

rajvi-patel-22 commented Mar 30, 2023

@rajvi-elastic , In the comment, it was mentioned the option to add description is not available in version until 8.6. In the PR, i do not see a kibana version change. Can you re-check on this point and clarify?

@agithomas, Do we really want to upgrade Kibana version for this change? Because this change will not cause any issue in older Kibana Version (For eg., 8.3.0 or later versions). Just the tooltip won't appear in the panel. All the other functionalities will work fine.

@agithomas
Copy link
Copy Markdown
Contributor

agithomas commented Mar 31, 2023

@agithomas, Do we really want to upgrade Kibana version for this change? Because this change will not cause any issue in older Kibana Version (For eg., 8.3.0 or later versions). Just the tooltip won't appear in the panel. All the other functionalities will work fine.

I now see that there is no change in the kibana version and hence I am good.

@agithomas
Copy link
Copy Markdown
Contributor

agithomas commented Mar 31, 2023

@SubhrataK , can you please help by discussing with @rajvi-elastic on the missing tool-tip issue , she highlighted and is it an important one and if it is Ok to loose the feature?

@kush-elastic kush-elastic self-requested a review March 31, 2023 06:46
@kush-elastic kush-elastic added Integration:redisenterprise Redis Enterprise bug Something isn't working, use only for issues Team:Service-Integrations Label for the Observability Service Integrations team labels Mar 31, 2023
@SubhrataK
Copy link
Copy Markdown

SubhrataK commented Mar 31, 2023

@rajvi-elastic As discussed, as long as the panel names are meaningful and self explanatory, we can live without the tool tips . Anyhow, this feature is available in later versions of Kibana, so should not be a blocker.

Also, please update the dashboards, with suggestions provided for changing the Titles of each of the panels, so that tool tips are not required.

@rajvi-patel-22
Copy link
Copy Markdown
Contributor Author

rajvi-patel-22 commented Mar 31, 2023

@agithomas, While updating labels in 8.3.0, we identified that adding description at embeddableConfig.attributes.description rather than adding at embeddableConfig.description will show tooltip in 8.3.0.

@milan-elastic
Copy link
Copy Markdown
Contributor

milan-elastic commented Apr 3, 2023

Approved!

kush-elastic
kush-elastic approved these changes Apr 3, 2023
View reviewed changes
Copy link
Copy Markdown
Contributor

@kush-elastic kush-elastic left a comment

Choose a reason for hiding this comment

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

LGTM!

agithomas
agithomas approved these changes Apr 4, 2023
View reviewed changes
Copy link
Copy Markdown
Contributor

@agithomas agithomas left a comment

Choose a reason for hiding this comment

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

LGTM!

@kush-elastic kush-elastic merged commit 235d184 into elastic:main Apr 4, 2023
@elasticmachine
Copy link
Copy Markdown

elasticmachine commented Apr 4, 2023

Package redisenterprise - 0.4.1 containing this change is available at https://epr.elastic.co/search?package=redisenterprise

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

Reviewers

@agithomas agithomas agithomas approved these changes

+1 more reviewer

@kush-elastic kush-elastic kush-elastic approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@rajvi-patel-22 rajvi-patel-22

Labels

bug Something isn't working, use only for issues Integration:redisenterprise Redis Enterprise Team:Service-Integrations Label for the Observability Service Integrations team

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@rajvi-patel-22 @elasticmachine @agithomas @SubhrataK @milan-elastic @kush-elastic