chore(data/tutorials): update aws retention doc#2969
chore(data/tutorials): update aws retention doc#2969shubham-signoz wants to merge 1 commit intomainfrom
Conversation
Signed-off-by: Shubham Dubey <shubham@signoz.io>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Claude finished @shubham-signoz's task in 2m 27s —— View job Docs Review —
|
| Check | Status |
|---|---|
| Primary job obvious | Pass — back up OTel data to S3 for long-term retention |
| Happy path clear | Pass — single-signal example first, then all-signals |
| Time-to-first-success short | Pass — minimal config snippet to get started |
| Steps concrete and concise | Pass |
| Defaults in main path, advanced separate | Pass — additional config options in separate section |
| Prerequisites clear | Pass — otelcol-contrib requirement, AWS credentials |
| Troubleshooting symptom-first | Pass — 4 common error scenarios covered |
| Validate shows success | Pass — aws s3 ls command with expected output pattern |
| Next steps present | Pass — Athena, lifecycle policies, monitoring |
Checklist Coverage (docs-authoring.md)
- Frontmatter: all required keys present (
date,id,title,description,doc_type) — pass doc_type: tutorial— appropriate for this opinionated end-to-end flow — pass- Tags omitted (applies to both Cloud and Self-Host) — correct
- Placeholders use
<...>format with explanations below snippets — pass - Collector config safety: shows only snippets to add, tells readers to append — pass
- External links use
<a>withtarget="_blank" rel="noopener noreferrer nofollow"— pass - Internal links use absolute production URLs — pass
<GetHelp />component replaces old Slack CTA image — pass
Technical Accuracy
All configuration keys verified against the official awss3exporter source:
s3uploaderfield names (region,s3_bucket,s3_prefix,s3_partition_format,compression,storage_class,role_arn,endpoint,s3_force_path_style) — correctmarshalerat exporter level with defaultotlp_json— correct- Compression options (
none,gzip,zstd) — correct otelcol-contribrequirement (not in core) — correct
Open Questions
None.
Onboarding label: skipped
File status is modified (not a new doc), and the page is about S3 archival, not about sending data to SigNoz.
| ```yaml | ||
| logs: | ||
| exporters: [otlp, awss3/logs] | ||
| metrics: | ||
| exporters: [otlp, awss3/metrics] | ||
| traces: | ||
| exporters: [otlp, awss3/traces] | ||
| ``` |
There was a problem hiding this comment.
P3 — Pipeline snippet lacks parent keys
Readers unfamiliar with Collector config structure may not know where to place these keys. Consider adding a YAML comment showing the parent context:
| ```yaml | |
| logs: | |
| exporters: [otlp, awss3/logs] | |
| metrics: | |
| exporters: [otlp, awss3/metrics] | |
| traces: | |
| exporters: [otlp, awss3/traces] | |
| ``` | |
| ```yaml | |
| service: | |
| pipelines: | |
| logs: | |
| exporters: [otlp, awss3/logs] | |
| metrics: | |
| exporters: [otlp, awss3/metrics] | |
| traces: | |
| exporters: [otlp, awss3/traces] |
| ```yaml | ||
| exporters: [otlp, awss3/logs] | ||
| ``` |
There was a problem hiding this comment.
P3 — First pipeline snippet also missing parent context
Same as the multi-signal snippet below — adding service: pipelines: parent keys (or a YAML comment) would reduce ambiguity:
| ```yaml | |
| exporters: [otlp, awss3/logs] | |
| ``` | |
| ```yaml | |
| service: | |
| pipelines: | |
| logs: | |
| exporters: [otlp, awss3/logs] |
Closes - https://github.com/SigNoz/engineering-pod/issues/3830