Skip to content

Bug 1716952 - Add JS examples to memory_distribution metric docs #2203

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

Merged
merged 1 commit into from
Oct 6, 2022
Merged

Bug 1716952 - Add JS examples to memory_distribution metric docs #2203

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
46 changes: 43 additions & 3 deletions docs/user/reference/metrics/memory_distribution.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,18 @@ fn allocate_memory(bytes: u64) {
```

</div>
<div data-lang="JavaScript" class="tab" data-bug="1716952"></div>
<div data-lang="JavaScript" class="tab">

```js
import * as memory from "./path/to/generated/files/memory.js";

function allocateMemory() {
// ...
memory.heapAllocated.accumulate(nbytes / 1024);
}
```

</div>
<div data-lang="Firefox Desktop" class="tab">

**C++**
Expand Down Expand Up @@ -201,7 +212,23 @@ assert_eq!(2, snapshot.values.len());


</div>
<div data-lang="JavaScript" class="tab" data-bug="1716952"></div>
<div data-lang="JavaScript" class="tab">

```js
import * as memory from "./path/to/generated/files/memory.js";

// Get snapshot
const snapshot = await memory.heapAllocated.testGetValue();

// Does the sum have the expected value?
assert.equal(11, snapshot.sum);

// Usually you don't know the exact memory values,
// but know how many should have been recorded.
assert.equal(2, snapshot.count);
```

</div>
<div data-lang="Firefox Desktop" class="tab">

**C++**
Expand Down Expand Up @@ -291,7 +318,20 @@ assert_eq!(
```

</div>
<div data-lang="JavaScript" class="tab" data-bug="1716952"></div>
<div data-lang="JavaScript" class="tab">

```js
import * as memory from "./path/to/generated/files/memory.js";
import { ErrorType } from "@mozilla/glean/<platform>";

// Did this record a negative value?
assert.equal(
0,
await memory.heapAllocated.testGetNumRecordedErrors(ErrorType.InvalidValue)
);
```

</div>
<div data-lang="Firefox Desktop" class="tab"></div>

{{#include ../../../shared/tab_footer.md}}
Expand Down