yugabyte/yugabyte-db

[DocDB] Add additional logging about SST files

Open

#20,880 opened on Jan 31, 2024

View on GitHub
 (12 comments) (0 reactions) (1 assignee)C (1,003 forks)batch import
area/docdbdatapath-onboardinggood first issuekind/enhancementpriority/medium

Repository metrics

Stars
 (8,229 stars)
PR merge metrics
 (Avg merge 17d 21h) (92 merged PRs in 30d)

Description

Jira Link: DB-9866

Description

During a recent investigation, we wished we had more information about SST files.

This task is to add some relevant additional logging information.

First, we would like to print out the RocksDB block cache prefix in a log message when a SST file is created. We most immediately want to be able to look for collisions between different SST files so it's probably fine to print this as a series of bytes in hex.

Second, UniversalCompactionPicker::SortedRun::DumpSizeInfo already prints some information about selected SST files. Please add to the logging the metadata and data size rather than just total file size.

Issue Type

kind/enhancement

Warning: Please confirm that this issue does not contain any sensitive information

  • I confirm this issue does not contain any sensitive information.

Contributor guide

Research direction
Find where SST files are created in DocDB and add logging for RocksDB block cache prefix. Locate UniversalCompactionPicker::SortedRun::DumpSizeInfo and add metadata/data size logging.
Tech stack
cpp
Domain
backenddatabase
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitC++
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50