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(sdk-metrics): InMemoryMetricExporter clear metrics after shutdown #5214

Merged
merged 4 commits into from
Jan 7, 2025
Merged

fix(sdk-metrics): InMemoryMetricExporter clear metrics after shutdown #5214

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c91f1d7
fix(sdk-metrics): InMemoryMetricExporter clear metrics after shutdown
paper2 Nov 27, 2024
70d0935
Merge branch 'next' of github.com:open-telemetry/opentelemetry-js int…
paper2 Dec 7, 2024
fd7a69b
use strictEqual function instead of ok
paper2 Dec 18, 2024
39deb72
Merge branch 'next' into develop/clear-in-memoery-metrics-exporter-da…
pichlermarc Jan 7, 2025
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
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ For semantic convention package changes, see the [semconv CHANGELOG](packages/se

### :boom: Breaking Change

* fix(sdk-metrics): InMemoryMetricExporter clear metrics after shutdown to align with other exporters [#5131](https://github.com/open-telemetry/opentelemetry-js/issues/5131) @paper2

### :rocket: (Enhancement)

### :bug: (Bug Fix)
Expand Down
1 change: 1 addition & 0 deletions packages/sdk-metrics/src/export/InMemoryMetricExporter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ export class InMemoryMetricExporter implements PushMetricExporter {

shutdown(): Promise<void> {
this._shutdown = true;
this._metrics = [];
return Promise.resolve();
}
}
18 changes: 18 additions & 0 deletions packages/sdk-metrics/test/export/InMemoryMetricExporter.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,24 @@ describe('InMemoryMetricExporter', () => {
await metricReader.shutdown();
});

it('should get no metrics after shutdown', async () => {
const counter = meter.createCounter('counter_total', {
description: 'a test description',
});
const counterAttribute = { key1: 'attributeValue1' };
counter.add(10, counterAttribute);

const exportedMetrics = await waitForNumberOfExports(exporter, 1);
assert.ok(exportedMetrics.length > 0);

await exporter.shutdown();

const otherMetrics = exporter.getMetrics();
assert.ok(otherMetrics.length === 0);
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
assert.ok(otherMetrics.length === 0);
assert.strictEqual(otherMetrics.length, 0);

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks. I have fixed it.
use strictEqual function instead of ok

Other assert.ok(xxx === yyy) expressions exists in this test file. Should I fix them too??

Copy link
Member

Choose a reason for hiding this comment

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

let's leave the others for another PR 🙂


await metricReader.shutdown();
});

it('should be able to access metric', async () => {
const counter = meter.createCounter('counter_total', {
description: 'a test description',
Expand Down
Loading