ExternalVendorCode/balena-supervisor
1
0
Fork 0
mirror of https://github.com/balena-os/balena-supervisor.git synced 2025-04-13 22:23:01 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Move definition of maxReportFrequency to the reporting file

Browse Source 
Narrows scope to where it is used, like the new maxMetricsFrequency value.

Change-type: patch
Signed-off-by: Ken Bannister <kb2ma@runbox.com>
This commit is contained in:
Ken Bannister 2022-11-08 10:18:57 -05:00
parent 45d71fa60d
commit c67429f3e1
2 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
src/api-binder/report.ts
View File

@ -22,8 +22,10 @@ let lastReport: DeviceState = {};
let lastReportTime: number = -Infinity;
// Tracks if unable to report the latest state change event.
let stateChangeDeferred: boolean = false;
// How often can we report our state to the server in ms
const maxReportFrequency = 10 * 1000;
// How often can we report metrics to the server in ms; mirrors server setting.
// Metrics are low priority, so less frequent than constants.maxReportFrequency.
// Metrics are low priority, so less frequent than maxReportFrequency.
const maxMetricsFrequency = 300 * 1000;
// TODO: This counter is read by the healthcheck to see if the
@ -80,7 +82,7 @@ async function reportCurrentState(opts: StateReportOpts) {
const getStateAndReport = async () => {
const now = performance.now();
// Only try to report if enough time has elapsed since last report
if (now - lastReportTime >= constants.maxReportFrequency) {
if (now - lastReportTime >= maxReportFrequency) {
const currentState = await deviceState.getCurrentForReport(lastReport);
const stateDiff = prune(shallowDiff(lastReport, currentState, 2));
@ -96,7 +98,7 @@ async function reportCurrentState(opts: StateReportOpts) {
// Not enough time has elapsed since last report
// Delay report until next allowed time
const timeSinceLastReport = now - lastReportTime;
await delay(constants.maxReportFrequency - timeSinceLastReport);
await delay(maxReportFrequency - timeSinceLastReport);
await getStateAndReport();
}
};
@ -138,8 +140,8 @@ function handleRetry(retryInfo: OnFailureInfo) {
/**
* Sends state report to cloud from two sources: 1) state change events and
* 2) timer for metrics. Report frequency is at most constants.maxReportFrequency,
* and metrics is reported at most maxMetricsFrequency.
* 2) timer for metrics. Report frequency is at most maxReportFrequency, and
* metrics is reported at most maxMetricsFrequency.
*/
export async function startReporting() {
// Get configs needed to make a report
@ -155,7 +157,7 @@ export async function startReporting() {
// frequency. Returns true if sent; otherwise false.
const doReport = async (): Promise<boolean> => {
if (!reportPending) {
if (performance.now() - lastReportTime > constants.maxReportFrequency) {
if (performance.now() - lastReportTime > maxReportFrequency) {
reportPending = true;
await reportCurrentState(reportConfigs);
reportPending = false;
@ -198,5 +200,5 @@ export async function startReporting() {
// Start monitoring for changes that do not trigger deviceState events
// Example - device metrics
return recursivelyReport(constants.maxReportFrequency);
return recursivelyReport(maxReportFrequency);
}

2
src/lib/constants.ts
View File

@ -64,8 +64,6 @@ const constants = {
backoffIncrement: 500,
supervisorNetworkSubnet: '10.114.104.0/25',
supervisorNetworkGateway: '10.114.104.1',
// How often can we report our state to the server in ms
maxReportFrequency: 10 * 1000,
// How much of a jitter we can add to our api polling
// (this number is used as an upper bound when generating
// a random jitter)