Skip to content

Remove outdated note that Profile API does not measure the fetch phase - #12977

Open
yuinumaz wants to merge 1 commit into
opensearch-project:mainfrom
yuinumaz:fix-profile-fetch-phase-doc
Open

Remove outdated note that Profile API does not measure the fetch phase#12977
yuinumaz wants to merge 1 commit into
opensearch-project:mainfrom
yuinumaz:fix-profile-fetch-phase-doc

Conversation

@yuinumaz

@yuinumaz yuinumaz commented Aug 25, 2026

Copy link
Copy Markdown

The Profile API has reported fetch phase timings under profile.shards[].fetch since OpenSearch 3.2 (opensearch-project/OpenSearch#18664). This removes the outdated limitation note.

Test on my end

I can see the result for fetch phase on Amazon OpenSearch Service domain with OpenSearch 3.5.

GET hotels-index/_search
{
  "profile": true,
  "size": 1,
  "query": {
    "match_all": {}
  }
}
{
  "took": 6,
  "timed_out": false,
  "_shards": {
    "total": 5,
    "successful": 5,
    "skipped": 0,
    "failed": 0
  },
  "hits": {
    "total": {
      "value": 5,
      "relation": "eq"
    },
    "max_score": 1,
    "hits": [
...
    "shards": [
      {
        "id": "[FnFzKgkkQ7-1D8HchkCfTg][hotels-index][0]",
        "inbound_network_time_in_millis": 1,
        "outbound_network_time_in_millis": 1,
        "searches": [
          {
            "query": [
             ...
        ],
        "aggregations": [],
        "fetch": [
          {
            "type": "fetch",
            "description": "fetch",
            "time_in_nanos": 71557,
            "breakdown": {
              "get_next_reader_count": 1,
              "load_stored_fields": 52511,
              "load_source": 720,
              "build_sub_phase_processors": 9336,
              "get_next_reader": 2293,
              "load_stored_fields_count": 1,
              "load_source_count": 1,
              "create_stored_fields_visitor": 3166,
              "build_sub_phase_processors_count": 1,
              "create_stored_fields_visitor_count": 1
            },
            "children": [
              {
                "type": "FetchSourcePhase",
                "description": "FetchSourcePhase",
                "time_in_nanos": 3531,
                "breakdown": {
                  "process_count": 1,
                  "process": 1054,
                  "set_next_reader_count": 1,
                  "set_next_reader": 2477
                }
              }
            ]
          }
        ]
      },
...

Signed-off-by: Yui Numazawa <yuinuma@gmail.com>
@github-actions

Copy link
Copy Markdown

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference).

@github-actions github-actions Bot added the Tech review PR: Tech review in progress label Aug 25, 2026
@yuinumaz

Copy link
Copy Markdown
Author

This documents behavior introduced in opensearch-project/OpenSearch#18664. @andrevandeven @jainankitk could you help with the tech review, or point me to the right reviewer? Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport 3.8 Tech review PR: Tech review in progress

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants