Make fields plurals and enhance descriptions

Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
open-telemetry · Aug 3, 2023 · adacd83 · adacd83
1 parent 3581275
commit adacd83
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 5 deletions.
diff --git a/docs/resource/container.md b/docs/resource/container.md
@@ -13,7 +13,7 @@
 | `container.id` | string | Container ID. Usually a UUID, as for example used to [identify Docker containers](https://docs.docker.com/engine/reference/run/#container-identification). The UUID might be abbreviated. | `a3bf90e006b2` | Recommended |
 | `container.runtime` | string | The container runtime managing this container. | `docker`; `containerd`; `rkt` | Recommended |
 | `container.image.name` | string | Name of the image the container was built on. | `gcr.io/opentelemetry/operator` | Recommended |
-| `container.image.tag` | string[] | Container image tags. An example can be found in [Docker Image Inspect](https://docs.docker.com/engine/api/v1.43/#tag/Image/operation/ImageInspect). Should be only the `<tag>` section of the full name for example from `registry.example.com/my-org/my-image:<tag>`. | `[v1.27.1, 3.5.7-0]` | Recommended |
+| `container.image.tags` | string[] | Container image tags. An example can be found in [Docker Image Inspect](https://docs.docker.com/engine/api/v1.43/#tag/Image/operation/ImageInspect). Should be only the `<tag>` section of the full name for example from `registry.example.com/my-org/my-image:<tag>`. | `[v1.27.1, 3.5.7-0]` | Recommended |
 | `container.image.id` | string | Runtime specific image identifier. Usually a hash algorithm followed by a UUID. [1] | `sha256:19c92d0a00d1b66d897bceaa7319bee0dd38a10a851c60bcec9474aa3f01e50f` | Recommended |
 | `container.command` | string | The command used to run the container (i.e. the command name). [2] | `otelcontribcol` | Opt-In |
 | `container.command_line` | string | The full command run by the container as a single string representing the full command. [2] | `otelcontribcol --config config.yaml` | Opt-In |
@@ -37,7 +37,7 @@ The ID of the same image running in different environments don't not always matc
 <!-- semconv oci -->
 | Attribute  | Type | Description  | Examples  | Requirement Level |
 |---|---|---|---|---|
-| `oci.manifest.digest` | string | The digest of the OCI image manifest. Follows [OCI Image Manifest Specification](https://github.com/opencontainers/image-spec/blob/main/manifest.md), and specifically the [Digest property](https://github.com/opencontainers/image-spec/blob/main/descriptor.md#digests). An example can be found in [Example Image Manifest](https://docs.docker.com/registry/spec/manifest-v2-2/#example-image-manifest). | `sha256:e4ca62c0d62f3e886e684806dfe9d4e0cda60d54986898173c1083856cfda0f4`; `sha256:3c3a4604a545cdc127456d94e421cd355bca5b528f4a9c1905b15da2eb4a4c6b` | Recommended |
+| `oci.manifest.digests` | string | The digest(s) of the OCI image manifest. For container images specifically it can be one or more digests by which the container image is known. Follows [OCI Image Manifest Specification](https://github.com/opencontainers/image-spec/blob/main/manifest.md), and specifically the [Digest property](https://github.com/opencontainers/image-spec/blob/main/descriptor.md#digests). An example can be found in [Example Image Manifest](https://docs.docker.com/registry/spec/manifest-v2-2/#example-image-manifest). [Docker](https://docs.docker.com/engine/api/v1.43/#tag/Image/operation/ImageCreate) and  [CRI](https://github.com/kubernetes/cri-api/blob/c75ef5b473bbe2d0a4fc92f82235efd665ea8e9f/pkg/apis/runtime/v1/api.proto#L1237-L1238)  reports those under the `RepoDigests` field. | `sha256:e4ca62c0d62f3e886e684806dfe9d4e0cda60d54986898173c1083856cfda0f4`; `sha256:3c3a4604a545cdc127456d94e421cd355bca5b528f4a9c1905b15da2eb4a4c6b` | Recommended |
 <!-- endsemconv -->
 
 [DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/tree/v1.22.0/specification/document-status.md
diff --git a/model/resource/container.yaml b/model/resource/container.yaml
@@ -27,7 +27,7 @@ groups:
         brief: >
           Name of the image the container was built on.
         examples: ['gcr.io/opentelemetry/operator']
-      - id: image.tag
+      - id: image.tags
         type: string[]
         brief: >
           Container image tags. An example can be found in

diff --git a/model/resource/oci.yaml b/model/resource/oci.yaml
@@ -5,14 +5,18 @@ groups:
     brief: >
       An OCI instance.
     attributes:
-      - id: manifest.digest
+      - id: manifest.digests
         type: string
         brief: >
-          The digest of the OCI image manifest.
+          The digest(s) of the OCI image manifest. For container images specifically it can be one or more
+          digests by which the container image is known.
           Follows
           [OCI Image Manifest Specification](https://github.com/opencontainers/image-spec/blob/main/manifest.md),
           and specifically the
           [Digest property](https://github.com/opencontainers/image-spec/blob/main/descriptor.md#digests).
           An example can be found in
           [Example Image Manifest](https://docs.docker.com/registry/spec/manifest-v2-2/#example-image-manifest).
+          [Docker](https://docs.docker.com/engine/api/v1.43/#tag/Image/operation/ImageCreate) and 
+          [CRI](https://github.com/kubernetes/cri-api/blob/c75ef5b473bbe2d0a4fc92f82235efd665ea8e9f/pkg/apis/runtime/v1/api.proto#L1237-L1238) 
+          reports those under the `RepoDigests` field.
         examples: [ 'sha256:e4ca62c0d62f3e886e684806dfe9d4e0cda60d54986898173c1083856cfda0f4', 'sha256:3c3a4604a545cdc127456d94e421cd355bca5b528f4a9c1905b15da2eb4a4c6b' ]