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

[DOC] Cleanup of thread_pool metric group in nodes stats documentation #7225

Closed
1 of 4 tasks
lukas-vlcek opened this issue May 22, 2024 · 0 comments · Fixed by #7226
Closed
1 of 4 tasks

[DOC] Cleanup of thread_pool metric group in nodes stats documentation #7225

lukas-vlcek opened this issue May 22, 2024 · 0 comments · Fixed by #7226
Assignees
Labels
2 - In progress Issue/PR: The issue or PR is in progress.

Comments

@lukas-vlcek
Copy link
Contributor

lukas-vlcek commented May 22, 2024

What do you want to do?

  • Request a change to existing documentation
  • Add new documentation
  • Report a technical problem with the documentation
  • Other

Tell us about your request. Provide a summary of the request and all versions that are affected.

The thread_pool section in the nodes stats statistics documentation needs a small treatment. The field is not called total_wait_time but total_wait_time_in_nanos. And we are also missing the thread_pool metrics group in the beginning of the page.

What other resources are available? Provide links to related issues, POCs, steps for testing, etc.

# Do a clean checkout of OpenSearch from git and run a single node:
./gradlew clean run

# After it is ready open a web browser of your choice and point it to
# http://localhost:9200/_nodes/stats?pretty&filter_path=nodes.*.thread_pool

open -a "Google Chrome" "http://localhost:9200/_nodes/stats?pretty&filter_path=nodes.*.thread_pool"

We can see the following:

{
  "nodes" : {
    "Gf6Qy9RrT_2FQ1sEtesipg" : {
      "thread_pool" : {
        "analyze" : {
          "threads" : 0,
          "queue" : 0,
          "active" : 0,
          "rejected" : 0,
          "largest" : 0,
          "completed" : 0
        },
        "fetch_shard_started" : {
          "threads" : 0,
          "queue" : 0,
          "active" : 0,
          "rejected" : 0,
          "largest" : 0,
          "completed" : 0
        },
        "fetch_shard_store" : {
          "threads" : 0,
          "queue" : 0,
          "active" : 0,
          "rejected" : 0,
          "largest" : 0,
          "completed" : 0
        },
        "flush" : {
          "threads" : 0,
          "queue" : 0,
          "active" : 0,
          "rejected" : 0,
          "largest" : 0,
          "completed" : 0
        },
        "force_merge" : {
          "threads" : 0,
          "queue" : 0,
          "active" : 0,
          "rejected" : 0,
          "largest" : 0,
          "completed" : 0
        },
        "generic" : {
          "threads" : 4,
          "queue" : 0,
          "active" : 0,
          "rejected" : 0,
          "largest" : 4,
          "completed" : 17835
        },
        "get" : {
          "threads" : 0,
          "queue" : 0,
          "active" : 0,
          "rejected" : 0,
          "largest" : 0,
          "completed" : 0
        },
        "index_searcher" : {
          "threads" : 0,
          "queue" : 0,
          "active" : 0,
          "rejected" : 0,
          "largest" : 0,
          "completed" : 0,
          "total_wait_time_in_nanos" : 0
        },
        "listener" : {
          "threads" : 0,
          "queue" : 0,
          "active" : 0,
          "rejected" : 0,
          "largest" : 0,
          "completed" : 0
        },
        "management" : {
          "threads" : 2,
          "queue" : 0,
          "active" : 1,
          "rejected" : 0,
          "largest" : 2,
          "completed" : 195
        },
        "refresh" : {
          "threads" : 0,
          "queue" : 0,
          "active" : 0,
          "rejected" : 0,
          "largest" : 0,
          "completed" : 0
        },
        "remote_purge" : {
          "threads" : 0,
          "queue" : 0,
          "active" : 0,
          "rejected" : 0,
          "largest" : 0,
          "completed" : 0
        },
        "remote_recovery" : {
          "threads" : 0,
          "queue" : 0,
          "active" : 0,
          "rejected" : 0,
          "largest" : 0,
          "completed" : 0
        },
        "remote_refresh_retry" : {
          "threads" : 0,
          "queue" : 0,
          "active" : 0,
          "rejected" : 0,
          "largest" : 0,
          "completed" : 0
        },
        "search" : {
          "threads" : 0,
          "queue" : 0,
          "active" : 0,
          "rejected" : 0,
          "largest" : 0,
          "completed" : 0,
          "total_wait_time_in_nanos" : 0
        },
        "search_throttled" : {
          "threads" : 0,
          "queue" : 0,
          "active" : 0,
          "rejected" : 0,
          "largest" : 0,
          "completed" : 0,
          "total_wait_time_in_nanos" : 0
        },
        "snapshot" : {
          "threads" : 0,
          "queue" : 0,
          "active" : 0,
          "rejected" : 0,
          "largest" : 0,
          "completed" : 0
        },
        "system_read" : {
          "threads" : 0,
          "queue" : 0,
          "active" : 0,
          "rejected" : 0,
          "largest" : 0,
          "completed" : 0
        },
        "system_write" : {
          "threads" : 0,
          "queue" : 0,
          "active" : 0,
          "rejected" : 0,
          "largest" : 0,
          "completed" : 0
        },
        "translog_sync" : {
          "threads" : 0,
          "queue" : 0,
          "active" : 0,
          "rejected" : 0,
          "largest" : 0,
          "completed" : 0
        },
        "translog_transfer" : {
          "threads" : 0,
          "queue" : 0,
          "active" : 0,
          "rejected" : 0,
          "largest" : 0,
          "completed" : 0
        },
        "warmer" : {
          "threads" : 0,
          "queue" : 0,
          "active" : 0,
          "rejected" : 0,
          "largest" : 0,
          "completed" : 0
        },
        "write" : {
          "threads" : 0,
          "queue" : 0,
          "active" : 0,
          "rejected" : 0,
          "largest" : 0,
          "completed" : 0
        }
      }
    }
  }
}

PR link: #7226

lukas-vlcek added a commit to lukas-vlcek/documentation-website that referenced this issue May 22, 2024
lukas-vlcek added a commit to lukas-vlcek/documentation-website that referenced this issue May 22, 2024
@hdhalter hdhalter added 2 - In progress Issue/PR: The issue or PR is in progress. and removed untriaged labels May 22, 2024
lukas-vlcek added a commit to lukas-vlcek/documentation-website that referenced this issue May 22, 2024
Naarcha-AWS pushed a commit that referenced this issue May 22, 2024
* Cleanup of thread_pool metric group in nodes stats documentation

Closes #7225

Signed-off-by: Lukáš Vlček <[email protected]>

* Update _api-reference/nodes-apis/nodes-stats.md

Co-authored-by: Heather Halter <[email protected]>
Signed-off-by: Lukáš Vlček <[email protected]>

---------

Signed-off-by: Lukáš Vlček <[email protected]>
Co-authored-by: Heather Halter <[email protected]>
opensearch-trigger-bot bot pushed a commit that referenced this issue May 22, 2024
* Cleanup of thread_pool metric group in nodes stats documentation

Closes #7225

Signed-off-by: Lukáš Vlček <[email protected]>

* Update _api-reference/nodes-apis/nodes-stats.md

Co-authored-by: Heather Halter <[email protected]>
Signed-off-by: Lukáš Vlček <[email protected]>

---------

Signed-off-by: Lukáš Vlček <[email protected]>
Co-authored-by: Heather Halter <[email protected]>
(cherry picked from commit 47a63d9)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2 - In progress Issue/PR: The issue or PR is in progress.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants