Skip to content

docs(engines): StarRocks query log - #75

Merged
viethqb merged 2 commits into
mainfrom
docs/starrocks-query-log
Nov 11, 2026
Merged

viethqb merged 2 commits into
mainfrom
docs/starrocks-query-log

Conversation

@viethqb

@viethqb viethqb commented Nov 11, 2026 •

Copy link
Copy Markdown
Member

Summary

This PR documents the StarRocks Query log tab and the security model behind it. It goes with egret-data/platform feat/starrocks-query-log (egret-data/platform#849).

Changes

  • control-plane/query-engines/engine-detail.md: the Query log tab. It covers:
    • the four states;
    • the filters and columns;
    • User vs Connected as;
    • the side panel;
    • the engine:audit gating;
    • setup, both automatic and through Set up query log;
    • 30-day retention;
    • pluginNotShipped and Upgrade security.
  • deploy-operate/engines-and-ranger.md: covers:
    • the audit database and the egret_query_log loader;
    • the Ranger loader and guard rows;
    • what is redacted;
    • the plugin_enable and plugin_dir keys, which are now refused in feConfig;
    • the count(*) known limit.
  • deploy-operate/security-hardening.md: grant engine:audit sparingly.
  • reference/permissions.md: engine:audit.
  • deploy-operate/upgrade.md: migration 0218, existing engines, and pre-egret.4 images.
  • REST API reference: the four /engines/{id}/query-log routes.
  • Four screenshots, taken on a kind deployment of the platform branch.

The facts these pages rely on were measured on a real FE and on kind. Specifically:

  • the plugin survives FE pod re-creation;
  • errors are recorded as codes only;
  • StarRocks already stores *** for passwords.

Test plan

  • npm run build passes for en and vi.
  • I checked each screenshot against the text that describes it.

🤖 Generated with Claude Code

viethqb and others added 2 commits November 11, 2026 18:19
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…n kind

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@viethqb
viethqb merged commit 2488b0a into main Nov 11, 2026
1 check passed
@viethqb
viethqb deleted the docs/starrocks-query-log branch November 11, 2026 13:42
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