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.
This dashboard can be used to see what operations are running on cluster-level and on shard-level. With this, users can measure which operation/node is consuming the most CPU and what latency the cluster is experiencing.
This dashboard shows shard-level operation, the network, and memory metrics. It can be used to analyze which shard is doing the most workload, the amount of data being transmitted by the network, which disk is performing poorly, and which circuit breaker type is experiencing OutOfMemory exceptions.
This dashboard shows low-level metrics about threads/threadpools, which can be used to analyze which threadpool type is rejecting operations due to its queue being too large, which thread is running/waiting for too long and results in blocks, and which thread operation is having issues with memory and is having to load it from the disk.
This dashboard has the most wide ranges of metric types. It shows shard-level operation metrics, thread metrics, JVM-related metrics (e.g. heap usage, garbage collection), and network packet drop rate metrics. After gaining some insights from the previous dashboards, users can specify which node to fetch metrics for.
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.
--nodename $NODENAME
is provided, the bar graphs will be aggregated metrics on cluster-level.Excutables:
Download the executables and preset JSON dashboard configs here.
Supported platforms: Linux, macOS
Excutables:
./opensearch-perf-top-${PLATFORM} --dashboard $JSON --endpoint $ENDPOINT
Prerequisites:
node
(version >= v10.0 < v11.0)npm
./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 "opensearch-perf-top-{linux/macos}" executables../gradlew clean
which will run:
npm run clean
- deletes locally installed dependencies and executablesTo run PerfTop without (re)creating the executables every code change:
node ./lib/bin.js --dashboard $JSON
Please refer to the technical documentation for detailed information on installing and configuring Perftop.
See developer guide and how to contribute to this project.
This project has adopted the Amazon Open Source Code of Conduct. For more information see the Code of Conduct FAQ, or contact opensource-codeofconduct@amazon.com with any additional questions or comments.
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.
This project is licensed under the Apache v2.0 License.
Copyright OpenSearch Contributors. See NOTICE for details.