From 3a7c27c6f8df126749799e96b9290df9ffaea9ca Mon Sep 17 00:00:00 2001 From: Steve Flanders Date: Tue, 5 Dec 2023 02:11:52 +0100 Subject: [PATCH 01/16] Update glossary.md Metadata and its definition are used inconsistently in the glossary. Make it consistent and clarify its use. --- content/en/docs/concepts/glossary.md | 23 +++++++++++------------ 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/content/en/docs/concepts/glossary.md b/content/en/docs/concepts/glossary.md index 8d00ac455cfe..485ddcb1ea18 100644 --- a/content/en/docs/concepts/glossary.md +++ b/content/en/docs/concepts/glossary.md @@ -36,9 +36,8 @@ alerting and tooling for finding the root cause. ### **Attribute** -A key-value pair. Used across telemetry signals - e.g. in [`Traces`](#trace) to -attach data to a [`Span`](#span), or in [`Metrics`](#metric). See [attribute -spec][attribute]. +See [`Metadata`](#metadata). Used across [`Signals`](#signal) and [`Resources`] +(#resource). See [attributespec][attribute]. ### **Automatic Instrumentation** @@ -48,7 +47,7 @@ examples include bytecode injection or monkey patching. ### **Baggage** -A mechanism for propagating name/value pairs to help establish a causal +A mechanism for propagating [`Metadata`](#metadata) to help establish a causal relationship between events and services. See [baggage spec][baggage]. ### **Client Library** @@ -93,7 +92,7 @@ See [`Signal`](#signal) ### **Dimension** -See [`Label`](#label). +Term used specifically for [`Metrics`](#metric). See [`Attribute`](#attribute). ### **Distributed Tracing** @@ -118,9 +117,8 @@ pull-based. ### **Field** -Name/value pairs added to [`Log Records`](#log-record) (similar to -[`Attributes`](#attribute) for [`Spans`](#span) and [`Labels`](#label) for -[`Metrics`](#metric)). See [field spec][field]. +Term used specifically for [`Log Records`](#log-record). See [`Attribute`](#attribute) +and the [field spec][field]. ### **gRPC** @@ -152,7 +150,7 @@ Short for [JavaScript Object Notation][json]. ### **Label** -See [Attribute](#attribute). +Term used specifically for [`Metrics`](#metric). See [`Attribute`](#attribute). ### **Language** @@ -178,9 +176,10 @@ describes what happened, where it happened, etc. See [more][log record]. ### **Metadata** -A name/value pair added to telemetry data. OpenTelemetry calls this -[`Attributes`](#attribute) on [`Spans`](#span), [`Labels`](#label) on -[`Metrics`](#metric) and [`Fields`](#field) on [`Logs`](#log). +A name/value pair (e.g. `foo="bar"`) added to telemetry data. OpenTelemetry +generally calls this [`Attributes`](#attribute) though [`Metrics`](#metric) +have [`Dimensions`](#dimension) and [`Labels`](#label) while [`Logs`](#log) +have [`Fields`](#field). ### **Metric** From d5128286b8299f169a62c1e5719deb9c04b8cef9 Mon Sep 17 00:00:00 2001 From: Steve Flanders Date: Tue, 5 Dec 2023 02:17:47 +0100 Subject: [PATCH 02/16] Update glossary.md --- content/en/docs/concepts/glossary.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/concepts/glossary.md b/content/en/docs/concepts/glossary.md index 485ddcb1ea18..616f1747d9e0 100644 --- a/content/en/docs/concepts/glossary.md +++ b/content/en/docs/concepts/glossary.md @@ -37,7 +37,7 @@ alerting and tooling for finding the root cause. ### **Attribute** See [`Metadata`](#metadata). Used across [`Signals`](#signal) and [`Resources`] -(#resource). See [attributespec][attribute]. +(#resource). See [attribute spec][attribute]. ### **Automatic Instrumentation** From 5784df4d4ccfd9703aeb18fae380284276d61c30 Mon Sep 17 00:00:00 2001 From: Steve Flanders Date: Tue, 5 Dec 2023 02:57:56 +0100 Subject: [PATCH 03/16] Update glossary.md --- content/en/docs/concepts/glossary.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/content/en/docs/concepts/glossary.md b/content/en/docs/concepts/glossary.md index 616f1747d9e0..7129f8893ad8 100644 --- a/content/en/docs/concepts/glossary.md +++ b/content/en/docs/concepts/glossary.md @@ -117,8 +117,8 @@ pull-based. ### **Field** -Term used specifically for [`Log Records`](#log-record). See [`Attribute`](#attribute) -and the [field spec][field]. +Term used specifically for [`Log Records`](#log-record). See +[`Attribute`](#attribute) and the [field spec][field]. ### **gRPC** @@ -177,9 +177,9 @@ describes what happened, where it happened, etc. See [more][log record]. ### **Metadata** A name/value pair (e.g. `foo="bar"`) added to telemetry data. OpenTelemetry -generally calls this [`Attributes`](#attribute) though [`Metrics`](#metric) -have [`Dimensions`](#dimension) and [`Labels`](#label) while [`Logs`](#log) -have [`Fields`](#field). +generally calls this [`Attributes`](#attribute) though [`Metrics`](#metric) have +[`Dimensions`](#dimension) and [`Labels`](#label) while [`Logs](#log) have +[`Fields`](#field). ### **Metric** From cfbcf7473c31f905db00f41d0586a7ef53dd69c6 Mon Sep 17 00:00:00 2001 From: Steve Flanders Date: Tue, 5 Dec 2023 02:58:38 +0100 Subject: [PATCH 04/16] Update glossary.md --- content/en/docs/concepts/glossary.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/concepts/glossary.md b/content/en/docs/concepts/glossary.md index 7129f8893ad8..5fc3132134af 100644 --- a/content/en/docs/concepts/glossary.md +++ b/content/en/docs/concepts/glossary.md @@ -178,7 +178,7 @@ describes what happened, where it happened, etc. See [more][log record]. A name/value pair (e.g. `foo="bar"`) added to telemetry data. OpenTelemetry generally calls this [`Attributes`](#attribute) though [`Metrics`](#metric) have -[`Dimensions`](#dimension) and [`Labels`](#label) while [`Logs](#log) have +[`Dimensions`](#dimension) and [`Labels`](#label) while [`Logs`](#log) have [`Fields`](#field). ### **Metric** From 6680211519d6bec63e0b5ca02377c28a91dbf0f6 Mon Sep 17 00:00:00 2001 From: Steve Flanders Date: Thu, 7 Dec 2023 04:19:50 +0100 Subject: [PATCH 05/16] Update content/en/docs/concepts/glossary.md Co-authored-by: Fabrizio Ferri-Benedetti --- content/en/docs/concepts/glossary.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/en/docs/concepts/glossary.md b/content/en/docs/concepts/glossary.md index 5fc3132134af..4271a6ef018c 100644 --- a/content/en/docs/concepts/glossary.md +++ b/content/en/docs/concepts/glossary.md @@ -176,9 +176,9 @@ describes what happened, where it happened, etc. See [more][log record]. ### **Metadata** -A name/value pair (e.g. `foo="bar"`) added to telemetry data. OpenTelemetry -generally calls this [`Attributes`](#attribute) though [`Metrics`](#metric) have -[`Dimensions`](#dimension) and [`Labels`](#label) while [`Logs`](#log) have +A key-value pair, for example `foo="bar"`, added to telemetry data. OpenTelemetry +calls these pairs [`Attributes`](#attribute). In addition, [`Metrics`](#metric) have +[`Dimensions`](#dimension) and [`Labels`](#label), while [`Logs`](#log) have [`Fields`](#field). ### **Metric** From 95782b204950f8b12d224562f466175aec090f86 Mon Sep 17 00:00:00 2001 From: Steve Flanders Date: Sun, 10 Dec 2023 16:17:54 +0100 Subject: [PATCH 06/16] Update glossary.md --- content/en/docs/concepts/glossary.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/en/docs/concepts/glossary.md b/content/en/docs/concepts/glossary.md index 4271a6ef018c..539940b73436 100644 --- a/content/en/docs/concepts/glossary.md +++ b/content/en/docs/concepts/glossary.md @@ -118,7 +118,7 @@ pull-based. ### **Field** Term used specifically for [`Log Records`](#log-record). See -[`Attribute`](#attribute) and the [field spec][field]. +[`Metadata`](#metadata) and the [field spec][field]. ### **gRPC** @@ -150,7 +150,7 @@ Short for [JavaScript Object Notation][json]. ### **Label** -Term used specifically for [`Metrics`](#metric). See [`Attribute`](#attribute). +Term used specifically for [`Metrics`](#metric). See [`Metadata`](#metadata). ### **Language** From 564c60bd57b748afb4b9431e05492b73cf587d76 Mon Sep 17 00:00:00 2001 From: Steve Flanders Date: Tue, 12 Dec 2023 15:23:36 +0100 Subject: [PATCH 07/16] Update glossary.md --- content/en/docs/concepts/glossary.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/content/en/docs/concepts/glossary.md b/content/en/docs/concepts/glossary.md index 64d4ac66c76e..f427930c7605 100644 --- a/content/en/docs/concepts/glossary.md +++ b/content/en/docs/concepts/glossary.md @@ -122,8 +122,11 @@ pull-based. ### **Field** -Term used specifically for [`Log Records`](#log-record). See -[`Metadata`](#metadata) and the [field spec][field]. +Term used specifically for [`Log Records`](#log-record). +[`Metadata`](#metadata) can be added through defined fields, including +[`Attributes`](#attributes) and [`Resource`](#resource). Other fields may also +be considered metadata, including severity and trace information. See the +[field spec][field]. ### **gRPC** @@ -182,8 +185,8 @@ describes what happened, where it happened, etc. See [more][log record]. ### **Metadata** A key-value pair, for example `foo="bar"`, added to telemetry data. OpenTelemetry -calls these pairs [`Attributes`](#attribute). In addition, [`Metrics`](#metric) have -[`Dimensions`](#dimension) and [`Labels`](#label), while [`Logs`](#log) have +calls these pairs [`Attributes`](#attribute). In addition, [`Metrics`](#metric) +have [`Dimensions`](#dimension) and [`Labels`](#label), while [`Logs`](#log) have [`Fields`](#field). ### **Metric** From 4e522fbef7849da3dd8f643438f0c1e3a5340927 Mon Sep 17 00:00:00 2001 From: Steve Flanders Date: Tue, 12 Dec 2023 15:30:04 +0100 Subject: [PATCH 08/16] Update glossary.md --- content/en/docs/concepts/glossary.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/content/en/docs/concepts/glossary.md b/content/en/docs/concepts/glossary.md index f427930c7605..1081d4ee9ee8 100644 --- a/content/en/docs/concepts/glossary.md +++ b/content/en/docs/concepts/glossary.md @@ -122,11 +122,10 @@ pull-based. ### **Field** -Term used specifically for [`Log Records`](#log-record). -[`Metadata`](#metadata) can be added through defined fields, including -[`Attributes`](#attributes) and [`Resource`](#resource). Other fields may also -be considered metadata, including severity and trace information. See the -[field spec][field]. +Term used specifically for [`Log Records`](#log-record). [`Metadata`](#metadata) +can be added through defined fields, including [`Attributes`](#attributes) and +[`Resource`](#resource). Other fields may also be considered metadata, including +severity and trace information. See the [field spec][field]. ### **gRPC** @@ -184,10 +183,10 @@ describes what happened, where it happened, etc. See [more][log record]. ### **Metadata** -A key-value pair, for example `foo="bar"`, added to telemetry data. OpenTelemetry -calls these pairs [`Attributes`](#attribute). In addition, [`Metrics`](#metric) -have [`Dimensions`](#dimension) and [`Labels`](#label), while [`Logs`](#log) have -[`Fields`](#field). +A key-value pair, for example `foo="bar"`, added to telemetry data. +OpenTelemetry calls these pairs [`Attributes`](#attribute). In addition, +[`Metrics`](#metric) have [`Dimensions`](#dimension) and [`Labels`](#label), +while [`Logs`](#log) have [`Fields`](#field). ### **Metric** From 425ae9cd41b3623df6b3f7754463316dbefb2eca Mon Sep 17 00:00:00 2001 From: Steve Flanders Date: Tue, 12 Dec 2023 15:40:52 +0100 Subject: [PATCH 09/16] Update glossary.md --- content/en/docs/concepts/glossary.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/concepts/glossary.md b/content/en/docs/concepts/glossary.md index 1081d4ee9ee8..ec4558fc1e89 100644 --- a/content/en/docs/concepts/glossary.md +++ b/content/en/docs/concepts/glossary.md @@ -123,7 +123,7 @@ pull-based. ### **Field** Term used specifically for [`Log Records`](#log-record). [`Metadata`](#metadata) -can be added through defined fields, including [`Attributes`](#attributes) and +can be added through defined fields, including [`Attributes`](#attribute) and [`Resource`](#resource). Other fields may also be considered metadata, including severity and trace information. See the [field spec][field]. From 5ddd972d977abfa31751356699e2401a371a41b3 Mon Sep 17 00:00:00 2001 From: Steve Flanders Date: Wed, 13 Dec 2023 00:50:17 +0100 Subject: [PATCH 10/16] Update glossary.md --- content/en/docs/concepts/glossary.md | 36 +++++++++++++++------------- 1 file changed, 19 insertions(+), 17 deletions(-) diff --git a/content/en/docs/concepts/glossary.md b/content/en/docs/concepts/glossary.md index ec4558fc1e89..15132b39eece 100644 --- a/content/en/docs/concepts/glossary.md +++ b/content/en/docs/concepts/glossary.md @@ -36,8 +36,9 @@ alerting and tooling for finding the root cause. ### **Attribute** -See [`Metadata`](#metadata). Used across [`Signals`](#signal) and [`Resources`] -(#resource). See [attribute spec][attribute]. +OpenTelemetry's word for [`metadata`](#metadata). Adds key-value information to +the entity producing telemetry. Used across [`Signals`](#signal) and +[`Resources`](#resource). See [attribute spec][attribute]. ### **Automatic Instrumentation** @@ -92,7 +93,8 @@ See [`Signal`](#signal) ### **Dimension** -Term used specifically for [`Metrics`](#metric). See [`Attribute`](#attribute). +A term used specifically by [`Metrics`](#metric). See [`Attribute`](#attribute). + ### **Distributed Tracing** @@ -122,7 +124,7 @@ pull-based. ### **Field** -Term used specifically for [`Log Records`](#log-record). [`Metadata`](#metadata) +A term used specifically by [`Log Records`](#log-record). [`Metadata`](#metadata) can be added through defined fields, including [`Attributes`](#attribute) and [`Resource`](#resource). Other fields may also be considered metadata, including severity and trace information. See the [field spec][field]. @@ -157,7 +159,7 @@ Short for [JavaScript Object Notation][json]. ### **Label** -Term used specifically for [`Metrics`](#metric). See [`Metadata`](#metadata). +A term used specifically by [`Metrics`](#metric). See [`Metadata`](#metadata). ### **Language** @@ -170,7 +172,7 @@ A language-specific collection of behavior invoked by an interface. ### **Log** Sometimes used to refer to a collection of [`Log Records`](#log-record). May be -ambiguous, since people also sometimes use [`Log`](#log) to refer to a single +ambiguous since people also sometimes use [`Log`](#log) to refer to a single [`Log Record`](#log-record), thus this term should be used carefully and in the context where ambiguity is possible additional qualifiers should be used (e.g. `Log Record`). See [more][log]. @@ -183,10 +185,10 @@ describes what happened, where it happened, etc. See [more][log record]. ### **Metadata** -A key-value pair, for example `foo="bar"`, added to telemetry data. -OpenTelemetry calls these pairs [`Attributes`](#attribute). In addition, -[`Metrics`](#metric) have [`Dimensions`](#dimension) and [`Labels`](#label), -while [`Logs`](#log) have [`Fields`](#field). +A key-value pair, for example `foo="bar"`, added to an entity producing +telemetry. OpenTelemetry calls these pairs [`Attributes`](#attribute). In +addition, [`Metrics`](#metric) have [`Dimensions`](#dimension) an +[`Labels`](#label), while [`Logs`](#log) have [`Fields`](#field). ### **Metric** @@ -229,7 +231,7 @@ Short for [OpenTelemetry Protocol](/docs/specs/otlp/). ### **Processor** -Operation performed on data between being received and being exported. For +The operation performed on data between being received and being exported. For example, batching. Used by ['Instrumentation Libraries'](#instrumentation-library) and the [Collector](/docs/collector/configuration/#processors). @@ -245,7 +247,7 @@ Language independent interface types. See [more][proto]. ### **Receiver** -Term used by the [`Collector`](/docs/collector/configuration/#receivers) to +The term used by the [`Collector`](/docs/collector/configuration/#receivers) to define how telemetry data is received. Receivers can be push- or pull-based. See [more][receiver]. @@ -255,11 +257,11 @@ See [`Distributed Tracing`](#distributed-tracing). ### **Resource** -Captures information about the entity for which telemetry is recorded. For -example, a process producing telemetry that is running in a container on -Kubernetes has a pod name, it is in a namespace and possibly is part of a -deployment which also has a name. All three of these attributes can be included -in the `Resource` and applied to any data source. +Captures information about the entity producing telemetry as +[`Attributes`](#attributes). For example, a process producing telemetry that is +running in a container on Kubernetes has a process name, a pod name, a namespace, +and possibly a deployment name. All four of these attributes can be included in +the `Resource`. ### **REST** From c50256915900cfd3f6b97199b335d4da247f9e51 Mon Sep 17 00:00:00 2001 From: Steve Flanders Date: Wed, 13 Dec 2023 00:59:21 +0100 Subject: [PATCH 11/16] Update glossary.md --- content/en/docs/concepts/glossary.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/content/en/docs/concepts/glossary.md b/content/en/docs/concepts/glossary.md index 15132b39eece..0f305540a681 100644 --- a/content/en/docs/concepts/glossary.md +++ b/content/en/docs/concepts/glossary.md @@ -124,10 +124,11 @@ pull-based. ### **Field** -A term used specifically by [`Log Records`](#log-record). [`Metadata`](#metadata) -can be added through defined fields, including [`Attributes`](#attribute) and -[`Resource`](#resource). Other fields may also be considered metadata, including -severity and trace information. See the [field spec][field]. +A term used specifically by [`Log Records`](#log-record). +[`Metadata`](#metadata) can be added through defined fields, including +[`Attributes`](#attribute) and [`Resource`](#resource). Other fields may also be +considered metadata, including severity and trace information. See the [field +spec][field]. ### **gRPC** @@ -259,9 +260,9 @@ See [`Distributed Tracing`](#distributed-tracing). Captures information about the entity producing telemetry as [`Attributes`](#attributes). For example, a process producing telemetry that is -running in a container on Kubernetes has a process name, a pod name, a namespace, -and possibly a deployment name. All four of these attributes can be included in -the `Resource`. +running in a container on Kubernetes has a process name, a pod name, a +namespace, and possibly a deployment name. All four of these attributes can be +included in the `Resource`. ### **REST** From f18d18e03f503eb53b0f7a7bcb5a6d5ffad13acb Mon Sep 17 00:00:00 2001 From: Steve Flanders Date: Wed, 13 Dec 2023 02:35:05 +0100 Subject: [PATCH 12/16] Update glossary.md From ec4e6450eb585b73b737236a59a15bef85092f92 Mon Sep 17 00:00:00 2001 From: Steve Flanders Date: Wed, 13 Dec 2023 02:38:57 +0100 Subject: [PATCH 13/16] Update glossary.md --- content/en/docs/concepts/glossary.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/en/docs/concepts/glossary.md b/content/en/docs/concepts/glossary.md index 0f305540a681..bbc9403addd7 100644 --- a/content/en/docs/concepts/glossary.md +++ b/content/en/docs/concepts/glossary.md @@ -127,8 +127,8 @@ pull-based. A term used specifically by [`Log Records`](#log-record). [`Metadata`](#metadata) can be added through defined fields, including [`Attributes`](#attribute) and [`Resource`](#resource). Other fields may also be -considered metadata, including severity and trace information. See the [field -spec][field]. +considered metadata, including severity and trace information. See the +[field spec][field]. ### **gRPC** From ca3330fc43493087a0aac8c2eff7c8ccf070db6b Mon Sep 17 00:00:00 2001 From: Steve Flanders Date: Wed, 13 Dec 2023 02:45:08 +0100 Subject: [PATCH 14/16] Update glossary.md --- content/en/docs/concepts/glossary.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/content/en/docs/concepts/glossary.md b/content/en/docs/concepts/glossary.md index bbc9403addd7..264f3669bf55 100644 --- a/content/en/docs/concepts/glossary.md +++ b/content/en/docs/concepts/glossary.md @@ -36,7 +36,7 @@ alerting and tooling for finding the root cause. ### **Attribute** -OpenTelemetry's word for [`metadata`](#metadata). Adds key-value information to +OpenTelemetry's word for [`Metadata`](#metadata). Adds key-value information to the entity producing telemetry. Used across [`Signals`](#signal) and [`Resources`](#resource). See [attribute spec][attribute]. @@ -95,7 +95,6 @@ See [`Signal`](#signal) A term used specifically by [`Metrics`](#metric). See [`Attribute`](#attribute). - ### **Distributed Tracing** Tracks the progression of a single [`Request`](#request), called a @@ -127,7 +126,7 @@ pull-based. A term used specifically by [`Log Records`](#log-record). [`Metadata`](#metadata) can be added through defined fields, including [`Attributes`](#attribute) and [`Resource`](#resource). Other fields may also be -considered metadata, including severity and trace information. See the +considered `Metadata`, including severity and trace information. See the [field spec][field]. ### **gRPC** From 5f8010071e4f7b3193b1e461a156832de5363117 Mon Sep 17 00:00:00 2001 From: Steve Flanders Date: Wed, 13 Dec 2023 02:49:03 +0100 Subject: [PATCH 15/16] Update glossary.md --- content/en/docs/concepts/glossary.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/en/docs/concepts/glossary.md b/content/en/docs/concepts/glossary.md index 264f3669bf55..a5dc90a5d030 100644 --- a/content/en/docs/concepts/glossary.md +++ b/content/en/docs/concepts/glossary.md @@ -126,8 +126,8 @@ pull-based. A term used specifically by [`Log Records`](#log-record). [`Metadata`](#metadata) can be added through defined fields, including [`Attributes`](#attribute) and [`Resource`](#resource). Other fields may also be -considered `Metadata`, including severity and trace information. See the -[field spec][field]. +considered `Metadata`, including severity and trace information. See the [field +spec][field]. ### **gRPC** From 633b5c4909aee1f016ffce1865d0c32f1621216c Mon Sep 17 00:00:00 2001 From: Phillip Carter Date: Sat, 16 Dec 2023 15:32:00 +0000 Subject: [PATCH 16/16] fix build --- content/en/docs/concepts/glossary.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/concepts/glossary.md b/content/en/docs/concepts/glossary.md index a5dc90a5d030..369e0cc8aab5 100644 --- a/content/en/docs/concepts/glossary.md +++ b/content/en/docs/concepts/glossary.md @@ -258,7 +258,7 @@ See [`Distributed Tracing`](#distributed-tracing). ### **Resource** Captures information about the entity producing telemetry as -[`Attributes`](#attributes). For example, a process producing telemetry that is +[`Attributes`](#attribute). For example, a process producing telemetry that is running in a container on Kubernetes has a process name, a pod name, a namespace, and possibly a deployment name. All four of these attributes can be included in the `Resource`.