Skip to content

Fix memory pool metrics unit to follow standard #62766

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 2 commits into from
Jul 19, 2025
Merged

Fix memory pool metrics unit to follow standard #62766

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3d7e1cf
Fix memory pool metrics unit to follow standard
JamesNK Jul 17, 2025
9653cbc
Rename counters
JamesNK Jul 17, 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
8 changes: 4 additions & 4 deletions src/Shared/Buffers.MemoryPool/PinnedBlockMemoryPoolMetrics.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,22 +23,22 @@ public PinnedBlockMemoryPoolMetrics(IMeterFactory meterFactory)

_currentMemory = _meter.CreateUpDownCounter<long>(
"aspnetcore.memorypool.current_memory",
Copy link
Member Author

@JamesNK JamesNK Jul 17, 2025

Choose a reason for hiding this comment

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

Should the name be aspnetcore.memory_pool.current_memory? Memory pool is two words so should be seperated by an underscore.

Copy link
Member

@gfoidl gfoidl Jul 17, 2025

Choose a reason for hiding this comment

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

I'd stick to memorypool as it's a common term (even when it consists of multiple words).
Otherwise the same could apply to aspnet_core (or asp_net_core), etc.

From a usability point when searching through metrics with memory_ one can find quite a lot.
So when I'm interested in the memory pool, I'd search for memorypool as I won't remember that it's separated by underscore.

Copy link
Member Author

@JamesNK JamesNK Jul 17, 2025

Choose a reason for hiding this comment

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

We have rate_limiting rather than ratelimiting in other metrics. So an underscore here would be consistant with that.

To go with the standard, and consistency, I think memory_pool is better.

Otherwise the same could apply to aspnet_core (or asp_net_core), etc.

All product names in metrics seem to avoid underscores, e.g. cloudfoundary, elasticsearch, openai, etc.

unit: "{bytes}",
unit: "By",
description: "Number of bytes that are currently pooled by the pool.");

_totalAllocatedMemory = _meter.CreateCounter<long>(
"aspnetcore.memorypool.total_allocated",
unit: "{bytes}",
unit: "By",
description: "Total number of allocations made by the pool.");

_evictedMemory = _meter.CreateCounter<long>(
"aspnetcore.memorypool.evicted_memory",
unit: "{bytes}",
unit: "By",
description: "Total number of bytes that have been evicted.");

_totalRented = _meter.CreateCounter<long>(
"aspnetcore.memorypool.total_rented",
unit: "{bytes}",
unit: "By",
description: "Total number of rented bytes from the pool.");
}

Expand Down
Loading