Skip to content

Commit

Permalink
Fix yaml schema violations and formatting (#1326)
Browse files Browse the repository at this point in the history
  • Loading branch information
lmolkova committed Aug 20, 2024
1 parent bcc3805 commit 40db676
Show file tree
Hide file tree
Showing 12 changed files with 267 additions and 243 deletions.
3 changes: 2 additions & 1 deletion model/messaging-common.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,11 @@ groups:
- id: attributes.messaging.common.minimal
type: attribute_group
brief: "Common cross-signal messaging attributes."
stability: experimental
attributes:
# TODO: Not adding `messaging.system` to the minimal because of https://github.com/open-telemetry/build-tools/issues/192
- ref: error.type
examples: ['amqp:decode-error', 'KAFKA_STORAGE_ERROR', 'channel-error']
examples: ["amqp:decode-error", "KAFKA_STORAGE_ERROR", "channel-error"]
requirement_level:
conditionally_required: If and only if the messaging operation has failed.
- ref: server.address
Expand Down
114 changes: 61 additions & 53 deletions model/registry/aws.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -260,13 +260,16 @@ groups:
stability: experimental
brief: >
The Amazon Resource Name (ARN) of an [ECS container instance](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ECS_instances.html).
examples: ['arn:aws:ecs:us-west-1:123456789123:container/32624152-9086-4f0e-acae-1a75b14fe4d9']
examples:
[
"arn:aws:ecs:us-west-1:123456789123:container/32624152-9086-4f0e-acae-1a75b14fe4d9",
]
- id: aws.ecs.cluster.arn
type: string
stability: experimental
brief: >
The ARN of an [ECS cluster](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/clusters.html).
examples: ['arn:aws:ecs:us-west-2:123456789123:cluster/my-cluster']
examples: ["arn:aws:ecs:us-west-2:123456789123:cluster/my-cluster"]
- id: aws.ecs.launchtype
type:
members:
Expand All @@ -284,24 +287,29 @@ groups:
stability: experimental
brief: >
The ARN of a running [ECS task](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids).
examples: [
'arn:aws:ecs:us-west-1:123456789123:task/10838bed-421f-43ef-870a-f43feacbbb5b',
'arn:aws:ecs:us-west-1:123456789123:task/my-cluster/task-id/23ebb8ac-c18f-46c6-8bbe-d55d0e37cfbd'
]
examples:
[
"arn:aws:ecs:us-west-1:123456789123:task/10838bed-421f-43ef-870a-f43feacbbb5b",
"arn:aws:ecs:us-west-1:123456789123:task/my-cluster/task-id/23ebb8ac-c18f-46c6-8bbe-d55d0e37cfbd"
]
- id: aws.ecs.task.family
type: string
stability: experimental
brief: >
The family name of the [ECS task definition](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html) used to create the ECS task.
examples: ['opentelemetry-family']
examples: ["opentelemetry-family"]
- id: aws.ecs.task.id
type: string
stability: experimental
brief: >
The ID of a running ECS task. The ID MUST be extracted from `task.arn`.
requirement_level:
conditionally_required: If and only if `task.arn` is populated.
examples: [ '10838bed-421f-43ef-870a-f43feacbbb5b', '23ebb8ac-c18f-46c6-8bbe-d55d0e37cfbd' ]
examples:
[
"10838bed-421f-43ef-870a-f43feacbbb5b",
"23ebb8ac-c18f-46c6-8bbe-d55d0e37cfbd"
]
- id: aws.ecs.task.revision
type: string
stability: experimental
Expand All @@ -319,7 +327,7 @@ groups:
stability: experimental
brief: >
The ARN of an EKS cluster.
examples: ['arn:aws:ecs:us-west-2:123456789123:cluster/my-cluster']
examples: ["arn:aws:ecs:us-west-2:123456789123:cluster/my-cluster"]
- id: registry.aws.log
type: attribute_group
display_name: Amazon Logs Attributes
Expand All @@ -332,7 +340,7 @@ groups:
brief: >
The name(s) of the AWS log group(s) an application is writing to.
examples:
- ['/aws/lambda/my-function', 'opentelemetry-service']
- ["/aws/lambda/my-function", "opentelemetry-service"]
note: >
Multiple log groups must be supported for cases like multi-container applications,
where a single application has sidecar containers, and each write to their own log
Expand All @@ -343,7 +351,7 @@ groups:
brief: >
The Amazon Resource Name(s) (ARN) of the AWS log group(s).
examples:
- ['arn:aws:logs:us-west-1:123456789012:log-group:/aws/my/group:*']
- ["arn:aws:logs:us-west-1:123456789012:log-group:/aws/my/group:*"]
note: >
See the
[log group ARN format documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html#CWL_ARN_Format).
Expand All @@ -353,14 +361,14 @@ groups:
brief: >
The name(s) of the AWS log stream(s) an application is writing to.
examples:
- ['logs/main/10838bed-421f-43ef-870a-f43feacbbb5b']
- ["logs/main/10838bed-421f-43ef-870a-f43feacbbb5b"]
- id: aws.log.stream.arns
type: string[]
stability: experimental
brief: >
The ARN(s) of the AWS log stream(s).
examples:
- ['arn:aws:logs:us-west-1:123456789012:log-group:/aws/my/group:log-stream:logs/main/10838bed-421f-43ef-870a-f43feacbbb5b']
- ["arn:aws:logs:us-west-1:123456789012:log-group:/aws/my/group:log-stream:logs/main/10838bed-421f-43ef-870a-f43feacbbb5b"]
note: >
See the
[log stream ARN format documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html#CWL_ARN_Format).
Expand All @@ -380,7 +388,7 @@ groups:
The full invoked ARN as provided on the `Context` passed to the function
(`Lambda-Runtime-Invoked-Function-Arn` header on the `/runtime/invocation/next` applicable).
note: This may be different from `cloud.resource_id` if an alias is involved.
examples: ['arn:aws:lambda:us-east-1:123456:function:myfunction:myalias']
examples: ["arn:aws:lambda:us-east-1:123456:function:myfunction:myalias"]
- id: registry.aws.s3
type: attribute_group
display_name: Amazon S3 Attributes
Expand All @@ -394,78 +402,78 @@ groups:
examples:
- some-bucket-name
note: |
The `bucket` attribute is applicable to all S3 operations that reference a bucket, i.e. that require the bucket name as a mandatory parameter.
This applies to almost all S3 operations except `list-buckets`.
The `bucket` attribute is applicable to all S3 operations that reference a bucket, i.e. that require the bucket name as a mandatory parameter.
This applies to almost all S3 operations except `list-buckets`.
- id: aws.s3.key
type: string
stability: experimental
brief: "The S3 object key the request refers to. Corresponds to the `--key` parameter of the [S3 API](https://docs.aws.amazon.com/cli/latest/reference/s3api/index.html) operations."
examples:
- someFile.yml
note: |
The `key` attribute is applicable to all object-related S3 operations, i.e. that require the object key as a mandatory parameter.
This applies in particular to the following operations:
The `key` attribute is applicable to all object-related S3 operations, i.e. that require the object key as a mandatory parameter.
This applies in particular to the following operations:
- [copy-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/copy-object.html)
- [delete-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/delete-object.html)
- [get-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/get-object.html)
- [head-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/head-object.html)
- [put-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/put-object.html)
- [restore-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/restore-object.html)
- [select-object-content](https://docs.aws.amazon.com/cli/latest/reference/s3api/select-object-content.html)
- [abort-multipart-upload](https://docs.aws.amazon.com/cli/latest/reference/s3api/abort-multipart-upload.html)
- [complete-multipart-upload](https://docs.aws.amazon.com/cli/latest/reference/s3api/complete-multipart-upload.html)
- [create-multipart-upload](https://docs.aws.amazon.com/cli/latest/reference/s3api/create-multipart-upload.html)
- [list-parts](https://docs.aws.amazon.com/cli/latest/reference/s3api/list-parts.html)
- [upload-part](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part.html)
- [upload-part-copy](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part-copy.html)
- [copy-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/copy-object.html)
- [delete-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/delete-object.html)
- [get-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/get-object.html)
- [head-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/head-object.html)
- [put-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/put-object.html)
- [restore-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/restore-object.html)
- [select-object-content](https://docs.aws.amazon.com/cli/latest/reference/s3api/select-object-content.html)
- [abort-multipart-upload](https://docs.aws.amazon.com/cli/latest/reference/s3api/abort-multipart-upload.html)
- [complete-multipart-upload](https://docs.aws.amazon.com/cli/latest/reference/s3api/complete-multipart-upload.html)
- [create-multipart-upload](https://docs.aws.amazon.com/cli/latest/reference/s3api/create-multipart-upload.html)
- [list-parts](https://docs.aws.amazon.com/cli/latest/reference/s3api/list-parts.html)
- [upload-part](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part.html)
- [upload-part-copy](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part-copy.html)
- id: aws.s3.copy_source
type: string
stability: experimental
brief: "The source object (in the form `bucket`/`key`) for the copy operation."
examples:
- someFile.yml
note: |
The `copy_source` attribute applies to S3 copy operations and corresponds to the `--copy-source` parameter
of the [copy-object operation within the S3 API](https://docs.aws.amazon.com/cli/latest/reference/s3api/copy-object.html).
This applies in particular to the following operations:
The `copy_source` attribute applies to S3 copy operations and corresponds to the `--copy-source` parameter
of the [copy-object operation within the S3 API](https://docs.aws.amazon.com/cli/latest/reference/s3api/copy-object.html).
This applies in particular to the following operations:
- [copy-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/copy-object.html)
- [upload-part-copy](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part-copy.html)
- [copy-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/copy-object.html)
- [upload-part-copy](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part-copy.html)
- id: aws.s3.upload_id
type: string
stability: experimental
brief: "Upload ID that identifies the multipart upload."
examples:
- 'dfRtDYWFbkRONycy.Yxwh66Yjlx.cph0gtNBtJ'
- "dfRtDYWFbkRONycy.Yxwh66Yjlx.cph0gtNBtJ"
note: |
The `upload_id` attribute applies to S3 multipart-upload operations and corresponds to the `--upload-id` parameter
of the [S3 API](https://docs.aws.amazon.com/cli/latest/reference/s3api/index.html) multipart operations.
This applies in particular to the following operations:
The `upload_id` attribute applies to S3 multipart-upload operations and corresponds to the `--upload-id` parameter
of the [S3 API](https://docs.aws.amazon.com/cli/latest/reference/s3api/index.html) multipart operations.
This applies in particular to the following operations:
- [abort-multipart-upload](https://docs.aws.amazon.com/cli/latest/reference/s3api/abort-multipart-upload.html)
- [complete-multipart-upload](https://docs.aws.amazon.com/cli/latest/reference/s3api/complete-multipart-upload.html)
- [list-parts](https://docs.aws.amazon.com/cli/latest/reference/s3api/list-parts.html)
- [upload-part](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part.html)
- [upload-part-copy](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part-copy.html)
- [abort-multipart-upload](https://docs.aws.amazon.com/cli/latest/reference/s3api/abort-multipart-upload.html)
- [complete-multipart-upload](https://docs.aws.amazon.com/cli/latest/reference/s3api/complete-multipart-upload.html)
- [list-parts](https://docs.aws.amazon.com/cli/latest/reference/s3api/list-parts.html)
- [upload-part](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part.html)
- [upload-part-copy](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part-copy.html)
- id: aws.s3.delete
type: string
stability: experimental
brief: "The delete request container that specifies the objects to be deleted."
examples:
- 'Objects=[{Key=string,VersionId=string},{Key=string,VersionId=string}],Quiet=boolean'
- "Objects=[{Key=string,VersionId=string},{Key=string,VersionId=string}],Quiet=boolean"
note: |
The `delete` attribute is only applicable to the [delete-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/delete-object.html) operation.
The `delete` attribute corresponds to the `--delete` parameter of the
[delete-objects operation within the S3 API](https://docs.aws.amazon.com/cli/latest/reference/s3api/delete-objects.html).
The `delete` attribute is only applicable to the [delete-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/delete-object.html) operation.
The `delete` attribute corresponds to the `--delete` parameter of the
[delete-objects operation within the S3 API](https://docs.aws.amazon.com/cli/latest/reference/s3api/delete-objects.html).
- id: aws.s3.part_number
type: int
stability: experimental
brief: "The part number of the part being uploaded in a multipart-upload operation. This is a positive integer between 1 and 10,000."
examples:
- 3456
note: |
The `part_number` attribute is only applicable to the [upload-part](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part.html)
and [upload-part-copy](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part-copy.html) operations.
The `part_number` attribute corresponds to the `--part-number` parameter of the
[upload-part operation within the S3 API](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part.html).
The `part_number` attribute is only applicable to the [upload-part](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part.html)
and [upload-part-copy](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part-copy.html) operations.
The `part_number` attribute corresponds to the `--part-number` parameter of the
[upload-part operation within the S3 API](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part.html).
7 changes: 4 additions & 3 deletions model/registry/code.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ groups:
brief: >
A stacktrace as a string in the natural representation for the language runtime.
The representation is to be determined and documented by each language SIG.
examples: 'at com.example.GenerateTrace.methodB(GenerateTrace.java:13)\n
at com.example.GenerateTrace.methodA(GenerateTrace.java:9)\n
at com.example.GenerateTrace.main(GenerateTrace.java:5)'
examples: >
at com.example.GenerateTrace.methodB(GenerateTrace.java:13)\n
at com.example.GenerateTrace.methodA(GenerateTrace.java:9)\n
at com.example.GenerateTrace.main(GenerateTrace.java:5)
Loading

0 comments on commit 40db676

Please sign in to comment.