Skip to content

Commit

Permalink
Set command attributes as conditionally required
Browse files Browse the repository at this point in the history
  • Loading branch information
marcsanmi committed May 26, 2023
1 parent dff7705 commit 07d4faa
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 5 deletions.
8 changes: 6 additions & 2 deletions semantic_conventions/resource/container.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -39,18 +39,22 @@ groups:
examples: ['sha256:f90d814248a0']
- id: command
type: string
requirement_level:
conditionally_required: If using embedded credentials or sensitive data, it is recommended to remove them to prevent potential leakage.
brief: >
The command used to run the container (i.e. the command name).
examples: [ 'otelcontribcol' ]
- id: command_line
type: string
requirement_level:
conditionally_required: [1]
brief: >
The full command run by the container as a single string representing the full command.
It is recommended to remove embedded credentials or sensitive data to prevent potential leakage.
examples: [ 'otelcontribcol --config config.yaml' ]
- id: command_args
type: string[]
requirement_level:
conditionally_required: [1]
brief: >
All the command arguments (including the command/executable itself) run by the container.
It is recommended to remove embedded credentials or sensitive data to prevent potential leakage.
examples: [ 'otelcontribcol, --config, config.yaml' ]
8 changes: 5 additions & 3 deletions specification/resource/semantic_conventions/container.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,11 @@
| `container.image.name` | string | Name of the image the container was built on. | `gcr.io/opentelemetry/operator` | Recommended |
| `container.image.tag` | string | Container image tag. | `0.1` | Recommended |
| `container.image.id` | string | The ID of the container image. Usually a hash algorithm followed by a UUID. The UUID might be abbreviated. | `sha256:f90d814248a0` | Recommended |
| `container.command` | string | The command used to run the container (i.e. the command name). | `otelcontribcol` | Recommended |
| `container.command_line` | string | The full command run by the container as a single string representing the full command. It is recommended to remove embedded credentials or sensitive data to prevent potential leakage. | `otelcontribcol --config config.yaml` | Recommended |
| `container.command_args` | string[] | All the command arguments (including the command/executable itself) run by the container. It is recommended to remove embedded credentials or sensitive data to prevent potential leakage. | `[otelcontribcol, --config, config.yaml]` | Recommended |
| `container.command` | string | The command used to run the container (i.e. the command name). | `otelcontribcol` | Conditionally Required: [1] |
| `container.command_line` | string | The full command run by the container as a single string representing the full command. | `otelcontribcol --config config.yaml` | Conditionally Required: [1] |
| `container.command_args` | string[] | All the command arguments (including the command/executable itself) run by the container. | `[otelcontribcol, --config, config.yaml]` | Conditionally Required: [1] |

**[1]:** If using embedded credentials or sensitive data, it is recommended to remove them to prevent potential leakage.
<!-- endsemconv -->

[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md

0 comments on commit 07d4faa

Please sign in to comment.