Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Enhancement] Add datacache memory tracker to trace the datacache memory usage. #38884

Merged
merged 1 commit into from Jan 19, 2024

Conversation

GavinMar
Copy link
Contributor

@GavinMar GavinMar commented Jan 11, 2024

Why I'm doing:
The datacache memory usage is unobservable, which brings difficulties to analyze process memory details.

What I'm doing:
Add datacache memory tracker to trace the datacache memory usage.
You can observe the datacache memory usage by follow urls:

http://${BE_HOST}:${BE_WEBSERVER_PORT}/mem_tracker
http://${BE_HOST}:${BE_WEBSERVER_PORT}/metrics
http://${BE_HOST}:${BE_WEBSERVER_PORT}/metrics/memory

What type of PR is this:

  • BugFix
  • Feature
  • Enhancement
  • Refactor
  • UT
  • Doc
  • Tool

Does this PR entail a change in behavior?

  • Yes, this PR will result in a change in behavior.
  • No, this PR will not result in a change in behavior.

If yes, please specify the type of change:

  • Interface/UI changes: syntax, type conversion, expression evaluation, display information
  • Parameter changes: default values, similar parameters but with different default values
  • Policy changes: use new policy to replace old one, functionality automatically enabled
  • Feature removed
  • Miscellaneous: upgrade & downgrade compatibility, etc.

Checklist:

  • I have added test cases for my bug fix or my new feature
  • This pr needs user documentation (for new or modified features or behaviors)
    • I have added documentation for my new feature or new function
  • This is a backport pr

Bugfix cherry-pick branch check:

  • I have checked the version labels which the pr will be auto-backported to the target branch
    • 3.2
    • 3.1
    • 3.0
    • 2.5

mem_metrics->process_mem_bytes.value(), mem_metrics->query_mem_bytes.value(),
mem_metrics->load_mem_bytes.value(), mem_metrics->metadata_mem_bytes.value(),
mem_metrics->compaction_mem_bytes.value(), mem_metrics->schema_change_mem_bytes.value(),
mem_metrics->column_pool_mem_bytes.value(), mem_metrics->storage_page_cache_mem_bytes.value(),
mem_metrics->update_mem_bytes.value(), mem_metrics->chunk_allocator_mem_bytes.value(),
mem_metrics->clone_mem_bytes.value(), mem_metrics->consistency_mem_bytes.value());
mem_metrics->clone_mem_bytes.value(), mem_metrics->consistency_mem_bytes.value(),
datacache_mem_bytes);

nap_sleep(15, [daemon] { return daemon->stopped(); });
}
Copy link

Choose a reason for hiding this comment

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

The most risky bug in this code is:
Potential null pointer dereference.

You can modify the code like this:

// ...
BlockCache* block_cache = BlockCache::instance();
if (block_cache && block_cache->is_initialized()) { // Check if block_cache is not nullptr before using it
    auto datacache_metrics = block_cache->cache_metrics();
    datacache_mem_bytes = datacache_metrics.mem_used_bytes + datacache_metrics.meta_used_bytes;
}
// ...

Explanation:
In the code provided, there's a check for block_cache->is_initialized() but no check to ensure that block_cache is not a nullptr before calling is_initialized() on it. If BlockCache::instance() returns a nullptr, attempting to call is_initialized() or any other method on it will lead to undefined behavior and possibly crash the program. Therefore, it's important to add a null pointer check before using block_cache.

… usage.

Signed-off-by: Gavin <yangguansuo@starrocks.com>
Copy link

[FE Incremental Coverage Report]

pass : 0 / 0 (0%)

Copy link

[BE Incremental Coverage Report]

fail : 2 / 14 (14.29%)

file detail

path covered_line new_line coverage not_covered_line_detail
🔵 src/http/default_path_handlers.cpp 0 2 00.00% [159, 160]
🔵 src/script/script.cpp 0 1 00.00% [224]
🔵 src/common/daemon.cpp 0 9 00.00% [120, 180, 181, 182, 183, 184, 185, 192, 193]
🔵 src/block_cache/block_cache.cpp 1 1 100.00% []
🔵 src/runtime/exec_env.cpp 1 1 100.00% []

@Youngwb Youngwb enabled auto-merge (squash) January 19, 2024 02:43
@Youngwb Youngwb merged commit 729b4ed into StarRocks:main Jan 19, 2024
62 of 63 checks passed
Copy link

@Mergifyio backport branch-3.2

@github-actions github-actions bot removed the 3.2 label Jan 19, 2024
Copy link

@Mergifyio backport branch-3.1

@github-actions github-actions bot removed the 3.1 label Jan 19, 2024
Copy link
Contributor

mergify bot commented Jan 19, 2024

backport branch-3.2

✅ Backports have been created

Copy link
Contributor

mergify bot commented Jan 19, 2024

backport branch-3.1

✅ Backports have been created

mergify bot pushed a commit that referenced this pull request Jan 19, 2024
…ory usage. (#38884)

Signed-off-by: Gavin <yangguansuo@starrocks.com>
(cherry picked from commit 729b4ed)
mergify bot pushed a commit that referenced this pull request Jan 19, 2024
…ory usage. (#38884)

Signed-off-by: Gavin <yangguansuo@starrocks.com>
(cherry picked from commit 729b4ed)

# Conflicts:
#	be/src/block_cache/block_cache.h
#	be/src/http/action/memory_metrics_action.cpp
#	be/src/runtime/exec_env.cpp
#	be/src/script/script.cpp
GavinMar added a commit to GavinMar/starrocks that referenced this pull request Jan 19, 2024
…ory usage. (StarRocks#38884)

Signed-off-by: Gavin <yangguansuo@starrocks.com>
GavinMar added a commit to GavinMar/starrocks that referenced this pull request Jan 19, 2024
…ory usage. (StarRocks#38884)

Signed-off-by: Gavin <yangguansuo@starrocks.com>
GavinMar added a commit to GavinMar/starrocks that referenced this pull request Jan 19, 2024
…sage. (backport StarRocks#38884)

Signed-off-by: Gavin <yangguansuo@starrocks.com>
GavinMar added a commit to GavinMar/starrocks that referenced this pull request Jan 19, 2024
…sage. (backport StarRocks#38884)

Signed-off-by: Gavin <yangguansuo@starrocks.com>
Youngwb pushed a commit that referenced this pull request Jan 22, 2024
…ory usage. (backport #38884) (#39569)

Signed-off-by: Gavin <yangguansuo@starrocks.com>
Youngwb pushed a commit that referenced this pull request Jan 22, 2024
…ory usage. (backport #38884) (#39600)

Signed-off-by: Gavin <yangguansuo@starrocks.com>
Seaven pushed a commit to Seaven/starrocks that referenced this pull request Jan 30, 2024
…ory usage. (StarRocks#38884)

Signed-off-by: Gavin <yangguansuo@starrocks.com>
Signed-off-by: Seaven <seaven_7@qq.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants