Skip to content

Update metric docs #5844

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

Open
wants to merge 4 commits into
base: revamp-storage-metrics
Choose a base branch
from
Open

Conversation

rdettai
Copy link
Collaborator

@rdettai rdettai commented Jul 16, 2025

Description

Generate an updated metrics docs using copilot. Most metrics have been checked manually and comments have been added. Some of them where not verified, like OTLP and Jaeger metrics. In any case, it cannot be worse that the current doc that is completely outdated.

Also removed the get_slice_in_flight_* metrics to have these memory allocations measured as part of quickwit_memory_in_flight. This makes it more discoverable and usable.

How was this PR tested?

Tested some of the metrics on a running instance.

@rdettai rdettai changed the title Make in-flight storage get requests a memory metric Update metric docs Jul 16, 2025
@rdettai rdettai force-pushed the update-metrics-doc branch from e97ef66 to a7f12de Compare July 16, 2025 10:37
Comment on lines -24 to -25
pub replicated_num_bytes_total: IntCounter,
pub replicated_num_docs_total: IntCounter,
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

moved this to be part of of ingest_v2 metrics


pub replicated_num_bytes_total: IntCounter,
pub replicated_num_docs_total: IntCounter,
#[allow(dead_code)] // this really shouldn't be dead, it needs to be used somewhere
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

this has been dead for a year

Comment on lines -35 to -36
pub object_storage_get_slice_in_flight_count: IntGauge,
pub object_storage_get_slice_in_flight_num_bytes: IntGauge,
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

  • I created this metric to make sure that this wasn't the reason for OOMs on search and I confirmed it's not the case
  • I think it makes sense to keep tracking the memory usage, but move it to quickwit_memory_in_flight where it is more discoverable and actionable

@rdettai rdettai requested a review from fulmicoton-dd July 16, 2025 12:19
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