Skip to content

chore(data/tutorials): update aws retention doc#2969

Open
shubham-signoz wants to merge 1 commit intomainfrom
aws_s3exporter_updates
Open

chore(data/tutorials): update aws retention doc#2969
shubham-signoz wants to merge 1 commit intomainfrom
aws_s3exporter_updates

Conversation

@shubham-signoz
Copy link
Collaborator

Signed-off-by: Shubham Dubey <shubham@signoz.io>
@vercel
Copy link

vercel bot commented Mar 25, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
signoz-web Ready Ready Preview, Comment Mar 25, 2026 10:40pm

Request Review

@github-actions
Copy link
Contributor

github-actions bot commented Mar 25, 2026

Claude finished @shubham-signoz's task in 2m 27s —— View job


Docs Review — data/docs/tutorial/infinite-retention-aws-s3.mdx

  • Gather context and read changed files
  • Read review and authoring playbooks
  • Verify technical accuracy against upstream sources
  • Run JTBD-first rubric
  • Post inline findings and summary

Findings

P3 — Pipeline YAML snippets lack parent keys (lines 69-71, 104-111)
The exporters: [otlp, awss3/logs] snippets are shown without the service: pipelines: parent context. Users unfamiliar with Collector config structure may not know where to place them. Adding the parent keys would reduce ambiguity. See inline comments for suggested fixes.

No P1 or P2 issues found.


Personas and Fit

Primary persona: Platform engineer or SRE who needs to archive OpenTelemetry data to S3 for compliance/audit purposes.

Fit: Strong. The doc addresses this persona well with clear config snippets, deployment notes for different SigNoz setups, and a troubleshooting section covering common failure modes.

JTBD Coverage

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> with target="_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:

  • s3uploader field names (region, s3_bucket, s3_prefix, s3_partition_format, compression, storage_class, role_arn, endpoint, s3_force_path_style) — correct
  • marshaler at exporter level with default otlp_jsoncorrect
  • Compression options (none, gzip, zstd) — correct
  • otelcol-contrib requirement (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.


Comment on lines +104 to +111
```yaml
logs:
exporters: [otlp, awss3/logs]
metrics:
exporters: [otlp, awss3/metrics]
traces:
exporters: [otlp, awss3/traces]
```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:

Suggested change
```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]

Comment on lines +69 to +71
```yaml
exporters: [otlp, awss3/logs]
```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:

Suggested change
```yaml
exporters: [otlp, awss3/logs]
```
```yaml
service:
pipelines:
logs:
exporters: [otlp, awss3/logs]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant