Skip to content

docs(self-hosted): rework for troubleshooting redis page#17702

Open
aldy505 wants to merge 1 commit intomasterfrom
aldy505/self-hosted/troubleshooting-redis-rework
Open

docs(self-hosted): rework for troubleshooting redis page#17702
aldy505 wants to merge 1 commit intomasterfrom
aldy505/self-hosted/troubleshooting-redis-rework

Conversation

@aldy505
Copy link
Copy Markdown
Collaborator

@aldy505 aldy505 commented May 10, 2026

DESCRIBE YOUR PR

Current "Troubleshooting Redis" documentation for documentation is outdated and no longer relevant. Due to changes with Taskbroker and recent issues with how Redis is being used in the whole self-hosted Sentry stack, it makes sense to make the documentation more proper.

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

LEGAL BOILERPLATE

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

EXTRA RESOURCES

@vercel
Copy link
Copy Markdown

vercel Bot commented May 10, 2026

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

Project Deployment Actions Updated (UTC)
develop-docs Ready Ready Preview, Comment May 10, 2026 1:39pm
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
sentry-docs Ignored Ignored May 10, 2026 1:39pm

Request Review

Most Redis keys are expected to have a prefix (e.g., `span-buf:`). Therefore, to delete the affected keys, you can run the following command:

```bash
docker compose exec redis sh -c "redis-cli --scan --pattern 'span-buf:*' | xargs redis-cli del"
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Bug: The xargs redis-cli del command will fail with a confusing error if no keys match the pattern because xargs is used without the -r flag.
Severity: LOW

Suggested Fix

Add the -r (or --no-run-if-empty) flag to the xargs command. This will prevent xargs from executing redis-cli del if the standard input from the redis-cli --scan command is empty, thus avoiding the error.

Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's
not valid.

Location: develop-docs/self-hosted/troubleshooting/redis.mdx#L46

Potential issue: The troubleshooting command `redis-cli --scan --pattern 'span-buf:*' |
xargs redis-cli del` will fail if no keys match the given pattern. The `xargs` command,
when it receives no input, will still execute `redis-cli del` but with no arguments.
This causes Redis to return a `(error) ERR wrong number of arguments for 'del' command`,
which could mislead a user into thinking the command is incorrect or their Redis
instance has a problem, when in fact no keys needed to be deleted.

Did we get this right? 👍 / 👎 to inform future reviews.

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