Skip to content

Commit

Permalink
Merge pull request #94 from autometrics-dev/unspecify_class_name
Browse files Browse the repository at this point in the history
Specify rules for class name in module/function labels
  • Loading branch information
gagbo authored Nov 3, 2023
2 parents d46c1a2 + ab69c19 commit 7409f02
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion specs/autometrics_v1.0.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,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

0 comments on commit 7409f02

Please # to comment.