Skip to content

Commit b890321

Browse files
KatieArmstrKatieArmstr
committed
fix: make logging consistent
1 parent 2f49e4e commit b890321

File tree

9 files changed

+44
-44
lines changed

9 files changed

+44
-44
lines changed

‎src/index.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,15 @@ import { setSnykMonitorAgentId } from './supervisor/agent';
1313
import { scrapeData } from './data-scraper';
1414
import { setupHealthCheck } from './healthcheck';
1515

16-
process.on('uncaughtException', (err) => {
16+
process.on('uncaughtException', (error) => {
1717
if (state.shutdownInProgress) {
1818
return;
1919
}
2020

2121
try {
22-
logger.error({ err }, 'UNCAUGHT EXCEPTION!');
22+
logger.error({ error }, 'UNCAUGHT EXCEPTION!');
2323
} catch (ignore) {
24-
console.log('UNCAUGHT EXCEPTION!', err);
24+
console.log('UNCAUGHT EXCEPTION!', error);
2525
} finally {
2626
process.exit(1);
2727
}

‎src/scanner/images/credentials.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -77,11 +77,11 @@ export function ecrRegionFromFullImageName(imageFullName: string): string {
7777
throw new Error('ECR image full name in unexpected format');
7878
}
7979
return parts[3];
80-
} catch (err) {
80+
} catch (error) {
8181
logger.error(
82-
{ err, imageFullName },
82+
{ error, imageFullName },
8383
'failed extracting ECR region from image full name',
8484
);
85-
throw err;
85+
throw error;
8686
}
8787
}

‎src/scanner/images/index.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -138,9 +138,9 @@ export async function scanImages(
138138
telemetry.imageSizeBytes = 0;
139139
}
140140
telemetry.imageSizeBytes += fileStats.size;
141-
} catch (err) {
141+
} catch (error) {
142142
logger.warn(
143-
{ error: err, imageName, imageWithDigest, fileSystemPath },
143+
{ error, imageName, imageWithDigest, fileSystemPath },
144144
'could not determine archive size',
145145
);
146146
}

‎src/scanner/index.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ export function getUniqueImages(workloadMetadata: IWorkload[]): IScanImage[] {
8282
logger.info(
8383
{
8484
workloadName: workloadMetadata[0].name,
85-
name: meta.imageName,
85+
imageName: meta.imageName,
8686
id: meta.imageId,
8787
},
8888
'image metadata',

‎src/supervisor/agent.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ async function getSnykMonitorDeploymentUid(
2727
return attemptedApiCall.body.metadata?.uid;
2828
} catch (error) {
2929
logger.error(
30-
{ error, namespace, name },
30+
{ error, namespace, deploymentName: name },
3131
'could not read the snyk-monitor deployment unique id',
3232
);
3333
return undefined;

‎src/supervisor/metadata-extractor.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,8 +109,8 @@ async function findParentWorkload(
109109
if (err?.response?.body?.code === 404) {
110110
logger.info(
111111
{
112-
name: supportedWorkload.name,
113-
kind: supportedWorkload.kind,
112+
supportedWorkloadName: supportedWorkload.name,
113+
supportedWorkloadKind: supportedWorkload.kind,
114114
namespace,
115115
},
116116
'could not find workload, it probably no longer exists',

‎src/supervisor/watchers/handlers/index.ts‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -87,12 +87,12 @@ export async function setupNamespacedInformer(
8787
return await kubernetesApiWrappers.retryKubernetesApiRequest(() =>
8888
listMethod(),
8989
);
90-
} catch (err) {
90+
} catch (error) {
9191
logger.error(
92-
{ ...logContext, err },
92+
{ ...logContext, error },
9393
'error while listing workloads in namespace',
9494
);
95-
throw err;
95+
throw error;
9696
}
9797
};
9898

@@ -102,9 +102,9 @@ export async function setupNamespacedInformer(
102102
loggedListMethod,
103103
);
104104

105-
informer.on(ERROR, (err) => {
105+
informer.on(ERROR, (error) => {
106106
// Types from client library insists that callback is of type KubernetesObject
107-
const code = (err as any).code || '';
107+
const code = (error as any).code || '';
108108
logContext.code = code;
109109
if (RETRYABLE_NETWORK_ERRORS.includes(code)) {
110110
logger.debug(logContext, 'informer error occurred, restarting informer');
@@ -115,7 +115,7 @@ export async function setupNamespacedInformer(
115115
}, 1000);
116116
} else {
117117
logger.error(
118-
{ ...logContext, err },
118+
{ ...logContext, error },
119119
'unexpected informer error event occurred',
120120
);
121121
}
@@ -130,7 +130,7 @@ export async function setupNamespacedInformer(
130130
(watchedWorkload.metadata && watchedWorkload.metadata.name) ||
131131
FALSY_WORKLOAD_NAME_MARKER;
132132
logger.warn(
133-
{ ...logContext, error, name },
133+
{ ...logContext, error, workloadName: name },
134134
'could not execute the namespaced informer handler for a workload',
135135
);
136136
}
@@ -162,12 +162,12 @@ export async function setupClusterInformer(
162162
return await kubernetesApiWrappers.retryKubernetesApiRequest(() =>
163163
listMethod(),
164164
);
165-
} catch (err) {
165+
} catch (error) {
166166
logger.error(
167-
{ ...logContext, err },
167+
{ ...logContext, error },
168168
'error while listing workloads in cluster',
169169
);
170-
throw err;
170+
throw error;
171171
}
172172
};
173173

@@ -177,9 +177,9 @@ export async function setupClusterInformer(
177177
loggedListMethod,
178178
);
179179

180-
informer.on(ERROR, (err) => {
180+
informer.on(ERROR, (error) => {
181181
// Types from client library insists that callback is of type KubernetesObject
182-
const code = (err as any).code || '';
182+
const code = (error as any).code || '';
183183
logContext.code = code;
184184
if (RETRYABLE_NETWORK_ERRORS.includes(code)) {
185185
logger.debug(logContext, 'informer error occurred, restarting informer');
@@ -190,7 +190,7 @@ export async function setupClusterInformer(
190190
}, 1000);
191191
} else {
192192
logger.error(
193-
{ ...logContext, err },
193+
{ ...logContext, error },
194194
'unexpected informer error event occurred',
195195
);
196196
}
@@ -209,7 +209,7 @@ export async function setupClusterInformer(
209209
(watchedWorkload.metadata && watchedWorkload.metadata.name) ||
210210
FALSY_WORKLOAD_NAME_MARKER;
211211
logger.warn(
212-
{ ...logContext, error, name },
212+
{ ...logContext, error, workloadName: name },
213213
'could not execute the cluster informer handler for a workload',
214214
);
215215
}

‎src/supervisor/watchers/handlers/namespace.ts‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,12 @@ export async function trackNamespaces(): Promise<void> {
3939
const loggedListMethod = async () => {
4040
try {
4141
return await retryKubernetesApiRequest(() => paginatedNamespaceList());
42-
} catch (err) {
42+
} catch (error) {
4343
logger.error(
44-
{ ...logContext, err },
44+
{ ...logContext, error },
4545
'error while listing namespaces in cluster',
4646
);
47-
throw err;
47+
throw error;
4848
}
4949
};
5050

@@ -57,9 +57,9 @@ export async function trackNamespaces(): Promise<void> {
5757
informer.on(ADD, storeNamespace);
5858
informer.on(UPDATE, storeNamespace);
5959
informer.on(DELETE, deleteNamespace);
60-
informer.on(ERROR, (err) => {
60+
informer.on(ERROR, (error) => {
6161
// Types from client library insists that callback is of type KubernetesObject
62-
const code = (err as any).code || '';
62+
const code = (error as any).code || '';
6363
logContext.code = code;
6464
if (RETRYABLE_NETWORK_ERRORS.includes(code)) {
6565
logger.debug(logContext, 'informer error occurred, restarting informer');
@@ -70,7 +70,7 @@ export async function trackNamespaces(): Promise<void> {
7070
}, 1000);
7171
} else {
7272
logger.error(
73-
{ ...logContext, err },
73+
{ ...logContext, error },
7474
'unexpected informer error event occurred',
7575
);
7676
}
@@ -107,9 +107,9 @@ export async function trackNamespace(namespace: string): Promise<void> {
107107
body: list,
108108
};
109109
});
110-
} catch (err) {
111-
logger.error({ ...logContext, err }, 'error while listing namespace');
112-
throw err;
110+
} catch (error) {
111+
logger.error({ ...logContext, error }, 'error while listing namespace');
112+
throw error;
113113
}
114114
};
115115

@@ -122,9 +122,9 @@ export async function trackNamespace(namespace: string): Promise<void> {
122122
informer.on(ADD, storeNamespace);
123123
informer.on(UPDATE, storeNamespace);
124124
informer.on(DELETE, deleteNamespace);
125-
informer.on(ERROR, (err) => {
125+
informer.on(ERROR, (error) => {
126126
// Types from client library insists that callback is of type KubernetesObject
127-
const code = (err as any).code || '';
127+
const code = (error as any).code || '';
128128
logContext.code = code;
129129
if (RETRYABLE_NETWORK_ERRORS.includes(code)) {
130130
logger.debug(logContext, 'informer error occurred, restarting informer');
@@ -135,7 +135,7 @@ export async function trackNamespace(namespace: string): Promise<void> {
135135
}, 1000);
136136
} else {
137137
logger.error(
138-
{ ...logContext, err },
138+
{ ...logContext, error },
139139
'unexpected informer error event occurred',
140140
);
141141
}

‎src/supervisor/watchers/handlers/queue.ts‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ export async function deleteWorkloadFromScanQueue(workload: {
2727
);
2828
}
2929

30-
workloadsToScanQueue.error(function (err, task) {
30+
workloadsToScanQueue.error(function (error, task) {
3131
logger.error(
32-
{ err, task },
32+
{ error, task },
3333
'error processing a workload in the pod handler 1',
3434
);
3535
});
@@ -47,9 +47,9 @@ async function queueWorkerWorkloadScan(
4747
};
4848
try {
4949
await processWorkload(workloadMetadata, telemetry);
50-
} catch (err) {
50+
} catch (error) {
5151
logger.error(
52-
{ err, task },
52+
{ error, task },
5353
'error processing a workload in the pod handler 2',
5454
);
5555
const imageIds = workloadMetadata.map((workload) => workload.imageId);
@@ -67,8 +67,8 @@ function reportQueueSize(): void {
6767
const queueDataToReport: { [key: string]: any } = {};
6868
queueDataToReport.workloadsToScanLength = workloadsToScanQueue.length();
6969
logger.debug(queueDataToReport, 'queue sizes report');
70-
} catch (err) {
71-
logger.debug({ err }, 'failed logging queue sizes');
70+
} catch (error) {
71+
logger.debug({ error }, 'failed logging queue sizes');
7272
}
7373
}
7474

0 commit comments

Comments
 (0)