Skip to content
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

fix(metrics): metadata and dimensions not cleared on publish #1129

Merged
merged 2 commits into from
Oct 26, 2022
Merged

fix(metrics): metadata and dimensions not cleared on publish #1129

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
761ee46
test(metrics): add tests to cover clearing metadata and dimensions af…
shdq Oct 21, 2022
4600112
fix(metrics): fix metadata and dimensions not cleared on publish
shdq Oct 21, 2022
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: 3 additions & 1 deletion packages/metrics/src/Metrics.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -287,7 +287,9 @@ class Metrics extends Utility implements MetricsInterface {
public publishStoredMetrics(): void {
const target = this.serializeMetrics();
console.log(JSON.stringify(target));
this.storedMetrics = {};
this.clearMetrics();
this.clearDimensions();
this.clearMetadata();
}

/**
Expand Down
56 changes: 56 additions & 0 deletions packages/metrics/tests/unit/Metrics.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,35 @@ describe('Class: Metrics', () => {
expect(loggedData[additionalDimension.name]).toEqual(additionalDimension.value);
});

test('Publish Stored Metrics should clear added dimensions', async () => {
const metrics = new Metrics({ namespace: 'test' });
const dimensionItem = { name: 'dimensionName', value: 'dimensionValue' };

class LambdaFunction implements LambdaInterface {
@metrics.logMetrics()
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-ignore
public handler<TEvent, TResult>(
_event: TEvent,
_context: Context,
_callback: Callback<TResult>,
): void | Promise<TResult> {
metrics.addMetric('test_name_1', MetricUnits.Count, 1);
metrics.addDimension(dimensionItem.name, dimensionItem.value);
metrics.publishStoredMetrics();
}
}

await new LambdaFunction().handler(dummyEvent, dummyContext.helloworldContext, () => console.log('Lambda invoked!'));
const loggedData = [ JSON.parse(consoleSpy.mock.calls[0][0]), JSON.parse(consoleSpy.mock.calls[1][0]) ];

expect(console.log).toBeCalledTimes(2);
expect(loggedData[0][dimensionItem.name]).toEqual(dimensionItem.value);
expect(loggedData[0]._aws.CloudWatchMetrics[0].Dimensions[0].length).toEqual(1);
expect(loggedData[1][dimensionItem.name]).toBeUndefined();
expect(loggedData[1]._aws.CloudWatchMetrics[0].Dimensions[0].length).toEqual(0);
});

test('Adding more than max dimensions should throw error', () => {
expect.assertions(1);
const metrics = new Metrics();
Expand Down Expand Up @@ -144,6 +173,33 @@ describe('Class: Metrics', () => {
expect(loggedData[metadataItem.name]).toEqual(metadataItem.value);
expect(postClearLoggedData[metadataItem.name]).toBeUndefined();
});

test('Publish Stored Metrics should clear metadata', async () => {
const metrics = new Metrics({ namespace: 'test' });
const metadataItem = { name: 'metaName', value: 'metaValue' };

class LambdaFunction implements LambdaInterface {
@metrics.logMetrics()
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-ignore
public handler<TEvent, TResult>(
_event: TEvent,
_context: Context,
_callback: Callback<TResult>,
): void | Promise<TResult> {
metrics.addMetric('test_name_1', MetricUnits.Count, 1);
metrics.addMetadata(metadataItem.name, metadataItem.value);
metrics.publishStoredMetrics();
}
}

await new LambdaFunction().handler(dummyEvent, dummyContext.helloworldContext, () => console.log('Lambda invoked!'));
const loggedData = [ JSON.parse(consoleSpy.mock.calls[0][0]), JSON.parse(consoleSpy.mock.calls[1][0]) ];

expect(console.log).toBeCalledTimes(2);
expect(loggedData[0][metadataItem.name]).toEqual(metadataItem.value);
expect(loggedData[1][metadataItem.name]).toBeUndefined();
});
});

describe('Feature: Default Dimensions', () => {
Expand Down