Skip to content

refactor: updating gauge model, radius calculation and exporting handler service #349

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Nov 12, 2020
Merged

refactor: updating gauge model, radius calculation and exporting handler service #349

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bc14e34
refactor: updating radius calculation and exporting handler service
anandtiwary Nov 11, 2020
2f7b1ed
refactor: adding value and thresholds to widget model
anandtiwary Nov 12, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions projects/distributed-tracing/src/public-api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,3 +95,7 @@ export { WaterfallData } from './shared/dashboard/widgets/waterfall/waterfall/wa
// Datasources
export * from './shared/dashboard/widgets/span-detail/data/span-detail-data-source.model';
export * from './shared/dashboard/widgets/trace-detail/data/trace-detail-data-source.model';

// Detail Sheet
export * from './shared/dashboard/interaction/detail-sheet/detail-sheet-interaction.module';
export * from './shared/dashboard/interaction/detail-sheet/detail-sheet-interaction-handler.service';
15 changes: 6 additions & 9 deletions projects/observability/src/shared/components/gauge/gauge.component.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ export class GaugeComponent implements OnChanges {
const radius = this.buildRadius(boundingBox);

return {
origin: this.buildOrigin(boundingBox, radius),
origin: this.buildOrigin(boundingBox),
backgroundArc: this.buildBackgroundArc(radius),
data: this.buildGaugeData(radius, inputData)
};
Expand Down Expand Up @@ -107,23 +107,20 @@ export class GaugeComponent implements OnChanges {
}

private buildRadius(boundingBox: ClientRect): number {
return Math.min(
boundingBox.height - GaugeComponent.GAUGE_AXIS_PADDING,
boundingBox.height / 2 + Math.min(boundingBox.height, boundingBox.width) / 2
);
return Math.min(boundingBox.height - GaugeComponent.GAUGE_AXIS_PADDING, boundingBox.width / 2);
}

private buildOrigin(boundingBox: ClientRect, radius: number): Point {
private buildOrigin(boundingBox: ClientRect): Point {
return {
x: boundingBox.width / 2,
y: radius
y: boundingBox.height - GaugeComponent.GAUGE_AXIS_PADDING
Copy link
Contributor

Choose a reason for hiding this comment

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

We likely want this to center for tall containers, rather than always sit at the bottom of the container

Copy link
Contributor Author

@anandtiwary anandtiwary Nov 12, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

That would create alignment issues imo. By keeping it at the bottom, we can assign appropriate dimension to dash container to keep it aligned with other widgets. Noticed this while adding this gauge to an existing dash. But can sure revisit.

};
}

private calculateInputData(): GaugeInputData | undefined {
if (this.value !== undefined && this.maxValue !== undefined && this.maxValue > 0 && this.thresholds.length > 0) {
const currentThreshold = this.thresholds.find(
threshold => this.value! >= threshold.start && this.value! < threshold.end
threshold => this.value! >= threshold.start && this.value! <= threshold.end
);

if (currentThreshold) {
Expand All @@ -141,7 +138,7 @@ export interface GaugeThreshold {
label: string;
start: number;
end: number;
color: Color;
color: Color | string;
}

interface GaugeSvgRendererData {
Expand Down
27 changes: 12 additions & 15 deletions projects/observability/src/shared/dashboard/widgets/gauge/gauge-widget.model.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,29 +3,17 @@ import { createModelFactory } from '@hypertrace/dashboards/testing';
import { MODEL_PROPERTY_TYPES } from '@hypertrace/hyperdash-angular';
import { runFakeRxjs } from '@hypertrace/test-utils';
import { of } from 'rxjs';
import { GaugeWidgetData } from './gauge-widget';
import { GaugeWidgetModel } from './gauge-widget.model';

describe('Gauge widget model', () => {
test('uses colors from color map', () => {
const modelFactory = createModelFactory();

const data: GaugeWidgetData = {
value: 5,
maxValue: 10,
thresholds: [
{
start: 0,
end: 6,
label: 'Medium',
color: Color.Brown1
}
]
};
const value = 5;

const spectator = modelFactory(GaugeWidgetModel, {
api: {
getData: () => of(data)
getData: () => of(value)
},
providers: [
{
Expand All @@ -34,7 +22,16 @@ describe('Gauge widget model', () => {
}
],
properties: {
title: 'Test Title'
title: 'Test Title',
maxValue: 10,
thresholds: [
{
start: 0,
end: 6,
label: 'Medium',
color: Color.Brown1
}
]
}
});

Expand Down
34 changes: 31 additions & 3 deletions projects/observability/src/shared/dashboard/widgets/gauge/gauge-widget.model.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,16 @@
import { Model, ModelApi, ModelProperty, STRING_PROPERTY } from '@hypertrace/hyperdash';
import {
ARRAY_PROPERTY,
Model,
ModelApi,
ModelProperty,
NUMBER_PROPERTY,
STRING_PROPERTY
} from '@hypertrace/hyperdash';
import { ModelInject, MODEL_API } from '@hypertrace/hyperdash-angular';
import { Observable } from 'rxjs';
import { map } from 'rxjs/operators';
import { GaugeWidgetData } from './gauge-widget';

import { GaugeThresholdModel } from './thresholds/gauge-threshold.model';
@Model({
type: 'gauge-widget'
})
Expand All @@ -13,10 +21,30 @@ export class GaugeWidgetModel {
})
public title?: string;

@ModelProperty({
key: 'max-value',
type: NUMBER_PROPERTY.type,
required: true
})
public maxValue!: number;

@ModelProperty({
key: 'thresholds',
type: ARRAY_PROPERTY.type,
required: true
})
public thresholds!: GaugeThresholdModel[];

@ModelInject(MODEL_API)
private readonly api!: ModelApi;

public getData(): Observable<GaugeWidgetData> {
return this.api.getData<GaugeWidgetData>();
return this.api.getData<number>().pipe(
map(value => ({
value: value,
maxValue: this.maxValue,
thresholds: this.thresholds
}))
);
}
}
34 changes: 34 additions & 0 deletions ...ects/observability/src/shared/dashboard/widgets/gauge/thresholds/gauge-threshold.model.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
import { Model, ModelProperty, NUMBER_PROPERTY, STRING_PROPERTY, UNKNOWN_PROPERTY } from '@hypertrace/hyperdash';

@Model({
type: 'gauge-threshold'
})
export class GaugeThresholdModel {
@ModelProperty({
key: 'start',
type: NUMBER_PROPERTY.type,
required: true
})
public start!: number;

@ModelProperty({
key: 'end',
type: NUMBER_PROPERTY.type,
required: true
})
public end!: number;

@ModelProperty({
key: 'label',
type: STRING_PROPERTY.type,
required: true
})
public label!: string;

@ModelProperty({
key: 'color',
type: UNKNOWN_PROPERTY.type,
required: true
})
public color!: string;
}