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

feat: [UIE-7995] DBaaS Monitor GA #11105

Merged
merged 1 commit into from
Oct 17, 2024

Conversation

smans-akamai
Copy link
Contributor

@smans-akamai smans-akamai commented Oct 15, 2024

Description 📝

Adding Monitor tab to the database details view.

Changes 🔄

List any change relevant to the reviewer.

  • Added Monitor tab and page to Database Details
  • Added ability to include chip for TabLinkList

Target release date 🗓️

10/28/24

Preview 📷

Before After
details-before details-after

How to test 🧪

Prerequisites

(How to setup test environment)

  • Have dbaasV2MonitorMetrics feature flag enabled and beta as true
  • Have new database clusters available

Verification steps

(How to verify changes)

  • Navigate to the Databases tab
  • Access the details of a new database cluster
  • View that the new Monitor tab is displayed with a beta chip
  • Click the new monitor tab
  • Observe the dashboard that appears on the page

As an Author I have considered 🤔

Check all that apply

  • 👀 Doing a self review
  • ❔ Our contribution guidelines
  • 🤏 Splitting feature into small PRs
  • ➕ Adding a changeset
  • 🧪 Providing/Improving test coverage
  • 🔐 Removing all sensitive information from the code and PR description
  • 🚩 Using a feature flag to protect the release
  • 👣 Providing comprehensive reproduction steps
  • 📑 Providing or updating our documentation
  • 🕛 Scheduling a pair reviewing session
  • 📱 Providing mobile support
  • ♿ Providing accessibility support

Commit message and pull request title format standards

Note: Remove this section before opening the pull request
Make sure your PR title and commit message on squash and merge are as shown below

<commit type>: [JIRA-ticket-number] - <description>

Commit Types:

  • feat: New feature for the user (not a part of the code, or ci, ...).
  • fix: Bugfix for the user (not a fix to build something, ...).
  • change: Modifying an existing visual UI instance. Such as a component or a feature.
  • refactor: Restructuring existing code without changing its external behavior or visual UI. Typically to improve readability, maintainability, and performance.
  • test: New tests or changes to existing tests. Does not change the production code.
  • upcoming: A new feature that is in progress, not visible to users yet, and usually behind a feature flag.

Example: feat: [M3-1234] - Allow user to view their login history


@smans-akamai smans-akamai requested a review from a team as a code owner October 15, 2024 20:18
@smans-akamai smans-akamai requested review from bnussman-akamai and abailly-akamai and removed request for a team October 15, 2024 20:18
@smans-akamai smans-akamai force-pushed the UIE-7995-dbaas-monitor branch from f2ebf9a to 86173d2 Compare October 15, 2024 20:23
@bnussman-akamai bnussman-akamai added the DBaaS Relates to Database as a Service label Oct 15, 2024

export const DatabaseMonitor = ({ database }: Props) => {
const databaseId = database?.id;
const dbaasDashboardId = 1;
Copy link
Contributor

Choose a reason for hiding this comment

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

What is this constant here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is the dashboard ID we need to use access data for DBaaS with the CloudPulseDashboardWithFilters component. There was a discussion on the ticket UIE-7995.

It's always supposed to be 1, so I stored in a variable for context, but can remove it and have it in the template instead if that's preferred.

Copy link
Contributor

Choose a reason for hiding this comment

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

I can't imagine each service that's onboarded will need to hardcode their dashboard Id, should this be coming from the API? cc: @venkymano-akamai

Choose a reason for hiding this comment

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

@jaalah-akamai Yes!!, we do have an API for listing dashboards, specifically the ACLP */dashboards API, which currently returns multiple dashboard IDs for both standard and custom dashboards. To identify the primary dashboard when there are multiple standard dashboards for a service, we may need to enhance the API to make that distinction.
As of now, for DBaaS, there's only one standard dashboard provisioned, so the team can use the /dashboards API to fetch the dashboard ID without issues. However, if additional standard dashboards are added in the future, this approach may become problematic.
For now, it is acceptable to use a hardcoded dashboard ID, as it will be manually provided during the service onboarding process to ACLP through the ACLP onboarding template.
Alternatively, as a second enhancement option, we could modify the ACLP reusable dashboard component to accept an additional service type parameter. Based on this parameter, the component would automatically fetch the primary dashboard for the specified service type.
Both options require some level of enhancement, and we can decide which approach to take based on product decisions. Thanks for the suggestion.

@cpathipa cpathipa requested review from cpathipa and removed request for bnussman-akamai and abailly-akamai October 16, 2024 13:39
@smans-akamai smans-akamai force-pushed the UIE-7995-dbaas-monitor branch 2 times, most recently from 8bef13f to ebabf10 Compare October 16, 2024 13:45
Copy link

Coverage Report:
Base Coverage: 86.96%
Current Coverage: 86.96%

@smans-akamai smans-akamai force-pushed the UIE-7995-dbaas-monitor branch from ebabf10 to 7bc29a6 Compare October 17, 2024 15:15
@jaalah-akamai jaalah-akamai added the Add'tl Approval Needed Waiting on another approval! label Oct 17, 2024
Copy link
Contributor

@cpathipa cpathipa left a comment

Choose a reason for hiding this comment

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

LGTM!

@cpathipa cpathipa merged commit 5e54d46 into linode:develop Oct 17, 2024
22 of 23 checks passed
Copy link

cypress bot commented Oct 17, 2024

Cloud Manager E2E    Run #6695

Run Properties:  status check passed Passed #6695  •  git commit 5e54d46a76: feat: [UIE-7995] DBaaS Monitor GA (#11105)
Project Cloud Manager E2E
Run status status check passed Passed #6695
Run duration 27m 24s
Commit git commit 5e54d46a76: feat: [UIE-7995] DBaaS Monitor GA (#11105)
Committer smans-akamai
View all properties for this run ↗︎

Test results
Tests that failed  Failures 0
Tests that were flaky  Flaky 5
Tests that did not run due to a developer annotating a test with .skip  Pending 2
Tests that did not run due to a failure in a mocha hook  Skipped 0
Tests that passed  Passing 437

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Add'tl Approval Needed Waiting on another approval! DBaaS Relates to Database as a Service Ready for Review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants