From 2f0577869da4d3a14a905c78735354e429c5f38f Mon Sep 17 00:00:00 2001 From: Sruti Parthiban Date: Tue, 25 May 2021 11:18:35 -0700 Subject: [PATCH] Update PA docs Signed-off-by: Sruti Parthiban --- docs/opensearch/install/docker.md | 8 ++++---- docs/opensearch/install/plugins.md | 2 +- docs/opensearch/install/tar.md | 8 ++++---- docs/pa/api.md | 6 +++--- docs/pa/index.md | 12 ++++++------ docs/pa/rca/api.md | 4 ++-- docs/pa/rca/reference.md | 2 +- 7 files changed, 21 insertions(+), 21 deletions(-) diff --git a/docs/opensearch/install/docker.md b/docs/opensearch/install/docker.md index 3c3672c9..effdf768 100644 --- a/docs/opensearch/install/docker.md +++ b/docs/opensearch/install/docker.md @@ -192,25 +192,25 @@ You can also configure `docker-compose.yml` and `opensearch.yml` [to take your o 1. Enable the Performance Analyzer plugin: ```bash - curl -XPOST localhost:9200/_opensearch/_performanceanalyzer/cluster/config -H 'Content-Type: application/json' -d '{"enabled": true}' + curl -XPOST localhost:9200/_plugins/_performanceanalyzer/cluster/config -H 'Content-Type: application/json' -d '{"enabled": true}' ``` If you receive the `curl: (52) Empty reply from server` error, you are likely protecting your cluster with the security plugin and you need to provide credentials. Modify the following command to use your username and password: ```bash - curl -XPOST https://localhost:9200/_opensearch/_performanceanalyzer/cluster/config -H 'Content-Type: application/json' -d '{"enabled": true}' -u 'admin:admin' -k + curl -XPOST https://localhost:9200/_plugins/_performanceanalyzer/cluster/config -H 'Content-Type: application/json' -d '{"enabled": true}' -u 'admin:admin' -k ``` 1. Enable the Root Cause Analyzer (RCA) framework ```bash - curl -XPOST localhost:9200/_opensearch/_performanceanalyzer/rca/cluster/config -H 'Content-Type: application/json' -d '{"enabled": true}' + curl -XPOST localhost:9200/_plugins/_performanceanalyzer/rca/cluster/config -H 'Content-Type: application/json' -d '{"enabled": true}' ``` Similar to step 1, if you run into `curl: (52) Empty reply from server`, run the command below to enable RCA ```bash - curl -XPOST https://localhost:9200/_opensearch/_performanceanalyzer/rca/cluster/config -H 'Content-Type: application/json' -d '{"enabled": true}' -u 'admin:admin' -k + curl -XPOST https://localhost:9200/_plugins/_performanceanalyzer/rca/cluster/config -H 'Content-Type: application/json' -d '{"enabled": true}' -u 'admin:admin' -k ``` 1. By default, Performance Analyzer's endpoints are not accessible from outside the Docker container. diff --git a/docs/opensearch/install/plugins.md b/docs/opensearch/install/plugins.md index ca5d451d..352dabcc 100644 --- a/docs/opensearch/install/plugins.md +++ b/docs/opensearch/install/plugins.md @@ -227,7 +227,7 @@ Performance Analyzer requires some manual configuration after installing the plu 1. Send a test request: ```bash - curl -XGET "localhost:9600/_opensearch/_performanceanalyzer/metrics?metrics=Latency,CPU_Utilization&agg=avg,max&dim=ShardID&nodes=all" + curl -XGET "localhost:9600/_plugins/_performanceanalyzer/metrics?metrics=Latency,CPU_Utilization&agg=avg,max&dim=ShardID&nodes=all" ``` diff --git a/docs/opensearch/install/tar.md b/docs/opensearch/install/tar.md index c362a1dd..1d65839f 100644 --- a/docs/opensearch/install/tar.md +++ b/docs/opensearch/install/tar.md @@ -118,25 +118,25 @@ In a tarball installation, Performance Analyzer collects data when it is enabled 1. In a separate window, enable the Performance Analyzer plugin: ```bash - curl -XPOST localhost:9200/_opensearch/_performanceanalyzer/cluster/config -H 'Content-Type: application/json' -d '{"enabled": true}' + curl -XPOST localhost:9200/_plugins/_performanceanalyzer/cluster/config -H 'Content-Type: application/json' -d '{"enabled": true}' ``` If you receive the `curl: (52) Empty reply from server` error, you are likely protecting your cluster with the security plugin and you need to provide credentials. Modify the following command to use your username and password: ```bash - curl -XPOST https://localhost:9200/_opensearch/_performanceanalyzer/cluster/config -H 'Content-Type: application/json' -d '{"enabled": true}' -u 'admin:admin' -k + curl -XPOST https://localhost:9200/_plugins/_performanceanalyzer/cluster/config -H 'Content-Type: application/json' -d '{"enabled": true}' -u 'admin:admin' -k ``` 1. Finally, enable the Root Cause Analyzer (RCA) framework ```bash - curl -XPOST localhost:9200/_opensearch/_performanceanalyzer/rca/cluster/config -H 'Content-Type: application/json' -d '{"enabled": true}' + curl -XPOST localhost:9200/_plugins/_performanceanalyzer/rca/cluster/config -H 'Content-Type: application/json' -d '{"enabled": true}' ``` Similar to step 4, if you run into `curl: (52) Empty reply from server`, run the command below to enable RCA ```bash - curl -XPOST https://localhost:9200/_opensearch/_performanceanalyzer/rca/cluster/config -H 'Content-Type: application/json' -d '{"enabled": true}' -u 'admin:admin' -k + curl -XPOST https://localhost:9200/_plugins/_performanceanalyzer/rca/cluster/config -H 'Content-Type: application/json' -d '{"enabled": true}' -u 'admin:admin' -k ``` {% comment %} diff --git a/docs/pa/api.md b/docs/pa/api.md index 784d1c6b..9e391b9d 100644 --- a/docs/pa/api.md +++ b/docs/pa/api.md @@ -10,7 +10,7 @@ nav_order: 1 Performance Analyzer uses a single HTTP method and URI for most requests: ``` -GET :9600/_opensearch/_performanceanalyzer/metrics +GET :9600/_plugins/_performanceanalyzer/metrics ``` Note the use of port 9600. Provide parameters for metrics, aggregations, dimensions, and nodes (optional): @@ -25,7 +25,7 @@ For a full list of metrics, see [Metrics reference](../reference/). Performance #### Sample request ``` -GET localhost:9600/_opensearch/_performanceanalyzer/metrics?metrics=Latency,CPU_Utilization&agg=avg,max&dim=ShardID&nodes=all +GET localhost:9600/_plugins/_performanceanalyzer/metrics?metrics=Latency,CPU_Utilization&agg=avg,max&dim=ShardID&nodes=all ``` @@ -104,7 +104,7 @@ Performance Analyzer has one additional URI that returns the unit for each metri #### Sample request ``` -GET localhost:9600/_opensearch/_performanceanalyzer/metrics/units +GET localhost:9600/_plugins/_performanceanalyzer/metrics/units ``` diff --git a/docs/pa/index.md b/docs/pa/index.md index f4ea41b9..daa3abc7 100644 --- a/docs/pa/index.md +++ b/docs/pa/index.md @@ -25,25 +25,25 @@ npm install -g @aws/opensearch-perftop The basic syntax is: ```bash -./perf-top- --dashboard .json --endpoint +./opensearch-perf-top- --dashboard .json --endpoint ``` If you're using npm, the syntax is similar: ```bash -perf-top --dashboard --endpoint +opensearch-perf-top --dashboard --endpoint ``` If you're running PerfTop from a node (i.e. locally), specify port 9600: ```bash -./perf-top-linux --dashboard dashboards/.json --endpoint localhost:9600 +./opensearch-perf-top-linux --dashboard dashboards/.json --endpoint localhost:9600 ``` Otherwise, just specify the OpenSearch endpoint: ```bash -./perf-top-macos --dashboard dashboards/.json --endpoint my-cluster.my-domain.com +./opensearch-perf-top-macos --dashboard dashboards/.json --endpoint my-cluster.my-domain.com ``` PerfTop has four pre-built dashboards in the `dashboards` directory, but you can also [create your own](dashboards/). @@ -83,10 +83,10 @@ mount -o remount /dev/shm ### Security -Performance Analyzer supports encryption in transit for requests. It currently does *not* support client or server authentication for requests. To enable encryption in transit, edit `performance-analyzer.properties` in your `$ES_HOME` directory: +Performance Analyzer supports encryption in transit for requests. It currently does *not* support client or server authentication for requests. To enable encryption in transit, edit `performance-analyzer.properties` in your `$OPENSEARCH_HOME` directory: ```bash -vi $ES_HOME/plugins/opensearch_performance_analyzer/pa_config/performance-analyzer.properties +vi $OPENSEARCH_HOME/plugins/opensearch-performance-analyzer/pa_config/performance-analyzer.properties ``` 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: diff --git a/docs/pa/rca/api.md b/docs/pa/rca/api.md index d43ae681..2d3aeb3e 100644 --- a/docs/pa/rca/api.md +++ b/docs/pa/rca/api.md @@ -12,10 +12,10 @@ nav_order: 1 ``` # Request all available RCAs -GET localhost:9600/_opensearch/_performanceanalyzer/rca +GET localhost:9600/_plugins/_performanceanalyzer/rca # Request a specific RCA -GET localhost:9600/_opensearch/_performanceanalyzer/rca?name=HighHeapUsageClusterRca +GET localhost:9600/_plugins/_performanceanalyzer/rca?name=HighHeapUsageClusterRca ``` diff --git a/docs/pa/rca/reference.md b/docs/pa/rca/reference.md index 8a853e3a..c6642785 100644 --- a/docs/pa/rca/reference.md +++ b/docs/pa/rca/reference.md @@ -8,4 +8,4 @@ nav_order: 3 # RCA reference -You can find a reference of available RCAs and their purposes on [Github](https://github.com/opensearch-project/performance-analyzer-rca/tree/master/docs). +You can find a reference of available RCAs and their purposes on [Github](https://github.com/opensearch-project/performance-analyzer-rca/tree/main/docs).