Skip to content

Commit 559ac8d

Browse files
authored
Merge pull request #90 from autometrics-dev/add_objective_name_guidelines_to_spec
Add guidance on objective names
2 parents e54c48b + 74f5889 commit 559ac8d

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

specs/autometrics_v1.0.0.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -245,6 +245,10 @@ If a function has an [SLO](#service-level-objectives-slos) attached, this label
245245
MUST contain the user-specified name of the objective. If there is no SLO
246246
attached, this label MUST be absent or empty (`""`).
247247

248+
The library SHOULD warn users when an objective name contains characters other than alphanumeric characters, `_`, `-`, or a space.
249+
250+
The library SHOULD warn users when an objective name does not start with an alphanumeric character.
251+
248252
### `objective.percentile`
249253

250254
If a function has an [SLO](#service-level-objectives-slos) attached, this label
@@ -341,4 +345,5 @@ initialization function to override this value as well.
341345
- Add `caller.module` label to `function.calls` metric
342346
- Rename `caller` label to `caller.function` in `function.calls` metric
343347
- Add `repository.url` and `repository.provider` labels to `build_info` metric
348+
- Add guidance on the `objective_name` label, and suggest to warn library users if they use anything other than alphanumeric characters, `_`, `-`, or a space
344349
- Relax requirements of environment variables from MUST to SHOULD

0 commit comments

Comments
 (0)