Skip to content

Commit 3614a73

Browse files
authored
[editorial] Use canonical URL to wiki page in metrics/api (open-telemetry#3834)
1 parent 3f0548e commit 3614a73

File tree

1 file changed

+25
-25
lines changed

1 file changed

+25
-25
lines changed

specification/metrics/api.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -132,19 +132,19 @@ This API MUST accept the following parameters:
132132
within that library or application.
133133
* `version`: Specifies the version of the instrumentation scope if the scope
134134
has a version (e.g. a library version). Example value: `1.0.0`.
135-
135+
136136
Users can provide a `version`, but it is up to their discretion. Therefore,
137137
this API needs to be structured to accept a `version`, but MUST NOT obligate
138138
a user to provide one.
139139
* [since 1.4.0] `schema_url`: Specifies the Schema URL that should be recorded
140140
in the emitted telemetry.
141-
141+
142142
Users can provide a `schema_url`, but it is up to their discretion.
143143
Therefore, this API needs to be structured to accept a `schema_url`, but MUST
144144
NOT obligate a user to provide one.
145145
* [since 1.13.0] `attributes`: Specifies the instrumentation scope attributes
146146
to associate with emitted telemetry.
147-
147+
148148
Users can provide attributes to associate with the instrumentation scope, but
149149
it is up to their discretion. Therefore, this API MUST be structured to
150150
accept a variable number of attributes, including none.
@@ -308,32 +308,32 @@ pattern](https://en.wikipedia.org/wiki/Asynchronous_method_invocation).
308308
The API to construct synchronous instruments MUST accept the following parameters:
309309

310310
* A `name` of the Instrument.
311-
311+
312312
The `name` needs to be provided by a user. If possible, the API SHOULD be
313313
structured so a user is obligated to provide this parameter. If it is not
314314
possible to structurally enforce this obligation, the API MUST be documented
315315
in a way to communicate to users that this parameter is needed.
316-
316+
317317
The API SHOULD be documented in a way to communicate to users that the `name`
318318
parameter needs to conform to the [instrument name
319319
syntax](#instrument-name-syntax). The API SHOULD NOT validate the `name`;
320320
that is left to implementations of the API.
321321
* A `unit` of measure.
322-
322+
323323
Users can provide a `unit`, but it is up to their discretion. Therefore, this
324324
API needs to be structured to accept a `unit`, but MUST NOT obligate a user
325325
to provide one.
326-
326+
327327
The `unit` parameter needs to support the [instrument unit
328328
rule](#instrument-unit). Meaning, the API MUST accept a case-sensitive string
329329
that supports ASCII character encoding and can hold at least 63 characters.
330330
The API SHOULD NOT validate the `unit`.
331331
* A `description` describing the Instrument in human-readable terms.
332-
332+
333333
Users can provide a `description`, but it is up to their discretion.
334334
Therefore, this API needs to be structured to accept a `description`, but
335335
MUST NOT obligate a user to provide one.
336-
336+
337337
The `description` needs to support the [instrument description
338338
rule](#instrument-description). Meaning, the API MUST accept a string that
339339
supports at least [BMP (Unicode Plane
@@ -361,32 +361,32 @@ order of callback execution is not specified.
361361
The API to construct asynchronous instruments MUST accept the following parameters:
362362

363363
* A `name` of the Instrument.
364-
364+
365365
The `name` needs to be provided by a user. If possible, the API SHOULD be
366366
structured so a user is obligated to provide this parameter. If it is not
367367
possible to structurally enforce this obligation, the API MUST be documented
368368
in a way to communicate to users that this parameter is needed.
369-
369+
370370
The API SHOULD be documented in a way to communicate to users that the `name`
371371
parameter needs to conform to the [instrument name
372372
syntax](#instrument-name-syntax). The API SHOULD NOT validate the `name`,
373373
that is left to implementations of the API.
374374
* A `unit` of measure.
375-
375+
376376
Users can provide a `unit`, but it is up to their discretion. Therefore, this
377377
API needs to be structured to accept a `unit`, but MUST NOT obligate a user
378378
to provide one.
379-
379+
380380
The `unit` parameter needs to support the [instrument unit
381381
rule](#instrument-unit). Meaning, the API MUST accept a case-sensitive string
382382
that supports ASCII character encoding and can hold at least 63 characters.
383383
The API SHOULD NOT validate the `unit`.
384384
* A `description` describing the Instrument in human-readable terms.
385-
385+
386386
Users can provide a `description`, but it is up to their discretion.
387387
Therefore, this API needs to be structured to accept a `description`, but
388388
MUST NOT obligate a user to provide one.
389-
389+
390390
The `description` needs to support the [instrument description
391391
rule](#instrument-description). Meaning, the API MUST accept a string that
392392
supports at least [BMP (Unicode Plane
@@ -404,7 +404,7 @@ The API to construct asynchronous instruments MUST accept the following paramete
404404
The API SHOULD NOT validate `advisory` parameters.
405405
* `callback` functions that report [Measurements](#measurement) of the created
406406
instrument.
407-
407+
408408
Users can provide `callback` functions, but it is up to their discretion.
409409
Therefore, this API MUST be structured to accept a variable number of
410410
`callback` functions, including none.
@@ -532,19 +532,19 @@ certain programming languages or systems, for example `null`, `undefined`).
532532
This API MUST accept the following parameter:
533533

534534
* A numeric increment value.
535-
535+
536536
The increment value needs to be provided by a user. If possible, this API
537537
SHOULD be structured so a user is obligated to provide this parameter. If it
538538
is not possible to structurally enforce this obligation, this API MUST be
539539
documented in a way to communicate to users that this parameter is needed.
540-
540+
541541
The increment value is expected to be non-negative. This API SHOULD be
542542
documented in a way to communicate to users that this value is expected to be
543543
non-negative. This API SHOULD NOT validate this value, that is left to
544544
implementations of the API.
545545
* [Attributes](../common/README.md#attribute) to associate with the increment
546546
value.
547-
547+
548548
Users can provide attributes to associate with the increment value, but it is
549549
up to their discretion. Therefore, this API MUST be structured to accept a
550550
variable number of attributes, including none.
@@ -579,7 +579,7 @@ counterPowerUsed.Add(200, new PowerConsumption { customer = "Jerry" }, ("is_gree
579579
### Asynchronous Counter
580580

581581
Asynchronous Counter is an [asynchronous Instrument](#asynchronous-instrument-api)
582-
which reports [monotonically](https://wikipedia.org/wiki/Monotonic_function)
582+
which reports [monotonically](https://en.wikipedia.org/wiki/Monotonic_function)
583583
increasing value(s) when the instrument is being observed.
584584

585585
Example uses for Asynchronous Counter:
@@ -773,13 +773,13 @@ This API MUST accept the following parameter:
773773
structured so a user is obligated to provide this parameter. If it is not
774774
possible to structurally enforce this obligation, this API MUST be documented
775775
in a way to communicate to users that this parameter is needed.
776-
776+
777777
The value is expected to be non-negative. This API SHOULD be documented in a
778778
way to communicate to users that this value is expected to be non-negative.
779779
This API SHOULD NOT validate this value, that is left to implementations of
780780
the API.
781781
* [Attributes](../common/README.md#attribute) to associate with the value.
782-
782+
783783
Users can provide attributes to associate with the value, but it is up to
784784
their discretion. Therefore, this API MUST be structured to accept a variable
785785
number of attributes, including none.
@@ -1017,7 +1017,7 @@ class Device:
10171017
supports increments and decrements.
10181018

10191019
Note: if the value is
1020-
[monotonically](https://wikipedia.org/wiki/Monotonic_function) increasing, use
1020+
[monotonically](https://en.wikipedia.org/wiki/Monotonic_function) increasing, use
10211021
[Counter](#counter) instead.
10221022

10231023
Example uses for `UpDownCounter`:
@@ -1113,7 +1113,7 @@ This API MUST accept the following parameter:
11131113
possible to structurally enforce this obligation, this API MUST be documented
11141114
in a way to communicate to users that this parameter is needed.
11151115
* [Attributes](../common/README.md#attribute) to associate with the value.
1116-
1116+
11171117
Users can provide attributes to associate with the value, but it is up to
11181118
their discretion. Therefore, this API MUST be structured to accept a variable
11191119
number of attributes, including none.
@@ -1146,7 +1146,7 @@ processes and sum them up, so we get the total heap usage) when the instrument
11461146
is being observed.
11471147

11481148
Note: if the value is
1149-
[monotonically](https://wikipedia.org/wiki/Monotonic_function) increasing, use
1149+
[monotonically](https://en.wikipedia.org/wiki/Monotonic_function) increasing, use
11501150
[Asynchronous Counter](#asynchronous-counter) instead; if the value is
11511151
non-additive, use [Asynchronous Gauge](#asynchronous-gauge) instead.
11521152

0 commit comments

Comments
 (0)