osquery / osquery/osquery

Add a way to mark a table as deprecated

Open
#7,666 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

blueprint feature user experience virtual tables
Dominant language
C++
Stars
23.6k
Forks
2.6k
Avg merge
6d 7h
Merged PRs (30d)
14

Description

Not the first time this would've been useful, but the need/idea came up again here: https://github.com/osquery/osquery/pull/7651

This is not a full-fledged blueprint but I think it's worth to record the desire:

  1. We should be able to mark a table as deprecated as proposed in the PR
  2. We should warn in the logs when doing a query against a deprecated table
  3. We should add a flag to disable deprecation warnings (but it's off by default)
  4. We should show the deprecated tables in the schema for the tables on the osquery website

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 reviewing the referenced pull request 7651, the issue's only implementation reference. Define completion against all four requested behaviors: marking deprecated tables, logging query warnings, disabling warnings with a default-off flag, and showing deprecated tables in the osquery website schema.

Written by the indexing model from the issue text.

Assessment

Tech stack
sql
Domain
cli, databases, documentation, observability
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.