From 2d37276071e978f6bfebb1dd67ed5802db581371 Mon Sep 17 00:00:00 2001 From: Pedro Gonzalez Gomez Date: Tue, 6 Feb 2024 12:40:11 +0100 Subject: [PATCH] mgr/dashboard: add hardware status summary On the landing page of the Dashboard, add the hardware status summary Fixes:https://tracker.ceph.com/issues/64329 Signed-off-by: Pedro Gonzalez Gomez --- .../mgr/dashboard/controllers/hardware.py | 21 ++++++ .../dashboard/dashboard-v3.component.html | 16 +++- .../dashboard/dashboard-v3.component.ts | 35 ++++++++- .../app/shared/api/hardware.service.spec.ts | 23 ++++++ .../src/app/shared/api/hardware.service.ts | 18 +++++ .../card-row/card-row.component.html | 64 +++++++++++++++- .../card-row/card-row.component.scss | 15 ++++ .../components/card-row/card-row.component.ts | 17 +++++ .../src/app/shared/enum/hardware.enum.ts | 8 ++ .../src/app/shared/pipes/pipes.module.ts | 7 +- .../app/shared/pipes/pluralize.pipe.spec.ts | 8 ++ .../src/app/shared/pipes/pluralize.pipe.ts | 14 ++++ src/pybind/mgr/dashboard/openapi.yaml | 39 ++++++++++ src/pybind/mgr/dashboard/services/hardware.py | 75 +++++++++++++++++++ .../mgr/dashboard/services/orchestrator.py | 8 ++ 15 files changed, 358 insertions(+), 10 deletions(-) create mode 100644 src/pybind/mgr/dashboard/controllers/hardware.py create mode 100644 src/pybind/mgr/dashboard/frontend/src/app/shared/api/hardware.service.spec.ts create mode 100644 src/pybind/mgr/dashboard/frontend/src/app/shared/api/hardware.service.ts create mode 100644 src/pybind/mgr/dashboard/frontend/src/app/shared/enum/hardware.enum.ts create mode 100644 src/pybind/mgr/dashboard/frontend/src/app/shared/pipes/pluralize.pipe.spec.ts create mode 100644 src/pybind/mgr/dashboard/frontend/src/app/shared/pipes/pluralize.pipe.ts create mode 100644 src/pybind/mgr/dashboard/services/hardware.py diff --git a/src/pybind/mgr/dashboard/controllers/hardware.py b/src/pybind/mgr/dashboard/controllers/hardware.py new file mode 100644 index 0000000000000..72550ed195f22 --- /dev/null +++ b/src/pybind/mgr/dashboard/controllers/hardware.py @@ -0,0 +1,21 @@ + +from typing import List, Optional + +from ..services.hardware import HardwareService +from . import APIDoc, APIRouter, EndpointDoc, RESTController +from ._version import APIVersion + + +@APIRouter('/hardware') +@APIDoc("Hardware management API", "Hardware") +class Hardware(RESTController): + + @RESTController.Collection('GET', version=APIVersion.EXPERIMENTAL) + @EndpointDoc("Retrieve a summary of the hardware health status") + def summary(self, categories: Optional[List[str]] = None, hostname: Optional[List[str]] = None): + """ + Get the health status of as many hardware categories, or all of them if none is given + :param categories: The hardware type, all of them by default + :param hostname: The host to retrieve from, all of them by default + """ + return HardwareService.get_summary(categories, hostname) diff --git a/src/pybind/mgr/dashboard/frontend/src/app/ceph/dashboard-v3/dashboard/dashboard-v3.component.html b/src/pybind/mgr/dashboard/frontend/src/app/ceph/dashboard-v3/dashboard/dashboard-v3.component.html index 4c290746b45b1..bad69c50122b6 100644 --- a/src/pybind/mgr/dashboard/frontend/src/app/ceph/dashboard-v3/dashboard/dashboard-v3.component.html +++ b/src/pybind/mgr/dashboard/frontend/src/app/ceph/dashboard-v3/dashboard/dashboard-v3.component.html @@ -56,7 +56,9 @@ link="/hosts" title="Host" summaryType="simplified" - *ngIf="healthData.hosts != null"> + *ngIf="healthData.hosts != null" + [dropdownData]="(isHardwareEnabled$ | async) && (hardwareSummary$ | async)"> + -
+
Cluster
+ +
+
+ + Hardware +
+
diff --git a/src/pybind/mgr/dashboard/frontend/src/app/ceph/dashboard-v3/dashboard/dashboard-v3.component.ts b/src/pybind/mgr/dashboard/frontend/src/app/ceph/dashboard-v3/dashboard/dashboard-v3.component.ts index 3c44bd36a8905..853eed2d695f2 100644 --- a/src/pybind/mgr/dashboard/frontend/src/app/ceph/dashboard-v3/dashboard/dashboard-v3.component.ts +++ b/src/pybind/mgr/dashboard/frontend/src/app/ceph/dashboard-v3/dashboard/dashboard-v3.component.ts @@ -1,8 +1,8 @@ import { Component, OnDestroy, OnInit } from '@angular/core'; import _ from 'lodash'; -import { Observable, Subscription } from 'rxjs'; -import { take } from 'rxjs/operators'; +import { BehaviorSubject, Observable, Subscription, of } from 'rxjs'; +import { switchMap, take } from 'rxjs/operators'; import { HealthService } from '~/app/shared/api/health.service'; import { OsdService } from '~/app/shared/api/osd.service'; @@ -24,6 +24,7 @@ import { PrometheusAlertService } from '~/app/shared/services/prometheus-alert.s import { OrchestratorService } from '~/app/shared/api/orchestrator.service'; import { MgrModuleService } from '~/app/shared/api/mgr-module.service'; import { AlertClass } from '~/app/shared/enum/health-icon.enum'; +import { HardwareService } from '~/app/shared/api/hardware.service'; @Component({ selector: 'cd-dashboard-v3', @@ -69,6 +70,12 @@ export class DashboardV3Component extends PrometheusListHelper implements OnInit telemetryEnabled: boolean; telemetryURL = 'https://telemetry-public.ceph.com/'; origin = window.location.origin; + hardwareHealth: any; + hardwareEnabled: boolean = false; + hasHardwareError: boolean = false; + isHardwareEnabled$: Observable; + hardwareSummary$: Observable; + hardwareSubject = new BehaviorSubject([]); constructor( private summaryService: SummaryService, @@ -80,7 +87,8 @@ export class DashboardV3Component extends PrometheusListHelper implements OnInit public prometheusService: PrometheusService, private mgrModuleService: MgrModuleService, private refreshIntervalService: RefreshIntervalService, - public prometheusAlertService: PrometheusAlertService + public prometheusAlertService: PrometheusAlertService, + private hardwareService: HardwareService ) { super(prometheusService); this.permissions = this.authStorageService.getPermissions(); @@ -89,9 +97,21 @@ export class DashboardV3Component extends PrometheusListHelper implements OnInit ngOnInit() { super.ngOnInit(); + this.isHardwareEnabled$ = this.getHardwareConfig(); + this.hardwareSummary$ = this.hardwareSubject.pipe( + switchMap(() => + this.hardwareService.getSummary().pipe( + switchMap((data: any) => { + this.hasHardwareError = data.host.flawed; + return of(data); + }) + ) + ) + ); this.interval = this.refreshIntervalService.intervalData$.subscribe(() => { this.getHealth(); this.getCapacityCardData(); + if (this.hardwareEnabled) this.hardwareSubject.next([]); }); this.getPrometheusData(this.prometheusService.lastHourDateObject); this.getDetailsCardData(); @@ -163,4 +183,13 @@ export class DashboardV3Component extends PrometheusListHelper implements OnInit trackByFn(index: any) { return index; } + + getHardwareConfig(): Observable { + return this.mgrModuleService.getConfig('cephadm').pipe( + switchMap((resp: any) => { + this.hardwareEnabled = resp?.hw_monitoring; + return of(resp?.hw_monitoring); + }) + ); + } } diff --git a/src/pybind/mgr/dashboard/frontend/src/app/shared/api/hardware.service.spec.ts b/src/pybind/mgr/dashboard/frontend/src/app/shared/api/hardware.service.spec.ts new file mode 100644 index 0000000000000..b9deac3fc8ba9 --- /dev/null +++ b/src/pybind/mgr/dashboard/frontend/src/app/shared/api/hardware.service.spec.ts @@ -0,0 +1,23 @@ +import { HttpClientTestingModule } from '@angular/common/http/testing'; +import { TestBed } from '@angular/core/testing'; + +import { configureTestBed } from '~/testing/unit-test-helper'; +import { HardwareService } from './hardware.service'; + +describe('HardwareService', () => { + let service: HardwareService; + + configureTestBed({ + providers: [HardwareService], + imports: [HttpClientTestingModule] + }); + + beforeEach(() => { + TestBed.configureTestingModule({}); + service = TestBed.inject(HardwareService); + }); + + it('should be created', () => { + expect(service).toBeTruthy(); + }); +}); diff --git a/src/pybind/mgr/dashboard/frontend/src/app/shared/api/hardware.service.ts b/src/pybind/mgr/dashboard/frontend/src/app/shared/api/hardware.service.ts new file mode 100644 index 0000000000000..3238493ebe5ed --- /dev/null +++ b/src/pybind/mgr/dashboard/frontend/src/app/shared/api/hardware.service.ts @@ -0,0 +1,18 @@ +import { HttpClient } from '@angular/common/http'; +import { Injectable } from '@angular/core'; + +@Injectable({ + providedIn: 'root' +}) +export class HardwareService { + baseURL = 'api/hardware'; + + constructor(private http: HttpClient) {} + + getSummary(category: string[] = []): any { + return this.http.get(`${this.baseURL}/summary`, { + params: { categories: category }, + headers: { Accept: 'application/vnd.ceph.api.v0.1+json' } + }); + } +} diff --git a/src/pybind/mgr/dashboard/frontend/src/app/shared/components/card-row/card-row.component.html b/src/pybind/mgr/dashboard/frontend/src/app/shared/components/card-row/card-row.component.html index 4e193717252c3..a1e3e6b0b3711 100644 --- a/src/pybind/mgr/dashboard/frontend/src/app/shared/components/card-row/card-row.component.html +++ b/src/pybind/mgr/dashboard/frontend/src/app/shared/components/card-row/card-row.component.html @@ -1,6 +1,6 @@
  • -
    +
    {{ title }}s
    - + @@ -28,9 +28,22 @@ + + +
    • +
    +
    + +
    + @@ -153,11 +166,23 @@ - + {{ data }} + + + {{ data - dropdownTotalError }} + + + + {{ dropdownTotalError }} + + + @@ -169,3 +194,36 @@ {{ title }}s + + + +
  • +
    +
    + + {{ data.value.total }} + {{ hwNames[data.key] }} + {{ hwNames[data.key] }} + {{ hwNames[data.key] | pluralize }} + +
    + + {{ data.value.ok }} + + + + + {{ data.value.error }} + + + +
    +
    • +     +     diff --git a/src/pybind/mgr/dashboard/frontend/src/app/shared/components/card-row/card-row.component.scss b/src/pybind/mgr/dashboard/frontend/src/app/shared/components/card-row/card-row.component.scss index 29901b832d3a5..f93d6313aac31 100644 --- a/src/pybind/mgr/dashboard/frontend/src/app/shared/components/card-row/card-row.component.scss +++ b/src/pybind/mgr/dashboard/frontend/src/app/shared/components/card-row/card-row.component.scss @@ -2,3 +2,18 @@ border: 0; font-size: 14px; } + +a.dropdown-toggle { + &::after { + border: 0; + content: '\f054'; + font-family: 'ForkAwesome'; + font-size: 1rem; + margin-top: 0.15rem; + transition: transform 0.3s ease-in-out; + } + + &[aria-expanded='true']::after { + transform: rotate(90deg); + } +} diff --git a/src/pybind/mgr/dashboard/frontend/src/app/shared/components/card-row/card-row.component.ts b/src/pybind/mgr/dashboard/frontend/src/app/shared/components/card-row/card-row.component.ts index 90c939160eb91..d977e905f531c 100644 --- a/src/pybind/mgr/dashboard/frontend/src/app/shared/components/card-row/card-row.component.ts +++ b/src/pybind/mgr/dashboard/frontend/src/app/shared/components/card-row/card-row.component.ts @@ -1,5 +1,6 @@ import { Component, Input, OnChanges } from '@angular/core'; import { Icons } from '~/app/shared/enum/icons.enum'; +import { HardwareNameMapping } from '~/app/shared/enum/hardware.enum'; @Component({ selector: 'cd-card-row', @@ -19,8 +20,14 @@ export class CardRowComponent implements OnChanges { @Input() summaryType = 'default'; + @Input() + dropdownData: any; + + hwNames = HardwareNameMapping; icons = Icons; total: number; + dropdownTotalError: number = 0; + dropdownToggled: boolean = false; ngOnChanges(): void { if (this.data.total || this.data.total === 0) { @@ -30,5 +37,15 @@ export class CardRowComponent implements OnChanges { } else { this.total = this.data; } + + if (this.dropdownData) { + if (this.title == 'Host') { + this.dropdownTotalError = this.dropdownData.host.flawed; + } + } + } + + toggleDropdown(): void { + this.dropdownToggled = !this.dropdownToggled; } } diff --git a/src/pybind/mgr/dashboard/frontend/src/app/shared/enum/hardware.enum.ts b/src/pybind/mgr/dashboard/frontend/src/app/shared/enum/hardware.enum.ts new file mode 100644 index 0000000000000..7956dfa5d7c00 --- /dev/null +++ b/src/pybind/mgr/dashboard/frontend/src/app/shared/enum/hardware.enum.ts @@ -0,0 +1,8 @@ +export enum HardwareNameMapping { + memory = 'Memory', + storage = 'Drive', + processors = 'CPU', + network = 'Network', + power = 'Power supply', + fans = 'Fan module' +} diff --git a/src/pybind/mgr/dashboard/frontend/src/app/shared/pipes/pipes.module.ts b/src/pybind/mgr/dashboard/frontend/src/app/shared/pipes/pipes.module.ts index b5267aa71216d..53f8f9f309f49 100755 --- a/src/pybind/mgr/dashboard/frontend/src/app/shared/pipes/pipes.module.ts +++ b/src/pybind/mgr/dashboard/frontend/src/app/shared/pipes/pipes.module.ts @@ -37,6 +37,7 @@ import { TruncatePipe } from './truncate.pipe'; import { UpperFirstPipe } from './upper-first.pipe'; import { OctalToHumanReadablePipe } from './octal-to-human-readable.pipe'; import { PathPipe } from './path.pipe'; +import { PluralizePipe } from './pluralize.pipe'; @NgModule({ imports: [CommonModule], @@ -76,7 +77,8 @@ import { PathPipe } from './path.pipe'; MdsSummaryPipe, OsdSummaryPipe, OctalToHumanReadablePipe, - PathPipe + PathPipe, + PluralizePipe ], exports: [ ArrayPipe, @@ -114,7 +116,8 @@ import { PathPipe } from './path.pipe'; MdsSummaryPipe, OsdSummaryPipe, OctalToHumanReadablePipe, - PathPipe + PathPipe, + PluralizePipe ], providers: [ ArrayPipe, diff --git a/src/pybind/mgr/dashboard/frontend/src/app/shared/pipes/pluralize.pipe.spec.ts b/src/pybind/mgr/dashboard/frontend/src/app/shared/pipes/pluralize.pipe.spec.ts new file mode 100644 index 0000000000000..72ba02025a93f --- /dev/null +++ b/src/pybind/mgr/dashboard/frontend/src/app/shared/pipes/pluralize.pipe.spec.ts @@ -0,0 +1,8 @@ +import { PluralizePipe } from './pluralize.pipe'; + +describe('PluralizePipe', () => { + it('create an instance', () => { + const pipe = new PluralizePipe(); + expect(pipe).toBeTruthy(); + }); +}); diff --git a/src/pybind/mgr/dashboard/frontend/src/app/shared/pipes/pluralize.pipe.ts b/src/pybind/mgr/dashboard/frontend/src/app/shared/pipes/pluralize.pipe.ts new file mode 100644 index 0000000000000..c4035ad28499d --- /dev/null +++ b/src/pybind/mgr/dashboard/frontend/src/app/shared/pipes/pluralize.pipe.ts @@ -0,0 +1,14 @@ +import { Pipe, PipeTransform } from '@angular/core'; + +@Pipe({ + name: 'pluralize' +}) +export class PluralizePipe implements PipeTransform { + transform(value: string): string { + if (value.endsWith('y')) { + return value.slice(0, -1) + 'ies'; + } else { + return value + 's'; + } + } +} diff --git a/src/pybind/mgr/dashboard/openapi.yaml b/src/pybind/mgr/dashboard/openapi.yaml index ad4d379fffbbe..23d8a66013b64 100644 --- a/src/pybind/mgr/dashboard/openapi.yaml +++ b/src/pybind/mgr/dashboard/openapi.yaml @@ -4715,6 +4715,43 @@ paths: - jwt: [] tags: - Grafana + /api/hardware/summary: + get: + description: "\n Get the health status of as many hardware categories,\ + \ or all of them if none is given\n :param categories: The hardware\ + \ type, all of them by default\n :param hostname: The host to retrieve\ + \ from, all of them by default\n " + parameters: + - allowEmptyValue: true + in: query + name: categories + schema: + type: string + - allowEmptyValue: true + in: query + name: hostname + schema: + type: string + responses: + '200': + content: + application/vnd.ceph.api.v0.1+json: + type: object + description: OK + '400': + description: Operation exception. Please check the response body for details. + '401': + description: Unauthenticated access. Please login first. + '403': + description: Unauthorized access. Please check your permissions. + '500': + description: Unexpected error. Please check the response body for the stack + trace. + security: + - jwt: [] + summary: Retrieve a summary of the hardware health status + tags: + - Hardware /api/health/full: get: parameters: [] @@ -14029,6 +14066,8 @@ tags: name: FeatureTogglesEndpoint - description: Grafana Management API name: Grafana +- description: Hardware management API + name: Hardware - description: Display Detailed Cluster health Status name: Health - description: Get Host Details diff --git a/src/pybind/mgr/dashboard/services/hardware.py b/src/pybind/mgr/dashboard/services/hardware.py new file mode 100644 index 0000000000000..df2266443388d --- /dev/null +++ b/src/pybind/mgr/dashboard/services/hardware.py @@ -0,0 +1,75 @@ + + +from typing import Any, Dict, List, Optional + +from ..exceptions import DashboardException +from ..services.orchestrator import OrchClient + + +class HardwareService(object): + + @staticmethod + def get_summary(categories: Optional[List[str]] = None, + hostname: Optional[List[str]] = None): + total_count = {'total': 0, 'ok': 0, 'error': 0} + + output: Dict[str, Any] = { + 'total': { + 'category': {}, + 'total': {} + }, + 'host': { + 'flawed': 0 + } + } + + categories = HardwareService.validate_categories(categories) + + orch_hardware_instance = OrchClient.instance().hardware + for category in categories: + data = orch_hardware_instance.common(category, hostname) + category_total = { + 'total': sum(len(items) for items in data.values()), + 'ok': sum(item['status']['health'] == 'OK' for items in data.values() + for item in items.values()), + 'error': 0 + } + + for host, items in data.items(): + output['host'].setdefault(host, {'flawed': False}) + if not output['host'][host]['flawed']: + output['host'][host]['flawed'] = any( + item['status']['health'] != 'OK' for item in items.values()) + + category_total['error'] = category_total['total'] - category_total['ok'] + output['total']['category'].setdefault(category, {}) + output['total']['category'][category] = category_total + + total_count['total'] += category_total['total'] + total_count['ok'] += category_total['ok'] + total_count['error'] += category_total['error'] + + output['total']['total'] = total_count + + output['host']['flawed'] = sum(1 for host in output['host'] + if host != 'flawed' and output['host'][host]['flawed']) + + return output + + @staticmethod + def validate_categories(categories: Optional[List[str]]) -> List[str]: + categories_list = ['memory', 'storage', 'processors', + 'network', 'power', 'fans'] + + if isinstance(categories, str): + categories = [categories] + elif categories is None: + categories = categories_list + elif not isinstance(categories, list): + raise DashboardException(msg=f'{categories} is not a list', + component='Hardware') + if not all(item in categories_list for item in categories): + raise DashboardException(msg=f'Invalid category, there is no {categories}', + component='Hardware') + + return categories diff --git a/src/pybind/mgr/dashboard/services/orchestrator.py b/src/pybind/mgr/dashboard/services/orchestrator.py index e49ab80bfc5dc..97776dec335c3 100644 --- a/src/pybind/mgr/dashboard/services/orchestrator.py +++ b/src/pybind/mgr/dashboard/services/orchestrator.py @@ -200,6 +200,13 @@ class UpgradeManager(ResourceManager): return self.api.upgrade_stop() +class HardwareManager(ResourceManager): + + @wait_api_result + def common(self, category: str, hostname: Optional[List[str]] = None) -> str: + return self.api.node_proxy_common(category, hostname=hostname) + + class OrchClient(object): _instance = None @@ -220,6 +227,7 @@ class OrchClient(object): self.osds = OsdManager(self.api) self.daemons = DaemonManager(self.api) self.upgrades = UpgradeManager(self.api) + self.hardware = HardwareManager(self.api) def available(self, features: Optional[List[str]] = None) -> bool: available = self.status()['available'] -- 2.39.5