@aws/opendistro-for-elasticsearch-perftop
v1.13.0
Published
PerfTop CLI tool for Open Distro Performance Analyzer
Downloads
76
Maintainers
Keywords
Readme
PerfTop
The PerfTop CLI provides pre-configured dashboards for analyzing cluster, node, shard performance, and more. Use custom JSON templates to create the dashboards you need to diagnose your cluster performance.
Preset Dashboards
- All sorts are in decreasing order.
- Bar graphs show aggregated metrics on cluster-level unless stated otherwise.
- Line graphs generate random colors. If no data shows up, it's likely that the data is 0.
ClusterOverview
- "Resource Metrics" is sorted by CPU_Utilization.
- "Shard Operation Metrics" is sorted by ShardEvents.
- "Workload" is sorted by HTTP_RequestDocs.
ClusterNetworkMemoryAnalysis
- "Shard Operation Metrics" is sorted by ShardEvents.
- "Circuit Breaker - Tripped Events / Estimated and Configured Limits" is sorted by CB_TrippedEvents.
ClusterThreadAnalysis
- "Thread Pool - Queue Size and Rejected Requests" is sorted by ThreadPool_RejectedReqs.
- "Thread - Blocked Time" is sorted by Thread_Blocked_Time.
- "Page Faults" is sorted by Paging_MajfltRate.
- All "Context Switch" tables are sorted by Sched_*.
NodeAnalysis
This dashboard supports --nodename $NODENAME
command-line argument for displaying metric data for
ONLY the node that starts with $NODENAME
. If not provided, this dashboard will include all nodes.
Users can also define different node names for each type of graphs from the JSON dashboard config.
- "Shard Operation Metrics" is sorted by ShardEvents.
- "Shard Request Cache Miss" is sorted by Cache_Request_Miss.
- "Thread Pool - Queue Size and Rejected Requests" is sorted by ThreadPool_RejectedReqs.
- "Heap Usage" is sorted by Heap_Used.
- If no
--nodename $NODENAME
is provided, the bar graphs will be aggregated metrics on cluster-level.
Documentation
For more information, see the documentation.
Installation
Install with npm:
npm install -g @aws/opendistro-for-elasticsearch-perftop
Excutables:
Download the executables and preset JSON dashboard configs here.
Supported platforms: Linux, macOS
Usage
npm:
opendistro-perf-top --dashboard NodeAnalysis
Excutables:
./opendistro-perf-top-${PLATFORM} --dashboard $JSON --endpoint $ENDPOINT
Build
Prerequisites:
node
(version >= v10.0 < v11.0)npm
- Clone/download from Github
- Run
./gradlew build -Dbuild.linux={true/false} -Dbuild.macos={true/false}
. This will run the following:npm install
- locally installs dependenciesnpm run build-{linux/macos}
- creates "opendistro-perf-top-{linux/macos}" executables.
- For cleaning, run
./gradlew clean
which will run:npm run clean
- deletes locally installed dependencies and executables
To run PerfTop without (re)creating the executables every code change:
node ./lib/bin.js --dashboard $JSON
Code of Conduct
This project has adopted an Open Source Code of Conduct.
Security issue notifications
If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our vulnerability reporting page. Please do not create a public GitHub issue.
Licensing
See the LICENSE file for our project's licensing. We will ask you to confirm the licensing of your contribution.
Copyright
Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.