Skip to content

Commit 411cd9d

Browse files
add backticks to all fields and types references (#2480)
Co-authored-by: Nicolás Pazos <[email protected]> Signed-off-by: bwplotka <[email protected]>
1 parent 9042e61 commit 411cd9d

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

Diff for: content/docs/specs/remote_write_spec_2_0.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -314,21 +314,21 @@ message Histogram { ... }
314314

315315
All timestamps MUST be int64 counted as milliseconds since the Unix epoch. Sample's values MUST be float64.
316316

317-
For every TimeSeries message:
317+
For every `TimeSeries` message:
318318

319-
* Label references MUST be provided.
319+
* `labels_refs` MUST be provided.
320320

321321
<!---
322322
Rationales: https://github.com/prometheus/proposals/blob/alexg/remote-write-20-proposal/proposals/2024-04-09_remote-write-20.md#partial-writes#samples-vs-native-histogram-samples
323323
-->
324-
* At least one element in Samples or in Histograms MUST be provided. A TimeSeries MUST NOT include both Samples and Histograms. For series which (rarely) would mix float and histogram samples, a separate TimeSeries message MUST be used.
324+
* At least one element in `samples` or in `histograms` MUST be provided. A `TimeSeries` MUST NOT include both `samples` and `histograms`. For series which (rarely) would mix float and histogram samples, a separate `TimeSeries` message MUST be used.
325325

326326
<!---
327327
Rationales: https://github.com/prometheus/proposals/blob/alexg/remote-write-20-proposal/proposals/2024-04-09_remote-write-20.md#always-on-metadata
328328
-->
329-
* Metadata sub-fields SHOULD be provided. Receiver MAY reject series with unspecified Metadata.Type.
329+
* `metadata` sub-fields SHOULD be provided. Receiver MAY reject series with unspecified `Metadata.type`.
330330
* Exemplars SHOULD be provided if they exist for a series.
331-
* Created Timestamp SHOULD be provided for metrics that follow counter semantics (e.g. counters and histograms). Receiver MAY reject those series without the Created Timestamp being set.
331+
* `created_timestamp` SHOULD be provided for metrics that follow counter semantics (e.g. counters and histograms). Receiver MAY reject those series without `created_timestamp` being set.
332332

333333
The following subsections define some schema elements in detail.
334334

@@ -339,14 +339,14 @@ Rationales: https://github.com/prometheus/proposals/blob/alexg/remote-write-20-p
339339
-->
340340
The `io.prometheus.write.v2.Request` Proto Message is designed to [intern all strings](https://en.wikipedia.org/wiki/String_interning) for the proven additional compression and memory efficiency gains on top of the standard compressions.
341341

342-
Symbols table MUST be provided and it MUST contain deduplicated strings used in series, exemplar labels, and metadata strings. The first element of the symbols table MUST be an empty string, which is used to represent empty or unspecified values such as when Unit or Help metadata are not provided. References MUST point to the existing index in the Symbols string array.
342+
The `symbols` table MUST be provided and it MUST contain deduplicated strings used in series, exemplar labels, and metadata strings. The first element of the `symbols` table MUST be an empty string, which is used to represent empty or unspecified values such as when `Metadata.unit_ref` or `Metadata.help_ref` are not provided. References MUST point to the existing index in the `symbols` string array.
343343

344344
#### Series Labels
345345

346346
<!---
347347
Rationales: https://github.com/prometheus/proposals/blob/alexg/remote-write-20-proposal/proposals/2024-04-09_remote-write-20.md#labels-and-utf-8
348348
-->
349-
The complete set of labels MUST be sent with each Sample or Histogram sample. Additionally, the label set associated with samples:
349+
The complete set of labels MUST be sent with each `Sample` or `Histogram` sample. Additionally, the label set associated with samples:
350350

351351
* SHOULD contain a `__name__` label.
352352
* MUST NOT contain repeated label names.
@@ -370,7 +370,7 @@ Receiver also MAY impose limits on the number and length of labels, but this is
370370
<!---
371371
Rationales: https://github.com/prometheus/proposals/blob/alexg/remote-write-20-proposal/proposals/2024-04-09_remote-write-20.md#partial-writes#native-histograms
372372
-->
373-
Sender MUST send samples (or histogram samples) for any given TimeSeries in timestamp order. Sender MAY send multiple requests for different series in parallel.
373+
Sender MUST send `samples` (or `histograms`) for any given `TimeSeries` in timestamp order. Sender MAY send multiple requests for different series in parallel.
374374

375375
<!---
376376
Rationales: https://github.com/prometheus/proposals/blob/alexg/remote-write-20-proposal/proposals/2024-04-09_remote-write-20.md#partial-writes#being-pull-vs-push-agnostic

0 commit comments

Comments
 (0)