Skip to content
OpenDistro for Elasticsearch Performance Analyzer
Branch: master
Clone or download
ditac Merge pull request #43 from ditac/ditac-getter
Add getter/setter for accessing variable
Latest commit c1eb2dc Apr 22, 2019
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Creating initial file from template Dec 19, 2018
docs Update image location in Reader doc Apr 22, 2019
gradle/wrapper 6.7.1 support (#23) Apr 9, 2019
pa_bin Reader startup script improvements Apr 20, 2019
packaging Update the Main class string in shell scripts. The path to the main c… Feb 27, 2019
src Add getter/setter for accessing variable Apr 22, 2019
test_files Pull latest changes into github. Changes include - metric renaming an… Feb 5, 2019
.gitignore Generate RPM for perf analyzer. Feb 26, 2019 Update code of conduct link Mar 11, 2019 Update contributing links Mar 11, 2019 Update Mar 1, 2019
NOTICE Update Apr 11, 2019
THIRD-PARTY updates to LICENSE, NOTICE, and THIRD-PARTY Jan 26, 2019
build.gradle Merge pull request #33 from ditac/ditac-ssl Apr 17, 2019

Performance Analyzer

Performance Analyzer exposes a REST API that allows you to query numerous performance metrics for your cluster, including aggregations of those metrics, independent of the Java Virtual Machine (JVM). PerfTop is the default command line interface (CLI) for displaying those metrics.


Performance Analyzer API

Performance Analyzer uses a single HTTP method and URI for all requests:

GET <endpoint>/_opendistro/_performanceanalyzer/metrics

Then you provide parameters for metrics, aggregations, dimensions, and nodes (optional):

  • metrics - comma separated list of metrics you are interested in. For a full list of metrics, see Metrics Reference.
  • agg - comma separated list of agg to be used on each metric. Possible values are sum, avg, min and max. Length of the list should be equal to the number of metrics specified.
  • dim - comma separated list of dimensions. For the list of dimensions supported by each metric, see Metrics Reference.
  • nodes - If the string all is passed, metrics from all nodes in the cluster are returned. For any other value, metrics from only the local node is returned.


GET _opendistro/_performanceanalyzer/metrics?metrics=Latency,CPU_Utilization&agg=avg,max&dim=ShardID&nodes=all


Please refer to the technical documentation for detailed information on installing and configuring Performance Analyzer.

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.


See the LICENSE file for our project's licensing. We will ask you to confirm the licensing of your contribution.


Copyright 2019, Inc. or its affiliates. All Rights Reserved.

You can’t perform that action at this time.