From 1cfdaef631da9ddca148822dc1a3d4963c9ca32d Mon Sep 17 00:00:00 2001 From: Brandon Johnson <brandon.johnson@observiq.com> Date: Mon, 9 Sep 2024 10:45:13 -0400 Subject: [PATCH] apply wording suggestions --- specification.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/specification.md b/specification.md index 5ca7452..b77d870 100644 --- a/specification.md +++ b/specification.md @@ -1168,10 +1168,12 @@ This field gives a description of what components are available, as well as extra metadata about the components. The structure of ComponentDetails DOES NOT need to be a 1-to-1 match with -the ComponentHealth structure. ComponentHealth generally refers to instances of -components, while ComponentDetails refers to the available types of components. +the ComponentHealth structure. ComponentHealth generally refers to currently running instances of +components, while ComponentDetails refers to the available types of components, +which may not be necessarily running currently. It is also possible that the same component +type may have more than one running instance. -This field is not required to be specified. +This is an optional field. #### ComponentDetails Message @@ -1203,7 +1205,7 @@ describe the underlying system. ###### OpenTelemetry Collector Here is an example of how ComponentDetails could hold information regarding the included -components for a custom build collector: +components for a custom build of [OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector):: ```jsonc {