Skip to content

Commit

Permalink
Split metrics from device resource
Browse files Browse the repository at this point in the history 
Remodel `device` resource and split metrics into `device metrics record`

This reduces the load on the `device` resource when updating device metrics periodically.
device metrics are far less frequently needed than the `device` resource. Thus writing to the heavily used `device` resource should be offloaded to the `device metrics record` resource.

Change-type: major
Signed-off-by: Harald Fischer <[email protected]>
  • Loading branch information
@fisehara
fisehara committed Jul 4, 2023
1 parent 2c19ac6 commit 4b2e937
Show file tree
Hide file tree
Showing 11 changed files with 309 additions and 105 deletions.
24 changes: 16 additions & 8 deletions src/balena-model.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -364,14 +364,6 @@ export interface Device {
public_address: string | null;
ip_address: string | null;
mac_address: string | null;
memory_usage: number | null;
memory_total: number | null;
storage_block_device: string | null;
storage_usage: number | null;
storage_total: number | null;
cpu_usage: number | null;
cpu_temp: number | null;
is_undervolted: boolean;
cpu_id: string | null;
is_running__release: { __id: number } | [Release?] | null;
download_progress: number | null;
Expand Down Expand Up @@ -403,6 +395,7 @@ export interface Device {
service_install?: ServiceInstall[];
installs__image?: ImageInstall[];
installs__application__has__service_name?: ServiceInstall[];
reports__device_metrics_record?: DeviceMetricsRecord[];
}

export interface DeviceEnvironmentVariable {
Expand Down Expand Up @@ -565,6 +558,21 @@ export interface UserHasPublicKey {
title: string;
}

export interface DeviceMetricsRecord {
created_at: DateString;
modified_at: DateString;
id: number;
is_reported_by__device: { __id: number } | [Device];
memory_usage: number | null;
memory_total: number | null;
storage_block_device: string | null;
storage_usage: number | null;
storage_total: number | null;
cpu_usage: number | null;
cpu_temp: number | null;
is_undervolted: boolean;
}

export interface DeviceTypeAlias {
created_at: DateString;
modified_at: DateString;
Expand Down
41 changes: 26 additions & 15 deletions src/balena.sbvr
View file
Original file line number Diff line number Diff line change
Expand Up @@ -316,6 +316,7 @@ Term: cpu architecture
Term: device family
Term: device manufacturer
Term: device type

Term: image
Term: organization
Term: scheduled job run
Expand Down Expand Up @@ -528,21 +529,6 @@ Fact type: device has ip address
Necessity: each device has at most one ip address
Fact type: device has mac address
Necessity: each device has at most one mac address
Fact type: device has memory usage
Necessity: each device has at most one memory usage
Fact type: device has memory total
Necessity: each device has at most one memory total
Fact type: device has storage block device
Necessity: each device has at most one storage block device
Fact type: device has storage usage
Necessity: each device has at most one storage usage
Fact type: device has storage total
Necessity: each device has at most one storage total
Fact type: device has cpu usage
Necessity: each device has at most one cpu usage
Fact type: device has cpu temp
Necessity: each device has at most one cpu temp
Fact type: device is undervolted
Fact type: device has cpu id
Necessity: each device has at most one cpu id
Fact type: device is running release
Expand Down Expand Up @@ -581,6 +567,31 @@ Fact type: device should be managed by release
Necessity: each device should be managed by at most one release


Term: device metrics record

-- device metrics record
Fact type: device metrics record is reported by device
Synonymous Form: device reports device metrics record
Necessity: each device metrics record is reported by exactly one device
Necessity: each device reports exactly one device metrics record

Fact type: device metrics record has memory usage
Necessity: each device metrics record has at most one memory usage
Fact type: device metrics record has memory total
Necessity: each device metrics record has at most one memory total
Fact type: device metrics record has storage block device
Necessity: each device metrics record has at most one storage block device
Fact type: device metrics record has storage usage
Necessity: each device metrics record has at most one storage usage
Fact type: device metrics record has storage total
Necessity: each device metrics record has at most one storage total
Fact type: device metrics record has cpu usage
Necessity: each device metrics record has at most one cpu usage
Fact type: device metrics record has cpu temp
Necessity: each device metrics record has at most one cpu temp
Fact type: device metrics record is undervolted


-- application config variable

Fact type: application config variable has value
Expand Down
1 change: 1 addition & 0 deletions src/features/cascade-delete/hooks.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ setupDeleteCascade('device', {
device_tag: 'device',
image_install: 'device',
service_install: 'device',
device_metrics_record: 'is_reported_by__device',
});

setupDeleteCascade('image', {
Expand Down
4 changes: 3 additions & 1 deletion src/features/device-state/index.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,11 @@ export {
serviceInstallFromImage,
} from './state-get-utils';
export {
metricsPatchFields,
validDeviceMetricsRecordPatchFields,
v2ValidPatchFields,
v2ValidDevicePatchFields,
v3ValidPatchFields,
v3ValidDevicePatchFields,
} from './state-patch-utils';

const gracefulGet = resolveOrDenyDevicesWithStatus(304);
Expand Down
70 changes: 41 additions & 29 deletions src/features/device-state/routes/state-patch-v2.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,12 @@ import { getIP } from '../../../lib/utils';
import type { ImageInstall, PickDeferred } from '../../../balena-model';
import {
shouldUpdateMetrics,
metricsPatchFields,
v2ValidPatchFields,
upsertImageInstall,
deleteOldImageInstalls,
truncateShortTextFields,
StatePatchDeviceMetricsRecordBody,
validDeviceMetricsRecordPatchFields,
v2ValidDevicePatchFields,
} from '../state-patch-utils';
import type { ResolveDeviceInfoCustomObject } from '../middleware';

Expand All @@ -26,7 +27,7 @@ type LocalBody = NonNullable<StatePatchV2Body['local']>;
* These typings should be used as a guide to what should be sent, but cannot be trusted as what actually *is* sent.
*/
export type StatePatchV2Body = {
local?: {
local?: StatePatchDeviceMetricsRecordBody & {
should_be_running__release?: number;
name?: string;
/**
Expand All @@ -46,15 +47,6 @@ export type StatePatchV2Body = {
download_progress?: number | null;
api_port?: number;
api_secret?: string;
memory_usage?: number;
memory_total?: number;
storage_block_device?: string;
storage_usage?: number;
storage_total?: number;
cpu_temp?: number;
cpu_usage?: number;
cpu_id?: string;
is_undervolted?: boolean;
is_on__commit?: string | null;
apps?: Array<{
services?: {
Expand Down Expand Up @@ -139,20 +131,13 @@ export const statePatchV2: RequestHandler = async (req, res) => {
const { apps } = local;

let deviceBody:
| Pick<LocalBody, (typeof v2ValidPatchFields)[number]> & {
| Pick<LocalBody, (typeof v2ValidDevicePatchFields)[number]> & {
is_running__release?: number | null;
} = _.pick(local, v2ValidPatchFields);
let metricsBody: Pick<LocalBody, (typeof metricsPatchFields)[number]> =
_.pick(local, metricsPatchFields);
if (
Object.keys(metricsBody).length > 0 &&
(await shouldUpdateMetrics(uuid))
) {
// If we should force a metrics update then merge the two together and clear `metricsBody` so
// that we don't try to merge it again later
deviceBody = { ...deviceBody, ...metricsBody };
metricsBody = {};
}
} = _.pick(local, v2ValidDevicePatchFields);
const metricsBody: Pick<
LocalBody,
(typeof validDeviceMetricsRecordPatchFields)[number]
> = _.pick(local, validDeviceMetricsRecordPatchFields);

if (local.name != null) {
deviceBody.device_name = local.name;
Expand Down Expand Up @@ -191,15 +176,13 @@ export const statePatchV2: RequestHandler = async (req, res) => {
}
}
}

updateFns.push(async (resinApiTx) => {
if (Object.keys(deviceBody).length > 0) {
if (Object.keys(deviceBody).length > 0) {
updateFns.push(async (resinApiTx) => {
// truncate for resilient legacy compatible device state patch so that supervisors don't fail
// to update b/c of length violation of 255 (SBVR SHORT TEXT type) for ip and mac address.
// sbvr-types does not export SHORT TEXT VARCHAR length 255 to import.
deviceBody = truncateShortTextFields(deviceBody);
// If we're updating anyway then ensure the metrics data is included
deviceBody = { ...deviceBody, ...metricsBody };
await resinApiTx.patch({
resource: 'device',
id: deviceId,
Expand All @@ -208,6 +191,35 @@ export const statePatchV2: RequestHandler = async (req, res) => {
},
body: deviceBody,
});
});
}
}
if (
Object.keys(metricsBody).length > 0 &&
(await shouldUpdateMetrics(uuid))
) {
updateFns.push(async (resinApiTx) => {
const latestDeviceMetricsRecord = await resinApiTx.get({
resource: 'device_metrics_record',
id: { is_reported_by__device: deviceId },
});
if (latestDeviceMetricsRecord == null) {
await resinApiTx.post({
resource: 'device_metrics_record',
id: { is_reported_by__device: deviceId },
body: {
...metricsBody,
},
});
} else {
console.log(
`patch metricsBody:${JSON.stringify(metricsBody, null, 2)}`,
);
await resinApiTx.patch({
resource: 'device_metrics_record',
id: { is_reported_by__device: deviceId },
body: metricsBody,
});
}
});
}
Expand Down
69 changes: 42 additions & 27 deletions src/features/device-state/routes/state-patch-v3.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,14 @@ import {
Release,
} from '../../../balena-model';
import type { Filter } from 'pinejs-client-core';
import { metricsPatchFields, v3ValidPatchFields } from '..';
import { v3ValidDevicePatchFields } from '..';
import {
deleteOldImageInstalls,
upsertImageInstall,
shouldUpdateMetrics,
truncateShortTextFields,
StatePatchDeviceMetricsRecordBody,
validDeviceMetricsRecordPatchFields,
} from '../state-patch-utils';

const { BadRequestError, UnauthorizedError, InternalRequestError } = errors;
Expand All @@ -31,7 +33,7 @@ const { api } = sbvrUtils;
* These typings should be used as a guide to what should be sent, but cannot be trusted as what actually *is* sent.
*/
export type StatePatchV3Body = {
[uuid: string]: {
[uuid: string]: StatePatchDeviceMetricsRecordBody & {
status?: string;
os_version?: string;
os_variant?: string;
Expand All @@ -42,15 +44,7 @@ export type StatePatchV3Body = {
mac_address?: string;
api_port?: number;
api_secret?: string;
memory_usage?: number;
memory_total?: number;
storage_block_device?: string;
storage_usage?: number;
storage_total?: number;
cpu_temp?: number;
cpu_usage?: number;
cpu_id?: string;
is_undervolted?: boolean;

/**
* Used for setting dependent devices as online
*/
Expand Down Expand Up @@ -269,23 +263,14 @@ export const statePatchV3: RequestHandler = async (req, res) => {
let deviceBody:
| Pick<
StatePatchV3Body[string],
(typeof v3ValidPatchFields)[number]
(typeof v3ValidDevicePatchFields)[number]
> & {
is_running__release?: number | null;
} = _.pick(state, v3ValidPatchFields);
let metricsBody: Pick<
} = _.pick(state, v3ValidDevicePatchFields);
const metricsBody: Pick<
StatePatchV3Body[string],
(typeof metricsPatchFields)[number]
> = _.pick(state, metricsPatchFields);
if (
Object.keys(metricsBody).length > 0 &&
(await shouldUpdateMetrics(uuid))
) {
// If we should force a metrics update then merge the two together and clear `metricsBody` so
// that we don't try to merge it again later
deviceBody = { ...deviceBody, ...metricsBody };
metricsBody = {};
}
(typeof validDeviceMetricsRecordPatchFields)[number]
> = _.pick(state, validDeviceMetricsRecordPatchFields);

if (deviceBody.cpu_id != null) {
if (/[^\x20-\x7E]/.test(deviceBody.cpu_id)) {
Expand All @@ -297,7 +282,11 @@ export const statePatchV3: RequestHandler = async (req, res) => {
}
}

if (apps != null || Object.keys(deviceBody).length > 0) {
if (
apps != null ||
Object.keys(deviceBody).length > 0 ||
Object.keys(metricsBody).length > 0
) {
// We lazily fetch the necessary data only if we absolutely must to avoid unnecessary work if it turns out we don't need it
data ??= await fetchData(req, custom, uuids, appReleasesCriteria);
const { images, releasesByAppUuid } = data;
Expand All @@ -321,7 +310,6 @@ export const statePatchV3: RequestHandler = async (req, res) => {
// sbvr-types does not export SHORT TEXT VARCHAR length 255 to import.
deviceBody = truncateShortTextFields(deviceBody);
// If we're updating anyway then ensure the metrics data is included
deviceBody = { ...deviceBody, ...metricsBody };
updateFns.push(async (resinApiTx) => {
await resinApiTx.patch({
resource: 'device',
Expand All @@ -334,6 +322,33 @@ export const statePatchV3: RequestHandler = async (req, res) => {
});
}

if (
Object.keys(metricsBody).length > 0 &&
(await shouldUpdateMetrics(uuid))
) {
updateFns.push(async (resinApiTx) => {
const latestDeviceMetricsRecord = await resinApiTx.get({
resource: 'device_metrics_record',
id: { is_reported_by__device: device.id },
});
if (latestDeviceMetricsRecord == null) {
await resinApiTx.post({
resource: 'device_metrics_record',
body: {
...metricsBody,
...{ is_reported_by__device: device.id },
},
});
} else {
await resinApiTx.patch({
resource: 'device_metrics_record',
id: { is_reported_by__device: device.id },
body: metricsBody,
});
}
});
}

if (apps != null) {
const imgInstalls: Array<{
imageId: number;
Expand Down
Loading

0 comments on commit 4b2e937

Please sign in to comment.