Performance Analyzer

    To download PerfTop, see Download on the PerfTop release page.

    You can also install it using :

    The basic syntax is:

      If you’re running PerfTop from a node (i.e. locally), specify port 9600:

      Otherwise, just specify the OpenSearch endpoint:

      1. ./opensearch-perf-top-macos --dashboard dashboards/<dashboard>.json --endpoint my-cluster.my-domain.com

      PerfTop has four pre-built dashboards in the dashboards directory, but you can also create your own.

      You can also load the pre-built dashboards (ClusterOverview, ClusterNetworkMemoryAnalysis, ClusterThreadAnalysis, or NodeAnalysis) without the JSON files, such as --dashboard ClusterThreadAnalysis.

      • For NodeAnalysis and similar custom dashboards, you can add the --nodename <node_name> argument if you want your dashboard to display metrics for only a single node.
      • For troubleshooting, add the --logfile <log-file>.txt argument.

      Performance Analyzer uses /dev/shm for temporary storage. During heavy workloads on a cluster, Performance Analyzer can use up to 1 GB of space.

      Docker, however, has a default size of 64 MB. To change this value, you can use the docker run --shm-size 1gb flag or .

      If you’re not using Docker, check the size of /dev/shm using df -h. The default value is probably plenty, but if you need to change its size, add the following line to /etc/fstab:

      1. tmpfs /dev/shm tmpfs defaults,noexec,nosuid,size=1G 0 0

      Then remount the file system:

      Change the following lines to configure encryption in transit. Note that certificate-file-path must be a certificate for the server, not a root CA:

      1. https-enabled = true
      3. certificate-file-path = specify_path
      5. private-key-file-path = specify_path