Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add semantic conventions for cloud provider-specific resource attributes #1099

Merged
merged 9 commits into from
Nov 25, 2020
Prev Previous commit
Next Next commit
changed log attribs to be string arrays
  • Loading branch information
William Armiros committed Oct 19, 2020
commit b8d4c0d99329daef2d5706a93b8f4eae1ae624e8
20 changes: 12 additions & 8 deletions semantic_conventions/resource/cloud_provider/aws/logs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,27 +5,31 @@ groups:
Resources specific to Amazon Web Services.
attributes:
- id: group.name
type: string
type: string[]
brief: >
The name of the AWS log group an application is writing to.
The name of the AWS log groups an application is writing to.
examples: ['/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
group.
- id: group.arn
type: string
type: string[]
brief: >
The Amazon Resource Name (ARN) of an AWS log group.
The Amazon Resource Names (ARN) of the AWS log groups.
examples: ['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).
- id: stream.name
type: string
type: string[]
brief: >
The name of the AWS log stream an application is writing to.
The name of the AWS log streams an application is writing to.
examples: ['logs/main/10838bed-421f-43ef-870a-f43feacbbb5b']
- id: stream.arn
type: string
type: string[]
brief: >
The ARN of the AWS log stream.
The ARNs of the AWS log streams.
examples: ['arn:aws:logs:us-west-1:123456789012:log-group:/aws/my/group:log-stream:logs/main/10838bed-421f-43ef-870a-f43feacbbb5b']
note: >
See the
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,14 @@
<!-- semconv aws.log -->
| Attribute | Type | Description | Example | Required |
|---|---|---|---|---|
| `aws.log.group.name` | string | The name of the AWS log group an application is writing to. | `/aws/lambda/my-function`<br>`opentelemetry-service` | No |
| `aws.log.group.arn` | string | The Amazon Resource Name (ARN) of an AWS log group. [1] | `arn:aws:logs:us-west-1:123456789012:log-group:/aws/my/group:*` | No |
| `aws.log.stream.name` | string | The name of the AWS log stream an application is writing to. | `logs/main/10838bed-421f-43ef-870a-f43feacbbb5b` | No |
| `aws.log.stream.arn` | string | The ARN of the AWS log stream. [2] | `arn:aws:logs:us-west-1:123456789012:log-group:/aws/my/group:log-stream:logs/main/10838bed-421f-43ef-870a-f43feacbbb5b` | No |
| `aws.log.group.name` | string[] | The name of the AWS log groups an application is writing to. [1] | `/aws/lambda/my-function`<br>`opentelemetry-service` | No |
| `aws.log.group.arn` | string[] | The Amazon Resource Names (ARN) of the AWS log groups. [2] | `arn:aws:logs:us-west-1:123456789012:log-group:/aws/my/group:*` | No |
| `aws.log.stream.name` | string[] | The name of the AWS log streams an application is writing to. | `logs/main/10838bed-421f-43ef-870a-f43feacbbb5b` | No |
| `aws.log.stream.arn` | string[] | The ARNs of the AWS log streams. [3] | `arn:aws:logs:us-west-1:123456789012:log-group:/aws/my/group:log-stream:logs/main/10838bed-421f-43ef-870a-f43feacbbb5b` | No |

**[1]:** See the [log group ARN format documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html#CWL_ARN_Format).
**[1]:** 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 group.

**[2]:** See the [log stream ARN format documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html#CWL_ARN_Format). One log group can contain several log streams, so this ARN necessarily identifies both a log group and a log stream.
**[2]:** See the [log group ARN format documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html#CWL_ARN_Format).

**[3]:** See the [log stream ARN format documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html#CWL_ARN_Format). One log group can contain several log streams, so this ARN necessarily identifies both a log group and a log stream.
<!-- endsemconv -->