Skip to content

Commit

Permalink
[exporter/awsxray] docs: fix request timeout docs (#20532)
Browse files Browse the repository at this point in the history
Fixes #20433
  • Loading branch information
andrzej-stencel authored Mar 31, 2023
1 parent 9f78a87 commit 252c297
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 16 deletions.
30 changes: 15 additions & 15 deletions exporter/awsxrayexporter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,21 +50,21 @@ by the Span Resource object. X-Ray uses this data to generate inferred segments
The following exporter configuration parameters are supported. They mirror and have the same effect as the
comparable AWS X-Ray Daemon configuration values.

| Name | Description | Default |
| :--------------------- | :--------------------------------------------------------------------------------- | ------- |
| `num_workers` | Maximum number of concurrent calls to AWS X-Ray to upload documents. | 8 |
| `endpoint` | Optionally override the default X-Ray service endpoint. | |
| `request_timeout` | Number of seconds before timing out a request. | 30 |
| `max_retries` | Maximun number of attempts to post a batch before failing. | 2 |
| `no_verify_ssl` | Enable or disable TLS certificate verification. | false |
| `proxy_address` | Upload segments to AWS X-Ray through a proxy. | |
| `region` | Send segments to AWS X-Ray service in a specific region. | |
| `local_mode` | Local mode to skip EC2 instance metadata check. | false |
| `resource_arn` | Amazon Resource Name (ARN) of the AWS resource running the collector. | |
| `role_arn` | IAM role to upload segments to a different account. | |
| `indexed_attributes` | List of attribute names to be converted to X-Ray annotations. | |
| `index_all_attributes` | Enable or disable conversion of all OpenTelemetry attributes to X-Ray annotations. | false |
| `aws_log_groups` | List of log group names for CloudWatch. | [] |
| Name | Description | Default |
| :------------------------ | :--------------------------------------------------------------------------------- | ------- |
| `num_workers` | Maximum number of concurrent calls to AWS X-Ray to upload documents. | 8 |
| `endpoint` | Optionally override the default X-Ray service endpoint. | |
| `request_timeout_seconds` | Number of seconds before timing out a request. | 30 |
| `max_retries` | Maximun number of attempts to post a batch before failing. | 2 |
| `no_verify_ssl` | Enable or disable TLS certificate verification. | false |
| `proxy_address` | Upload segments to AWS X-Ray through a proxy. | |
| `region` | Send segments to AWS X-Ray service in a specific region. | |
| `local_mode` | Local mode to skip EC2 instance metadata check. | false |
| `resource_arn` | Amazon Resource Name (ARN) of the AWS resource running the collector. | |
| `role_arn` | IAM role to upload segments to a different account. | |
| `indexed_attributes` | List of attribute names to be converted to X-Ray annotations. | |
| `index_all_attributes` | Enable or disable conversion of all OpenTelemetry attributes to X-Ray annotations. | false |
| `aws_log_groups` | List of log group names for CloudWatch. | [] |

## Traces and logs correlation

Expand Down
2 changes: 1 addition & 1 deletion exporter/awsxrayexporter/config_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ func TestLoadConfig(t *testing.T) {
AWSSessionSettings: awsutil.AWSSessionSettings{
NumberOfWorkers: 8,
Endpoint: "",
RequestTimeoutSeconds: 30,
RequestTimeoutSeconds: 120,
MaxRetries: 2,
NoVerifySSL: false,
ProxyAddress: "",
Expand Down
1 change: 1 addition & 0 deletions exporter/awsxrayexporter/testdata/config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ awsxray/customname:
role_arn: "arn:aws:iam::123456789:role/monitoring-EKS-NodeInstanceRole"
indexed_attributes: [ "indexed_attr_0", "indexed_attr_1" ]
aws_log_groups: ["group1", "group2"]
request_timeout_seconds: 120

0 comments on commit 252c297

Please sign in to comment.