Skip to content

Commit 5a33db9

Browse files
Apply suggestions from code review
Co-authored-by: kirkrodrigues <[email protected]>
1 parent bebd046 commit 5a33db9

File tree

1 file changed

+15
-8
lines changed

1 file changed

+15
-8
lines changed

docs/src/user-docs/guides-using-object-storage/clp-usage.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ should be able to use CLP as described in the [clp-json quick-start guide](../qu
66
## Compressing logs from S3
77

88
To compress logs from S3, use the `sbin/compress-from-s3.sh` script. The script supports two modes
9-
of operation. Select a mode by using the corresponding argument in the command:
9+
of operation:
1010

1111
* [**s3-object** mode](#s3-object-compression-mode): Compress S3 objects specified by their full
1212
S3 URLs.
@@ -36,9 +36,17 @@ sbin/compress-from-s3.sh \
3636
* `<region-code>` is the AWS region [code][aws-region-codes] for the S3 bucket containing your
3737
logs.
3838
* `<object-key>` is the [object key][aws-s3-object-key] of the log file object you wish to
39-
compress. There must be no duplicate object keys across all `<object-url>` arguments.
39+
compress.
4040

41-
Instead of typing the input object URLs explicitly in the command, you may specify them in a text
41+
:::{warning}
42+
There must be no duplicate object keys across all `<object-url>` arguments.
43+
:::
44+
45+
46+
* For a description of other fields, see the [clp-json quick-start
47+
guide](../quick-start/clp-json.md#compressing-json-logs).
48+
49+
Instead of specifying input object URLs explicitly in the command, you may specify them in a text
4250
file and then pass the file into the command using the `--inputs-from` flag, like so:
4351

4452
```bash
@@ -52,9 +60,8 @@ sbin/compress-from-s3.sh \
5260
* `<input-file>` is a path to a text file containing one S3 object URL **per line**. The URLs must
5361
follow the same format as described above for `<object-url>`.
5462

55-
5663
:::{note}
57-
`s3-object` mode requires the input object keys to share a non-empty common prefix. If the input
64+
The `s3-object` mode requires the input object keys to share a non-empty common prefix. If the input
5865
object keys do not share a common prefix, they will be rejected and no compression job will be
5966
created. This limitation will be addressed in a future release.
6067
:::
@@ -85,10 +92,10 @@ sbin/compress-from-s3.sh \
8592
`<all-logs-prefix>` value from the [compression IAM policy][compression-iam-policy].
8693

8794
:::{note}
88-
`s3-key-prefix` mode accepts a single `<key-prefix-url>` argument. This limitation will be addressed
89-
in a future release.
95+
`s3-key-prefix` mode only accepts a single `<key-prefix-url>` argument. This limitation will be
96+
addressed in a future release.
9097
:::
9198

92-
[aws-s3-object-key]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html
9399
[aws-region-codes]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html#Concepts.RegionsAndAvailabilityZones.Availability
100+
[aws-s3-object-key]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html
94101
[compression-iam-policy]: ./object-storage-config.md#configuration-for-compression

0 commit comments

Comments
 (0)