redpanda-data / redpanda-data/redpanda

use osquery for gathering system-level debug package info

Open
#14,360 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area/rpk kind/enhance
Dominant language
C++
Stars
12.6k
Forks
792
PR merge metrics
No merged PRs in 30d

Description

Who is this for and what problem do they have today?

This would be useful to redpanda staff who have to interact with cluster debug bundles.

Today, we have code handling the gathering of information. Every time we need to add a new piece of info from /proc, or a sub-command to run, we have to add it into the debug package builder and get the user to update to the latest redpanda version.

osquery is an industry standard, open source tool for gathering this low-level systems information in a queryable way. We should consider integrating it and adding a dependency for it to make debug gathering easier internally.

What are the success criteria?

Need to investigate if/how we can actually integrate and use.

for os packages, we can either repackage into our redpanda deployable rpm/deb or we can add a package dependency for install time.

not sure how to integrate into kubernetes. maybe kube-query https://github.com/aquasecurity/kube-query

Why is solving this problem impactful?

osquery has a sql interface for gathering information on the system. It handles gathering many system-level details both on bare-metal and cloud.

Additional notes

https://redpandadata.slack.com/archives/C04CGMUJ0DP/p1694122836188859

JIRA Link: CORE-1517

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by investigating the existing debug package builder and how it gathers /proc data and subcommands; the issue does not name specific files or tests. Evaluate osquery packaging for RPM/deb deployments and the Kubernetes path, including the linked kube-query project. Done requires a documented integration approach and clear handling of the dependency and debug information workflow.

Written by the indexing model from the issue text.

Assessment

Tech stack
kubernetes, sql
Domain
devops, infrastructure, observability
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.