[DO] Add changelog for filtering metrics by ID or name#31316
Conversation
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
ask-bonk
Bot
added
changelog
![ask-bonk[bot]](https://avatars.githubusercontent.com/in/2454580?s=60&v=4){kind=small}
|
Applied labels Verdict: 2 minor style guide issues need fixing before merge. Issues:
Posted both fixes as inline suggestions on the PR. |
…ts-metrics-filter-by-id-name.mdx Co-authored-by: ask-bonk[bot] <249159057+ask-bonk[bot]@users.noreply.github.com>
…ts-metrics-filter-by-id-name.mdx Co-authored-by: ask-bonk[bot] <249159057+ask-bonk[bot]@users.noreply.github.com>
|
|
||
| <DashButton url="/?to=/:account/workers/durable-objects" /> | ||
|
|
||
| Start typing an ID or name into the filter and select a match from the autocomplete dropdown. Every chart on the page updates to reflect only the selected object: requests, errors, billable duration, request wall time, requests by type, storage operations, and WebSockets. This makes it easier to identify and investigate a single Durable Object when debugging a hot instance, an error spike, or unexpected storage usage. Clear the filter to return to namespace-level metrics. |
There was a problem hiding this comment.
select a match from the autocomplete dropdown
How does the autocomplete work? Is it filtered to objects with invocations during the selected time range? What if you enter a wrong object id or name?
Need to help user understand what if an object doesnt appear in the dropdown (doesnt mean object is deleted which some might think).
cc @apeacock1991 for UI behavior
There was a problem hiding this comment.
Is it filtered to objects with invocations during the selected time range?
Yup, and if you enter a wrong one, it will give you a small message indicating there are no results. I'll update it to include a note around the time range
…ts-metrics-filter-by-id-name.mdx Co-authored-by: Vy Ton <vy@cloudflare.com>
…ts-metrics-filter-by-id-name.mdx Co-authored-by: Vy Ton <vy@cloudflare.com>
Updated the description of filtering metrics for Durable Objects to clarify the functionality and removed redundant information.
Updated description to clarify debugging scenarios for Durable Objects metrics filtering.
iglesiasbrandon
requested review from
danlapid,
elithrar,
irvinebroque,
joshthoward and
rita3ko
as code owners
iglesiasbrandon
requested review from
a team,
Oxyjun,
lambrospetrou and
mikenomitch
as code owners
Review💡 1 suggestion found in commit Suggestions (1)
CommandsOnly codeowners can run commands. Post a comment with the command to trigger it.
|
vy-ton
left a comment
vy-ton
left a comment
There was a problem hiding this comment.
conditional approve, do think we want to clarify the behavior of which objects appear
|
|
||
| <DashButton url="/?to=/:account/workers/durable-objects" /> | ||
|
|
||
| Start typing an ID or name into the filter and select a match from the autocomplete dropdown. Every chart on the page updates to reflect only the selected object. This makes it easier to identify and investigate a single Durable Object when debugging a high-traffic object, an error spike, or unexpected storage usage. Clear the filter to return to namespace-level metrics. |
There was a problem hiding this comment.
would callout that only objects with invocations during the selected time range appear
There was a problem hiding this comment.
ack, we will also make sure to incorporate some kind of warning in the UI so that users are not confused by this. thank you for calling this out!
There was a problem hiding this comment.
follow up to address this: https://github.com/cloudflare/cloudflare-docs/pull/31441/changes
|
|
||
| For more information, refer to [Metrics and analytics](/durable-objects/observability/metrics-and-analytics/). | ||
|
|
||
|  |
There was a problem hiding this comment.
nit: put the image after the UI button
* [DO] Address review feedback on metrics filter changelog - Move the dashboard screenshot to immediately after the DashButton so readers see the UI before the description of how to use it. - Note that the autocomplete only lists objects with invocations during the selected time range, so a missing object means no recent invocations rather than deletion. Addresses post-merge review comments on #31316. * [DO] Replace em dash with two sentences in metrics changelog --------- Co-authored-by: iglesiasbrandon <5313116+iglesiasbrandon@users.noreply.github.com>
3 participants
Summary
Adds a changelog entry for a new Durable Objects dashboard capability: filtering the Metrics tab to an individual Durable Object by its ID or name. Previously the metrics charts only showed aggregate, namespace-level data, which made it hard to investigate a single object.
Tracked internally as STOR-5275.
Documentation checklist