Skip to content

Commit 040210f

Browse files
committed
Add links
1 parent 8d8161c commit 040210f

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

specs/autometrics_v1.0.0.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ The following is a list of labels and their intended use.
188188

189189
### `autometrics.version`
190190

191-
> Used with metrics: `build_info`
191+
> Used with metrics: [`build_info`](#build_info)
192192
193193
The version of the specification that the library targets. This version MUST
194194
contain the full version without the `v` prefix.
@@ -200,14 +200,14 @@ For the current specification this SHOULD be `1.0.0`.
200200

201201
### `branch`
202202

203-
> Used with metrics: `build_info`
203+
> Used with metrics: [`build_info`](#build_info)
204204
205205
The Git branch of the user's project. If this information is not available, this
206206
label MAY be absent or empty (`""`).
207207

208208
### `caller.function`
209209

210-
> Used with metrics: `function.calls`
210+
> Used with metrics: [`function.calls`](#functioncalls)
211211
212212
The name of the `function` that invoked the given function. If the caller is
213213
not known, this label MUST be absent or empty (`""`).
@@ -221,7 +221,7 @@ information has a non-negligible performance overhead.
221221

222222
### `caller.module`
223223

224-
> Used with metrics: `function.calls`
224+
> Used with metrics: [`function.calls`](#functioncalls)
225225
226226
The `module` of the function that invoked the given function. If the caller is
227227
not known, this label MUST be absent or empty (`""`).
@@ -230,21 +230,21 @@ See [`caller.function`](#callerfunction)
230230

231231
### `commit`
232232

233-
> Used with metrics: `build_info`
233+
> Used with metrics: [`build_info`](#build_info)
234234
235235
The Git commit hash identifying the snapshot of the user's project. The library
236236
MAY truncate the commit hash to its short representation. If this information is
237237
not available, this label MUST be absent or empty (`""`).
238238

239239
### `function`
240240

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)
242242
243243
The name of the function or method, exactly as it appears in the source code.
244244

245245
### `module`
246246

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)
248248
249249
The fully-qualified module or file path of the `function`.
250250

@@ -255,7 +255,7 @@ The exact contents of this label value are assumed to be language-specific.
255255

256256
### `objective.name`
257257

258-
> Used with metrics: `function.calls`, `function.calls.duration`
258+
> Used with metrics: [`function.calls`](#functioncalls), [`function.calls.duration`](#functioncallsduration)
259259
260260
If a function has an [SLO](#service-level-objectives-slos) attached, this label
261261
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
267267

268268
### `objective.percentile`
269269

270-
> Used with metrics: `function.calls`, `function.calls.duration`
270+
> Used with metrics: [`function.calls`](#functioncalls), [`function.calls.duration`](#functioncallsduration)
271271
272272
If a function has an [SLO](#service-level-objectives-slos) attached, this label
273273
MUST specifies the percentage of requests that should return the `result="ok"`
@@ -286,7 +286,7 @@ rules for the custom percentiles.
286286

287287
### `objective.latency_threshold`
288288

289-
> Used with metrics: `function.calls.duration`
289+
> Used with metrics: [`function.calls.duration`](#functioncallsduration)
290290
291291
If a function has an [SLO](#service-level-objectives-slos) attached, this MUST
292292
specify the maximum duration of function calls that are considered meeting
@@ -303,7 +303,7 @@ metric.
303303

304304
### `result`
305305

306-
> Used with metrics: `function.calls`
306+
> Used with metrics: [`function.calls`](#functioncalls)
307307
308308
Whether the function executed successfully or errored. An error MAY either mean
309309
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"`.
316316

317317
### `service.name`
318318

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)
320320
321321
The logical name of a service. This matches the
322322
[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.
334334

335335
### `version`
336336

337-
> Used with metrics: `build_info`
337+
> Used with metrics: [`build_info`](#build_info)
338338
339339
The version of the user's project, ideally using
340340
[Semantic Versioning](https://semver.org/). It SHOULD only contain the version
341341
number and SHOULD NOT start with a `v`.
342342

343343
### `repository.url`
344344

345-
> Used with metrics: `build_info`
345+
> Used with metrics: [`build_info`](#build_info)
346346
347347
A URL to the user's project git or other scm repository. This SHOULD be a URL
348348
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.
355355

356356
### `repository.provider`
357357

358-
> Used with metrics: `build_info`
358+
> Used with metrics: [`build_info`](#build_info)
359359
360360
A hint to which provider is being used to host the repository. A consumer can
361361
use this to provider deeper integration. The value MUST be a freeform string to

0 commit comments

Comments
 (0)