Skip to content

Commit

Permalink
apply wording suggestions
Browse files Browse the repository at this point in the history
  • Loading branch information
BinaryFissionGames committed Sep 9, 2024
1 parent 4fbdc8c commit 1cfdaef
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions specification.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
{
Expand Down

0 comments on commit 1cfdaef

Please sign in to comment.