Skip to content

Commit f157972

Browse files
authored
Update information about CW Logs metadata translation (#405)
1 parent 0a8ceda commit f157972

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

src/docs/getting-started/x-ray.mdx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -184,12 +184,14 @@ exporters:
184184

185185
##### OTel span CW Logs metadata translation
186186

187+
The attributes in this section are translated into the AWS resource field `cloudwatch_logs`. This resource field is used to correlate Cloudwatch Log Groups with the segments associated with it. This correlation can be explored when analyzing individual traces in the X-Ray console.
188+
187189
| OTel Attributes env var | X-Ray data model field | Notes |
188190
|-------------------------|---------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
189-
| aws.log.group.arns | cloudwatch_logs.arn | <ul><li> If value of aws.log.group.arns is not an empty slice, then the exporter creates a CloudWatch log object with log group and ARN for all ARNs. If aws.log.group.arns value is an empty slice and value of aws.log.group.names is not an empty slice, then exporter creates a CloudWatch log object with only a log group. </li></ul> |
190-
| aws.log.group.names | cloudwatch_logs.log_group | |
191+
| aws.log.group.arns | cloudwatch_logs.arn | |
192+
| aws.log.group.names | cloudwatch_logs.log_group | If both `aws.log.group.arns` and `aws.log.group.names` are defined, precedence is given to `aws.log.group.arns` |
191193

192-
See [AWS X-Ray Segment Documents](https://docs.aws.amazon.com/xray/latest/devguide/xray-api-segmentdocuments.html) for more information on the AWS X-Ray data model. See [OpenTelemetry data model spec](https://github.com/open-telemetry/opentelemetry-specification) for more information on OpenTelemetry data model.
194+
See [AWS X-Ray Segment Documents](https://docs.aws.amazon.com/xray/latest/devguide/xray-api-segmentdocuments.html) for more information on the AWS X-Ray data model. See [OpenTelemetry data model spec](https://github.com/open-telemetry/opentelemetry-specification) for more information on OpenTelemetry data model. See [X-Ray Logging Configuration](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-java-configuration.html#xray-sdk-java-configuration-logging) for references of expected log pattern.
193195

194196
### Enable The Customized X-Ray Annotations
195197
By using OpenTelemetry SDK, we can add the customized attributes for each trace subsegment. By default, these OpenTelemetry

0 commit comments

Comments
 (0)