You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: specs/autometrics_v1.0.0.md
+15-15Lines changed: 15 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -188,7 +188,7 @@ The following is a list of labels and their intended use.
188
188
189
189
### `autometrics.version`
190
190
191
-
> Used with metrics: `build_info`
191
+
> Used with metrics: [`build_info`](#build_info)
192
192
193
193
The version of the specification that the library targets. This version MUST
194
194
contain the full version without the `v` prefix.
@@ -200,14 +200,14 @@ For the current specification this SHOULD be `1.0.0`.
200
200
201
201
### `branch`
202
202
203
-
> Used with metrics: `build_info`
203
+
> Used with metrics: [`build_info`](#build_info)
204
204
205
205
The Git branch of the user's project. If this information is not available, this
206
206
label MAY be absent or empty (`""`).
207
207
208
208
### `caller.function`
209
209
210
-
> Used with metrics: `function.calls`
210
+
> Used with metrics: [`function.calls`](#functioncalls)
211
211
212
212
The name of the `function` that invoked the given function. If the caller is
213
213
not known, this label MUST be absent or empty (`""`).
@@ -221,7 +221,7 @@ information has a non-negligible performance overhead.
221
221
222
222
### `caller.module`
223
223
224
-
> Used with metrics: `function.calls`
224
+
> Used with metrics: [`function.calls`](#functioncalls)
225
225
226
226
The `module` of the function that invoked the given function. If the caller is
227
227
not known, this label MUST be absent or empty (`""`).
@@ -230,21 +230,21 @@ See [`caller.function`](#callerfunction)
230
230
231
231
### `commit`
232
232
233
-
> Used with metrics: `build_info`
233
+
> Used with metrics: [`build_info`](#build_info)
234
234
235
235
The Git commit hash identifying the snapshot of the user's project. The library
236
236
MAY truncate the commit hash to its short representation. If this information is
237
237
not available, this label MUST be absent or empty (`""`).
238
238
239
239
### `function`
240
240
241
-
> Used with metrics: `function.calls`, `function.calls.duration`, `function.calls.concurrent`
241
+
> Used with metrics: [`function.calls`](#functioncalls), [`function.calls.duration`](#functioncallsduration), [`function.calls.concurrent`](#functioncallsconcurrent)
242
242
243
243
The name of the function or method, exactly as it appears in the source code.
244
244
245
245
### `module`
246
246
247
-
> Used with metrics: `function.calls`, `function.calls.duration`, `function.calls.concurrent`
247
+
> Used with metrics: [`function.calls`](#functioncalls), [`function.calls.duration`](#functioncallsduration), [`function.calls.concurrent`](#functioncallsconcurrent)
248
248
249
249
The fully-qualified module or file path of the `function`.
250
250
@@ -255,7 +255,7 @@ The exact contents of this label value are assumed to be language-specific.
255
255
256
256
### `objective.name`
257
257
258
-
> Used with metrics: `function.calls`, `function.calls.duration`
258
+
> Used with metrics: [`function.calls`](#functioncalls), [`function.calls.duration`](#functioncallsduration)
259
259
260
260
If a function has an [SLO](#service-level-objectives-slos) attached, this label
261
261
MUST contain the user-specified name of the objective. If there is no SLO
@@ -267,7 +267,7 @@ The library SHOULD warn users when an objective name does not start with an alph
267
267
268
268
### `objective.percentile`
269
269
270
-
> Used with metrics: `function.calls`, `function.calls.duration`
270
+
> Used with metrics: [`function.calls`](#functioncalls), [`function.calls.duration`](#functioncallsduration)
271
271
272
272
If a function has an [SLO](#service-level-objectives-slos) attached, this label
273
273
MUST specifies the percentage of requests that should return the `result="ok"`
@@ -286,7 +286,7 @@ rules for the custom percentiles.
286
286
287
287
### `objective.latency_threshold`
288
288
289
-
> Used with metrics: `function.calls.duration`
289
+
> Used with metrics: [`function.calls.duration`](#functioncallsduration)
290
290
291
291
If a function has an [SLO](#service-level-objectives-slos) attached, this MUST
292
292
specify the maximum duration of function calls that are considered meeting
@@ -303,7 +303,7 @@ metric.
303
303
304
304
### `result`
305
305
306
-
> Used with metrics: `function.calls`
306
+
> Used with metrics: [`function.calls`](#functioncalls)
307
307
308
308
Whether the function executed successfully or errored. An error MAY either mean
309
309
that the function returned an error or that it threw an exception.
@@ -316,7 +316,7 @@ example to allow users to treat client-side errors as `"ok"`.
316
316
317
317
### `service.name`
318
318
319
-
> Used with metrics: `build_info`, `function.calls`, `function.calls.duration`, `function.calls.concurrent`
319
+
> Used with metrics: [`build_info`](#build_info), [`function.calls`](#functioncalls), [`function.calls.duration`](#functioncallsduration), [`function.calls.concurrent`](#functioncallsconcurrent)
320
320
321
321
The logical name of a service. This matches the
322
322
[OpenTelemetry Service specification](https://github.com/open-telemetry/semantic-conventions/tree/main/specification/resource/semantic_conventions#service).
@@ -334,15 +334,15 @@ something like a package name or the binary name.
334
334
335
335
### `version`
336
336
337
-
> Used with metrics: `build_info`
337
+
> Used with metrics: [`build_info`](#build_info)
338
338
339
339
The version of the user's project, ideally using
340
340
[Semantic Versioning](https://semver.org/). It SHOULD only contain the version
341
341
number and SHOULD NOT start with a `v`.
342
342
343
343
### `repository.url`
344
344
345
-
> Used with metrics: `build_info`
345
+
> Used with metrics: [`build_info`](#build_info)
346
346
347
347
A URL to the user's project git or other scm repository. This SHOULD be a URL
348
348
that makes sense for the repository type. For example, for a git repository, it
@@ -355,7 +355,7 @@ by itself, but the user MUST be able to opt-out of this behavior.
355
355
356
356
### `repository.provider`
357
357
358
-
> Used with metrics: `build_info`
358
+
> Used with metrics: [`build_info`](#build_info)
359
359
360
360
A hint to which provider is being used to host the repository. A consumer can
361
361
use this to provider deeper integration. The value MUST be a freeform string to
0 commit comments