Skip to content

Commit 85ebfe3

Browse files
fix: apply doc suggestions from code review
Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
1 parent c130776 commit 85ebfe3

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

docs/sources/reference/components/otelcol/otelcol.receiver.awss3.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ title: otelcol.receiver.awss3
1212

1313
{{< docs/shared lookup="stability/experimental.md" source="alloy" version="<ALLOY_VERSION>" >}}
1414

15-
`otelcol.receiver.awss3` receives traces previously stored in S3 by the [AWS S3 Exporter](./otelcol.exporter.awss3.md).
15+
`otelcol.receiver.awss3` receives traces stored in S3 by the [AWS S3 Exporter](./otelcol.exporter.awss3.md).
1616

1717
{{< admonition type="warning" >}}
1818
`otelcol.receiver.awss3` is a wrapper over the upstream OpenTelemetry Collector [`awss3`][] receiver.
@@ -24,9 +24,9 @@ Bug reports or feature requests will be redirected to the upstream repository, i
2424
The receiver has two modes of operation:
2525

2626
- **Time Range Mode** - Specify start and end to fetch data from a specific time range.
27-
- **SQS Message Mode** - Subscribe to SQS messages to process new objects as they arrive.
27+
- **SQS Message Mode** - Subscribe to SQS messages to process objects as they arrive.
2828

29-
The receiver supports following encodings:
29+
The receiver supports the following encodings:
3030

3131
- otlp_json (OpenTelemetry Protocol format represented as json) with a suffix of `.json`
3232
- otlp_proto (OpenTelemetry Protocol format represented as Protocol Buffers) with a suffix of `.binpb`
@@ -66,10 +66,10 @@ You can use the following arguments with `otelcol.receiver.awss3`:
6666
| `start_time` | `string` | The time at which to start retrieving data. | | Required if fetching by time. |
6767
| `end_time` | `string` | The time at which to stop retrieving data. | | Required if fetching by time. |
6868

69-
The `start_time` and `end_time` fields time format is either RFC3339, `YYYY-MM-DD HH:MM` or simply `YYYY-MM-DD`, in which case the time is assumed to be `00:00`.
69+
The `start_time` and `end_time` fields use one of the following time formats: RFC3339, `YYYY-MM-DD HH:MM`, or `YYYY-MM-DD`. When using `YYYY-MM-DD`, the time defaults to `00:00`.
7070

7171
{{< admonition type="note" >}}
72-
Time-based configuration (`start_time` and `end_time` arguments) cannot be combined together with [`sqs`][] block.
72+
Time-based configuration (`start_time` and `end_time` arguments) can't be combined together with [`sqs`][] block.
7373

7474
[`sqs`]: #sqs
7575

@@ -95,7 +95,7 @@ You can use the following blocks with `otelcol.receiver.awss3`:
9595

9696
{{< badge text="Required" >}}
9797

98-
The `s3downloader` block contains AWS S3 downloader related config to control things like bucket, prefix, batching, connections, retries, etc.
98+
The `s3downloader` block contains AWS S3 downloader related configuration to control things like bucket, prefix, batching, connections, retries, etc.
9999

100100
The following arguments are supported:
101101

@@ -108,7 +108,7 @@ The following arguments are supported:
108108
| `file_prefix` | `string` | File prefix defined by user. | | no |
109109
| `endpoint` | `string` | Overrides the endpoint used by the exporter instead of constructing it from `region` and `s3_bucket`. | | no |
110110
| `endpoint_partition_id` | `string` | Partition id to use if `endpoint` is specified. | `"aws"` | no |
111-
| `s3_force_path_style` | `bool` | Wnen enabled, forces the request to use [path-style addressing][s3-force-path-style-ref]. | `false` | no |
111+
| `s3_force_path_style` | `bool` | When enabled, forces the request to use [path-style addressing][s3-force-path-style-ref]. | `false` | no |
112112

113113
[s3-force-path-style-ref]: http://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html
114114

@@ -127,7 +127,8 @@ The following arguments are supported:
127127
| `wait_time_seconds` | `int` | Wait time in seconds for long polling SQS requests. | `20` | no |
128128

129129
{{< admonition type="note" >}}
130-
You must configure your S3 bucket to send event notifications to the SQS queue. Time-based configuration (`start_time`/`end_time`) and SQS configuration cannot be used together.
130+
You must configure your S3 bucket to send event notifications to the SQS queue.
131+
Time-based configuration (`start_time`/`end_time`) and SQS configuration can't be used together.
131132
{{< /admonition >}}
132133

133134
### `output`

0 commit comments

Comments
 (0)