-
Notifications
You must be signed in to change notification settings - Fork 239
Add new Blazor metrics for Net10 #2235
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.
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!--- Hugo front matter used to generate the website version of this page: | ||
linkTitle: Blazor | ||
---> | ||
|
||
# Semantic conventions for Blazor UI framework | ||
|
||
**Status**: [Development][DocumentStatus] | ||
|
||
This article defines semantic conventions for Blazor metrics emitted by .NET components. | ||
|
||
TODO - is this generated ? | ||
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -83,3 +83,50 @@ groups: | |||||
stability: stable | ||||||
brief: ASP.NET Core exception middleware handling result | ||||||
examples: ["handled", "unhandled"] | ||||||
- id: aspnetcore.components.type | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It's a type of a specific component, right? If I understand correctly, the goal is to stay consistent with
Suggested change
OTel suggests not to use plural form in metric namespaces - https://github.com/open-telemetry/semantic-conventions/blob/1000be4d897fafbc8554b373267992e47c1b86ac/docs/general/naming.md#pluralization
pavelsavara marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
type: string | ||||||
stability: development | ||||||
brief: Full type name of the Blazor component. | ||||||
note: > | ||||||
This is full name of the C# component class, including the namespace. | ||||||
More about [Blazor event handling](https://learn.microsoft.com/en-us/aspnet/core/blazor/components/event-handling) | ||||||
examples: ["Contoso.Weather"] | ||||||
- id: aspnetcore.components.method | ||||||
type: string | ||||||
stability: development | ||||||
brief: Method name of the event handler in Blazor component. | ||||||
pavelsavara marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
note: > | ||||||
This is method name of the C# event handler. | ||||||
More about [Blazor event handling](https://learn.microsoft.com/en-us/aspnet/core/blazor/components/event-handling) | ||||||
examples: ["IncrementCount"] | ||||||
- id: aspnetcore.components.attribute.name | ||||||
type: string | ||||||
stability: development | ||||||
brief: Attribute name of the event handler in Blazor component. | ||||||
note: > | ||||||
This is name of the binding attribute in the component markup. | ||||||
More about [Blazor event handling](https://learn.microsoft.com/en-us/aspnet/core/blazor/components/event-handling) | ||||||
examples: ["onclick"] | ||||||
- id: aspnetcore.components.route | ||||||
type: string | ||||||
stability: development | ||||||
brief: Segment of the URL that is matched to a Blazor @page component. | ||||||
note: > | ||||||
This route pattern is used to match the URL to the component. | ||||||
More about [Blazor routing](https://learn.microsoft.com/en-us/aspnet/core/blazor/fundamentals/routing) | ||||||
examples: ["/weather", "/counter"] | ||||||
- id: aspnetcore.components.diff.length | ||||||
type: int | ||||||
stability: development | ||||||
brief: Bucketed length of the diff in Blazor rendering pipeline. | ||||||
note: > | ||||||
This is approximate number of changes in the diff batch which would be applied to browser DOM. | ||||||
It's bucketed so that it doesn't have high cardinality. | ||||||
More about [Blazor rendering](https://learn.microsoft.com/en-us/aspnet/core/blazor/components/rendering) | ||||||
examples: [1, 2, 5, 10, 100, 1000] | ||||||
- id: aspnetcore.components.circuit.id | ||||||
type: string | ||||||
stability: development | ||||||
brief: Id of the Blazor circuit. | ||||||
note: More about [Blazor circuits](https://learn.microsoft.com/en-us/aspnet/core/blazor/fundamentals/signalr) | ||||||
examples: ["ztOXUZxeJvS2b3ioeZ68bal8RQmQehui02CtZER"] |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
groups: | ||
- id: span.Microsoft.AspNetCore.Components.CircuitStart | ||
type: span | ||
span_kind: internal | ||
brief: | ||
note: > | ||
ActivitySource name: `Microsoft.AspNetCore.Components`; Added in: ASP.NET Core 10.0 | ||
More about [Blazor circuits](https://learn.microsoft.com/en-us/aspnet/core/blazor/fundamentals/signalr) | ||
stability: development | ||
attributes: | ||
- ref: aspnetcore.components.circuit.id | ||
requirement_level: required | ||
- ref: error.type | ||
requirement_level: | ||
conditionally_required: if the circuit initialization failed | ||
- id: span.Microsoft.AspNetCore.Components.RouteChange | ||
type: span | ||
span_kind: internal | ||
brief: | ||
note: > | ||
ActivitySource name: `Microsoft.AspNetCore.Components`; Added in: ASP.NET Core 10.0 | ||
More about [Blazor routing](https://learn.microsoft.com/en-us/aspnet/core/blazor/fundamentals/routing) | ||
stability: development | ||
attributes: | ||
- ref: aspnetcore.components.circuit.id | ||
requirement_level: required | ||
- ref: aspnetcore.components.type | ||
requirement_level: required | ||
- ref: aspnetcore.components.route | ||
requirement_level: required | ||
- ref: error.type | ||
requirement_level: | ||
conditionally_required: if the circuit initialization failed | ||
- id: span.Microsoft.AspNetCore.Components.HandleEvent | ||
type: span | ||
span_kind: internal | ||
brief: | ||
note: > | ||
ActivitySource name: `Microsoft.AspNetCore.Components`; Added in: ASP.NET Core 10.0 | ||
More about [Blazor event handling](https://learn.microsoft.com/en-us/aspnet/core/blazor/components/event-handling) | ||
stability: development | ||
attributes: | ||
- ref: aspnetcore.components.circuit.id | ||
requirement_level: required | ||
- ref: aspnetcore.components.type | ||
requirement_level: required | ||
- ref: aspnetcore.components.route | ||
requirement_level: required | ||
- ref: aspnetcore.components.attribute.name | ||
requirement_level: required | ||
- ref: error.type | ||
requirement_level: | ||
conditionally_required: if the circuit initialization failed |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes, check out https://github.com/open-telemetry/semantic-conventions/blob/main/CONTRIBUTING.md#2-update-the-markdown-files and you can use other md files as examples, e.g.
semantic-conventions/docs/dotnet/dotnet-aspnetcore-metrics.md
Line 35 in 86cad42
we don't have it yaml (yet), but we should document recommended boundaries for histograms - e.g. like here https://github.com/open-telemetry/semantic-conventions/blob/main/docs/dotnet/dotnet-http-metrics.md#metric-httpclientrequesttime_in_queue