Skip to content

Specify rules for class name in module/function labels #94

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
Nov 3, 2023
Merged

Specify rules for class name in module/function labels #94

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b53c910
Specify rules for class name in module/function labels
gagbo Nov 2, 2023
ab69c19
Mention that types can be more than classes
gagbo Nov 3, 2023
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
12 changes: 11 additions & 1 deletion specs/autometrics_v1.0.0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,17 @@ The fully-qualified module or file path of the `function`.
The combination of the `function` and `module` labels MUST be sufficient to
uniquely identify the function within the project's source code.

The exact contents of this label value are assumed to be language-specific.
The exact contents of these label values (`module` and `function`) are assumed
to be language-specific. Notably, for type (classes, structs, enums...) methods
libraries SHOULD include the type/prototype name as a prefix in the `function`
label with a language-specific separator (e.g. `::` in Rust), but if it is
technically difficult, libraries MAY include the type/prototype name as part
of the `module` value.

In all cases, libraries MUST include type name in either `module` or `function` label,
they MUST consistently use the same label all the time, and
SHOULD document the choice so that users know how to query "all metrics for
a given class".

### `objective.name`

Expand Down