@yugabytedb/perf-advisor-ui

Troubleshoot UI library for Yugabyte applications. Bundled with Vite in library mode and published to npm as an ESM-only package.

install

npm i @yugabytedb/perf-advisor-ui

use

import { PerfAdvisorEntry } from '@yugabytedb/troubleshoot-ui';

<PerfAdvisorEntry universeUuid={universeUuid} timezone={timezone} />;

Need to pass the universeUuid or clusterUuid that is assigned to the current universe or cluster

Pass user time zone so as to show anomalies in the primary dashboard based on the user current time

Selecting the anomaly to view the secondary dashboard will list the main graph which can be viewed in both Overall or Outlier mode

The corresponding RCA graphs will also be listed in secondary dashboard to help user diagnose the issue

Local development

This package is consumed by perf-advisor-web. When iterating on it alongside the host app, use yalc — Vite picks up library changes via the watch-yalc-lib plugin in perf-advisor-web/vite.config.ts.

1. Ensure the node version is v22.18.0 (see engines in package.json).
2. Install dependencies: npm ci.
3. Build once in watch mode: npm run dev (alias for vite build --watch). The build also runs yalc push after each rebuild via the yalc-push plugin, so consumers that have linked this package via yalc receive updates automatically.
4. To consume in perf-advisor-web, follow the yalc setup steps in perf-advisor-web/README.md.

Configuring the backend URL

The library reads REACT_APP_API_URL the same way perf-advisor-web does (src/helpers/config.ts). When the library is used inside perf-advisor-web in dev, the variable is set in the host app's terminal / .env.local — see the host app's README. The library itself doesn't need any env configuration to develop.

Other scripts

• npm run build — production build of the library (NODE_ENV=production vite build) into dist/.
• npm run build:dev — non-minified development build (used before yalc publish).
• npm run typecheck — tsc --noEmit.
• npm run lint / npm run lint:fix.
• npm run format / npm run format:check.

license

The MIT License (MIT) Copyright (c) 2024

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Build and Publish UI

npm run changelog

1. Updates version in package.json
2. Generates a section for adding notes in CHANGELOG file for latest version

npm run release

1. Builds the app for production to the dist folder.
   a. It correctly bundles React in production mode and optimizes the build for the best performance. b. The build is minified and the filenames include the hashes.\
2. Publishes the version to NPM registry using Yugabyte credentials.