From 55fdd69961d16590a12b58bf1343224392122f05 Mon Sep 17 00:00:00 2001 From: Karl Rister Date: Wed, 31 Jan 2024 09:36:42 -0600 Subject: [PATCH] replace mentions of ElasticSearch with OpenSearch --- queries/cdmq/CONTRIBUTING.md | 4 ++-- queries/cdmq/README.md | 8 ++++---- queries/cdmq/delete-run.js | 4 ++-- queries/cdmq/delete-run.sh | 2 +- queries/cdmq/get-metric-data-from-ids.js | 2 +- queries/cdmq/get-metric-data.js | 2 +- queries/cdmq/get-metric-data.sh | 2 +- queries/cdmq/get-metric-groups-from-breakout.js | 2 +- queries/cdmq/get-result-summary.sh | 2 +- 9 files changed, 14 insertions(+), 14 deletions(-) diff --git a/queries/cdmq/CONTRIBUTING.md b/queries/cdmq/CONTRIBUTING.md index 298b2baf..98513aab 100644 --- a/queries/cdmq/CONTRIBUTING.md +++ b/queries/cdmq/CONTRIBUTING.md @@ -6,7 +6,7 @@ When contributing, apply this project's JavaScript standard style, otherwise it - NodeJS 20.7.0 - NPM -- ElasticSearch 7.17 +- OpenSearch 2.x ## Standardizing JavaScript Style @@ -38,4 +38,4 @@ npx prettier *.js --check ```shell npx prettier *.js --write -``` \ No newline at end of file +``` diff --git a/queries/cdmq/README.md b/queries/cdmq/README.md index f3c17e97..215d442f 100644 --- a/queries/cdmq/README.md +++ b/queries/cdmq/README.md @@ -1,9 +1,9 @@ # cdmq ## Introduction -The contents of this directory contain a collection of scripts in Javascript intended to be executed with [node.js](https://nodejs.org). These scripts get data from an elasticsearch instance. The data must be in Common Data Format. which is documented in this project under [templates](../templates). The scripts here are meant to help inspect, compare, and export data from benchmarks and performance & resource-utilization tools, in order to report and investigate performance. +The contents of this directory contain a collection of scripts in Javascript intended to be executed with [node.js](https://nodejs.org). These scripts get data from an OpenSearch instance. The data must be in Common Data Format. which is documented in this project under [templates](../templates). The scripts here are meant to help inspect, compare, and export data from benchmarks and performance & resource-utilization tools, in order to report and investigate performance. -In order to generate this data, you must run a benchmark via automation framework which uses the Common Data Format and index that data into elasticsearch. One of those automation frameworks is the [crucible](https://github.com/perftool-incubator/crucible) project. A subproject of crucible, [crucible-examples](https://github.com/perftool-incubator/crucible-examples), includes scenarios to run some of these benchmarks. +In order to generate this data, you must run a benchmark via automation framework which uses the Common Data Format and index that data into OpenSearch. One of those automation frameworks is the [crucible](https://github.com/perftool-incubator/crucible) project. A subproject of crucible, [crucible-examples](https://github.com/perftool-incubator/crucible-examples), includes scenarios to run some of these benchmarks. ## Terms Many of the scripts refer to different terms we associate with either running a benchmark or examining the resulting data, and these terms are not always universally known or agreed upon for specific benchmarks (like uperf and fio), or even benchmark automation frameworks, Nevertheless, the CommonDataModel project has adopted the following terms, which originate from the crucible project. You will need to become familiar with these terms in order to use these scripts: @@ -228,7 +228,7 @@ So, let's use `type`, which breaks out the Gbps by virtual and physical interfac # node ./get-metric-data.js --period 4F1014D6-AD33-11EC-94E3-ADE96E3275F7 --source sar-net --type L2-Gbps --breakout csid,cstype,type Checking for httpd...appears to be running - Checking for elasticsearch...appears to be running + Checking for OpenSearch...appears to be running { "name": "sar-net", "type": "L2-Gbps", @@ -387,7 +387,7 @@ So far all of the metrics have been represented as a single value for a specific # node ./get-metric-data.js --period 4F1014D6-AD33-11EC-94E3-ADE96E3275F7 --source sar-net --type L2-Gbps --breakout csid=1,cstype=worker,type=physical,direction=tx,dev --filter gt:0.01 --resolution 10 Checking for httpd...appears to be running - Checking for elasticsearch...appears to be running + Checking for OpenSearch...appears to be running { "name": "sar-net", "type": "L2-Gbps", diff --git a/queries/cdmq/delete-run.js b/queries/cdmq/delete-run.js index d86aad8b..3334471f 100644 --- a/queries/cdmq/delete-run.js +++ b/queries/cdmq/delete-run.js @@ -4,7 +4,7 @@ var program = require('commander'); program .version('0.1.0') .option('--run ') - .option('--url ', 'The host and port of the Elasticsearch instance', 'localhost:9200') + .option('--url ', 'The host and port of the OpenSearch instance', 'localhost:9200') .parse(process.argv); async function waitFor(docTypes) { @@ -16,7 +16,7 @@ async function waitFor(docTypes) { }); let result = await promise; - console.log('\nConfirming all documents are in deleted elasticsearch (attempt #' + numAttempts + ')'); + console.log('\nConfirming all documents are in deleted OpenSearch (attempt #' + numAttempts + ')'); for (let i = 0; i < docTypes.length; i++) { var thisNumDocs = cdm.getDocCount(program.url, program.run, docTypes[i]); console.log(' ' + docTypes[i] + ': doc count: ' + thisNumDocs); diff --git a/queries/cdmq/delete-run.sh b/queries/cdmq/delete-run.sh index 8cb8fb39..fc2773c9 100755 --- a/queries/cdmq/delete-run.sh +++ b/queries/cdmq/delete-run.sh @@ -8,7 +8,7 @@ # metric_source, list the metric_types (like L2-Gbps). Uncomment the # "node get-metric-data ..." lines to output a specific tool metric -# This script assumes Elasticsearch is installed on the same host +# This script assumes OpenSearch is installed on the same host # and has data loaded from soemthing like crucible/rickshaw project_dir=$(dirname `readlink -e $0`) diff --git a/queries/cdmq/get-metric-data-from-ids.js b/queries/cdmq/get-metric-data-from-ids.js index d704b0af..8b4d7919 100644 --- a/queries/cdmq/get-metric-data-from-ids.js +++ b/queries/cdmq/get-metric-data-from-ids.js @@ -18,7 +18,7 @@ function list(val) { program .version('0.1.0') - .option('--url ', 'The host and port of the Elasticsearch instance') + .option('--url ', 'The host and port of the OpenSearch instance') .option('--begin [uint]', 'Timestamp in epochtime_ms') .option('--end [uint]', 'Timestamp in epochtime_ms') .option('--resolution [uint]', 'The number of datapoints to produce in a data-series') diff --git a/queries/cdmq/get-metric-data.js b/queries/cdmq/get-metric-data.js index 4f1fda44..0781c466 100644 --- a/queries/cdmq/get-metric-data.js +++ b/queries/cdmq/get-metric-data.js @@ -19,7 +19,7 @@ function list(val) { program .version('0.1.0') - .option('--url ', 'The host and port of the Elasticsearch instance', 'localhost:9200') + .option('--url ', 'The host and port of the OpenSearch instance', 'localhost:9200') .option('--run ', 'The UUID from the run') .option('--period ', 'The UUID from the benchmark-iteration-sample-period') .option('--source ', 'The metric source, like a tool or benchmark name (sar, fio)') diff --git a/queries/cdmq/get-metric-data.sh b/queries/cdmq/get-metric-data.sh index 64d990b0..b7621599 100755 --- a/queries/cdmq/get-metric-data.sh +++ b/queries/cdmq/get-metric-data.sh @@ -8,7 +8,7 @@ # metric_source, list the metric_types (like L2-Gbps). Uncomment the # "node get-metric-data ..." lines to output a specific tool metric -# This script assumes Elasticsearch is installed on the same host +# This script assumes OpenSearch is installed on the same host # and has data loaded from soemthing like crucible/rickshaw project_dir=$(dirname `readlink -e $0`) diff --git a/queries/cdmq/get-metric-groups-from-breakout.js b/queries/cdmq/get-metric-groups-from-breakout.js index b50020cc..a50a09c1 100644 --- a/queries/cdmq/get-metric-groups-from-breakout.js +++ b/queries/cdmq/get-metric-groups-from-breakout.js @@ -18,7 +18,7 @@ function list(val) { program .version('0.1.0') - .option('--url ', 'The host and port of the Elasticsearch instance') + .option('--url ', 'The host and port of the OpenSearch instance') .option('--period ', 'The UUID of the period document') .option('--source ', 'A metric source, like iostat or fio') .option('--type ', 'A metric type, like iops or Gbps') diff --git a/queries/cdmq/get-result-summary.sh b/queries/cdmq/get-result-summary.sh index 45429bb3..a1948064 100755 --- a/queries/cdmq/get-result-summary.sh +++ b/queries/cdmq/get-result-summary.sh @@ -8,7 +8,7 @@ # metric_source, list the metric_types (like L2-Gbps). Uncomment the # "node get-metric-data ..." lines to output a specific tool metric -# This script assumes Elasticsearch is installed on the same host +# This script assumes OpenSearch is installed on the same host # and has data loaded from soemthing like crucible/rickshaw project_dir=$(dirname `readlink -e $0`)