Heading capitalization fix (#6032)
* Heading capitalization fix Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * More error fixes Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> --------- Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
This commit is contained in:
kolchfa-aws
GitHub
parent
063fd9af7c
commit
5a7d6a1ac9
@ -3,6 +3,8 @@ Adoptium
|
||||
Amazon
|
||||
Amazon OpenSearch Serverless
|
||||
Amazon OpenSearch Service
|
||||
Amazon Bedrock
|
||||
Amazon SageMaker
|
||||
Ansible
|
||||
Auditbeat
|
||||
AWS Cloud
|
||||
@ -27,6 +29,7 @@ Fluent Bit
|
||||
Fluentd
|
||||
Helm
|
||||
Hugging Face
|
||||
IdP
|
||||
Inferentia
|
||||
IP2Geo
|
||||
IPv4
|
||||
@ -36,6 +39,7 @@ JavaScript
|
||||
Jaeger
|
||||
Jaeger HotROD
|
||||
JSON
|
||||
JSON Web Token
|
||||
Keycloak
|
||||
Kerberos
|
||||
Kibana
|
||||
@ -52,6 +56,7 @@ Minikube
|
||||
Nagios
|
||||
Okta
|
||||
Open Distro
|
||||
OpenAI
|
||||
OpenID Connect
|
||||
OpenSearch
|
||||
OpenSearch Benchmark
|
||||
@ -74,6 +79,7 @@ Python
|
||||
PyTorch
|
||||
Querqy
|
||||
Query Workbench
|
||||
RCF Summarize
|
||||
RPM Package Manager
|
||||
Ruby
|
||||
Simple Schema for Observability
|
||||
|
||||
@ -22,34 +22,51 @@ Flags that accept comma-separated values, such `--telemetry`, can also accept a
|
||||
- JSON file: `opensearch-benchmark ... --workload-params="params.json"`
|
||||
- JSON inline string: `opensearch-benchmark ... --telemetry='["node-stats", "recovery-stats"]'`
|
||||
|
||||
<!-- vale off -->
|
||||
## workload-path
|
||||
<!-- vale on -->
|
||||
|
||||
This can be either a directory that contains a `workload.json` file or a `.json` file with an arbitrary name that contains a workload specification. `--workload-path` and `--workload-repository` as well as `--workload` are mutually exclusive.
|
||||
|
||||
## workload-repository
|
||||
<!-- vale off -->
|
||||
## workload-repositor
|
||||
<!-- vale on -->
|
||||
|
||||
This defines the repository from which OpenSearch Benchmark loads workloads. `--workload-path` and `--workload-repository` as well as `--workload` are mutually exclusive.
|
||||
|
||||
<!-- vale off -->
|
||||
## workload-revision
|
||||
<!-- vale on -->
|
||||
|
||||
Defines a specific revision from the workload source tree that OpenSearch Benchmark should use.
|
||||
|
||||
<!-- vale off -->
|
||||
## workload
|
||||
<!-- vale on -->
|
||||
|
||||
Defines the workload to use based on the workload's name. You can find a list of preloaded workloads using `opensearch-benchmark list workloads`. `--workload-path` and `--workload-repository` as well as `--workload` are mutually exclusive.
|
||||
|
||||
<!-- vale off -->
|
||||
## workload-params
|
||||
<!-- vale on -->
|
||||
|
||||
Defines which variables to inject into the workload. Variables injected must be available in the workload. To see which parameters are valid in the official workloads, select the workload from [the workloads repository](https://github.com/opensearch-project/opensearch-benchmark-workloads).
|
||||
|
||||
<!-- vale off -->
|
||||
## test-procedure
|
||||
<!-- vale on -->
|
||||
|
||||
Defines the test procedures to use with each workload. You can find a list of test procedures that the workload supports by specifying the workload in the `info` command, for example, `opensearch-benchmark info --workload=<workload_name>`. To look up information on a specific test procedure, use the command `opensearch-benchmark info --workload=<workload_name> --test-procedure=<test-procedure>`.
|
||||
|
||||
<!-- vale off -->
|
||||
## test-execution-id
|
||||
<!-- vale on -->
|
||||
|
||||
Defines a unique ID for the test run.
|
||||
|
||||
<!-- vale off -->
|
||||
## include-tasks
|
||||
<!-- vale on -->
|
||||
|
||||
Defines a comma-separated list of test procedure tasks to run. By default, all tasks listed in a test procedure array are run.
|
||||
|
||||
@ -57,75 +74,112 @@ Tests are executed in the order they are defined in `test-procedure`---not in th
|
||||
|
||||
All task filters are case sensitive.
|
||||
|
||||
<!-- vale off -->
|
||||
## exclude-tasks
|
||||
<!-- vale on -->
|
||||
|
||||
Defines a comma-separated list of test procedure tasks not to run.
|
||||
|
||||
<!-- vale off -->
|
||||
## baseline
|
||||
<!-- vale on -->
|
||||
|
||||
The baseline TestExecution ID used to compare the contender TestExecution.
|
||||
|
||||
<!-- vale off -->
|
||||
## contender
|
||||
<!-- vale on -->
|
||||
|
||||
The TestExecution ID for the contender being compared to the baseline.
|
||||
|
||||
<!-- vale off -->
|
||||
## results-format
|
||||
<!-- vale on -->
|
||||
|
||||
Defines the output format for the command line results, either `markdown` or `csv`. Default is `markdown`.
|
||||
|
||||
|
||||
<!-- vale off -->
|
||||
## results-number-align
|
||||
<!-- vale on -->
|
||||
|
||||
Defines the column number alignment for when the `compare` command outputs results. Default is `right`.
|
||||
|
||||
<!-- vale off -->
|
||||
## results-file
|
||||
<!-- vale on -->
|
||||
|
||||
When provided a file path, writes the compare results to the file indicated in the path.
|
||||
|
||||
<!-- vale off -->
|
||||
## show-in-results
|
||||
<!-- vale on -->
|
||||
|
||||
Determines whether or not to include the comparison in the results file.
|
||||
|
||||
<!-- vale off -->
|
||||
## provision-config-repository
|
||||
<!-- vale on -->
|
||||
|
||||
Defines the repository from which OpenSearch Benchmark loads `provision-configs` and `provision-config-instances`.
|
||||
|
||||
<!-- vale off -->
|
||||
## provision-config-revision
|
||||
<!-- vale on -->
|
||||
|
||||
Defines the specific Git revision in the `provision-config` that OpenSearch Benchmark should use.
|
||||
|
||||
<!-- vale off -->
|
||||
## provision-config-path
|
||||
<!-- vale on -->
|
||||
|
||||
Defines the path to the `--provision-config-instance` and any OpenSearch plugin configurations to use.
|
||||
|
||||
<!-- vale off -->
|
||||
## distribution-version
|
||||
<!-- vale on -->
|
||||
|
||||
Downloads the specified OpenSearch distribution based on version number. For a list of released OpenSearch versions, see [Version history](https://opensearch.org/docs/version-history/).
|
||||
|
||||
<!-- vale off -->
|
||||
## distribution-repository
|
||||
<!-- vale on -->
|
||||
|
||||
Defines the repository from which the OpenSearch distribution should be downloaded. Default is `release`.
|
||||
|
||||
<!-- vale off -->
|
||||
## provision-config-instance
|
||||
<!-- vale on -->
|
||||
|
||||
Defines the `--provision-config-instance` to use. You can view possible configuration instances by using the command `opensearch-benchmark list provision-config-instances`.
|
||||
|
||||
<!-- vale off -->
|
||||
## provision-config-instance-params
|
||||
<!-- vale on -->
|
||||
|
||||
A comma-separated list of key-value pairs injected verbatim as variables for the `provision-config-instance`.
|
||||
|
||||
<!-- vale off -->
|
||||
## target-hosts
|
||||
<!-- vale on -->
|
||||
|
||||
Defines a comma-separated list of host-port pairs that should be targeted if using the pipeline `benchmark-only`. Default is `localhost:9200`.
|
||||
|
||||
<!-- vale off -->
|
||||
## target-os
|
||||
<!-- vale on -->
|
||||
|
||||
The target operating system (OS) for which the OpenSearch artifact should be downloaded. Default is the current OS.
|
||||
|
||||
<!-- vale off -->
|
||||
## target-arch
|
||||
<!-- vale on -->
|
||||
|
||||
The name of the CPU architecture for which an artifact should be downloaded.
|
||||
|
||||
<!-- vale off -->
|
||||
## revision
|
||||
<!-- vale on -->
|
||||
|
||||
Defines the current source code revision to use for running a benchmark test. Default is `current`.
|
||||
|
||||
@ -136,43 +190,64 @@ This command flag can use the following options:
|
||||
|
||||
You can also use a timestamp or commit ID from the source tree. When using a timestamp, specify `@ts`, where "ts" is a valid ISO 8601 timestamp, for example, `@2013-07-27T10:37:00Z`.
|
||||
|
||||
<!-- vale off -->
|
||||
## opensearch-plugins
|
||||
<!-- vale on -->
|
||||
|
||||
Defines which [OpenSearch plugins]({{site.url}}{{site.baseurl}}/install-and-configure/plugins/) to install. By default, no plugins are installed.
|
||||
|
||||
<!-- vale off -->
|
||||
## plugin-params
|
||||
<!-- vale on -->
|
||||
|
||||
Defines a comma-separated list of key-value pairs that are injected verbatim into all plugins as variables.
|
||||
|
||||
<!-- vale off -->
|
||||
## runtime-jdk
|
||||
<!-- vale on -->
|
||||
|
||||
The major version of JDK to use.
|
||||
|
||||
|
||||
<!-- vale off -->
|
||||
## client-options
|
||||
<!-- vale on -->
|
||||
|
||||
Defines a comma-separated list of clients to use. All options are passed to the OpenSearch Python client. Default is `timeout:60`.
|
||||
|
||||
<!-- vale off -->
|
||||
## load-worker-coordinator-hosts
|
||||
<!-- vale on -->
|
||||
|
||||
Defines a comma-separated list of hosts that coordinate loads. Default is `localhost`.
|
||||
|
||||
<!-- vale off -->
|
||||
## enable-worker-coordinator-profiling
|
||||
<!-- vale on -->
|
||||
|
||||
Enables a performance analysis of OpenSearch Benchmark's worker coordinator. Default is `false`.
|
||||
|
||||
<!-- vale off -->
|
||||
## pipeline
|
||||
<!-- vale on -->
|
||||
|
||||
The `--pipeline` option selects a pipeline to run. You can find a list of pipelines supported by OpenSearch Benchmark by running `opensearch-benchmark list pipelines`.
|
||||
|
||||
<!-- vale off -->
|
||||
## telemetry
|
||||
<!-- vale on -->
|
||||
|
||||
Enables the provided telemetry devices when the devices are provided using a comma-separated list. You can find a list of possible telemetry devices by using `opensearch-benchmark list telemetry`.
|
||||
|
||||
<!-- vale off -->
|
||||
## telemetry-params
|
||||
<!-- vale on -->
|
||||
|
||||
Enables setting parameters for telemetry devices. Accepts a list of comma-separated key-value pairs, each of which are delimited by a colon or a JSON file name.
|
||||
|
||||
<!-- vale off -->
|
||||
## on-error
|
||||
<!-- vale on -->
|
||||
|
||||
Controls how OpenSearch Benchmark responds to errors. Default is `continue`.
|
||||
|
||||
@ -181,27 +256,38 @@ You can use the following options with this command flag:
|
||||
- `continue`: Continues to run the test despite the error.
|
||||
- `abort`: Aborts the test when an error occurs.
|
||||
|
||||
<!-- vale off -->
|
||||
## preserve-install
|
||||
<!-- vale on -->
|
||||
|
||||
Keeps the Benchmark candidate and its index. Default is `false`.
|
||||
|
||||
<!-- vale off -->
|
||||
## kill-running-processes
|
||||
<!-- vale on -->
|
||||
|
||||
When set to `true`, stops any OpenSearch Benchmark processes currently running and allows Benchmark to continue to run. Default is `false`.
|
||||
|
||||
|
||||
<!-- vale off -->
|
||||
## chart-spec-path
|
||||
<!-- vale on -->
|
||||
|
||||
Sets the path to the JSON files containing chart specifications that can be used to generate charts.
|
||||
|
||||
<!-- vale off -->
|
||||
## chart-type
|
||||
<!-- vale on -->
|
||||
|
||||
Generates the indicated chart type, either `time-series` or `bar`. Default is `time-series`.
|
||||
|
||||
<!-- vale off -->
|
||||
## output-path
|
||||
<!-- vale on -->
|
||||
|
||||
The name and path used for the chart's output. Default is `stdout`.
|
||||
|
||||
<!-- vale off -->
|
||||
## limit
|
||||
<!-- vale on -->
|
||||
|
||||
Limits the number of search results for recent test runs. Default is `10`.
|
||||
@ -7,7 +7,9 @@ grand_parent: OpenSearch Benchmark Reference
|
||||
redirect_from: /benchmark/commands/compare/
|
||||
---
|
||||
|
||||
<!-- vale off -->
|
||||
# compare
|
||||
<!-- vale on -->
|
||||
|
||||
The `compare` command helps you analyze the difference between two benchmark tests. This can help you analyze the performance impact of changes made from a previous test based on a specific Git revision.
|
||||
|
||||
@ -36,7 +38,7 @@ a33845cc-c2e5-4488-a2db-b0670741ff9b 20230523T213145Z geonames
|
||||
|
||||
```
|
||||
|
||||
Then, use `compare` to call a `--baseline` test and a `--contender` test for comparison.
|
||||
Then use `compare` to call a `--baseline` test and a `--contender` test for comparison.
|
||||
|
||||
```
|
||||
opensearch-benchmark compare --baseline=417ed42-6671-9i79-11a1-e367636068ce --contender=beb154e4-0a05-4f45-ad9f-e34f9a9e51f7
|
||||
|
||||
@ -7,7 +7,9 @@ grand_parent: OpenSearch Benchmark Reference
|
||||
redirect_from: /benchmark/commands/download/
|
||||
---
|
||||
|
||||
<!-- vale off -->
|
||||
# download
|
||||
<!-- vale on -->
|
||||
|
||||
Use the `download` command to select which OpenSearch distribution version to download.
|
||||
|
||||
|
||||
@ -7,7 +7,9 @@ grand_parent: OpenSearch Benchmark Reference
|
||||
redirect_from: /benchmark/commands/execute-test/
|
||||
---
|
||||
|
||||
<!-- vale off -->
|
||||
# execute-test
|
||||
<!-- vale on -->
|
||||
|
||||
Whether you're using the included [OpenSearch Benchmark workloads](https://github.com/opensearch-project/opensearch-benchmark-workloads) or a [custom workload]({{site.url}}{{site.baseurl}}/benchmark/creating-custom-workloads/), use the `execute-test` command to gather data about the performance of your OpenSearch cluster according to the selected workload.
|
||||
|
||||
|
||||
@ -7,7 +7,9 @@ grand_parent: OpenSearch Benchmark Reference
|
||||
redirect_from: /benchmark/commands/info/
|
||||
---
|
||||
|
||||
<!-- vale off -->
|
||||
# info
|
||||
<!-- vale on -->
|
||||
|
||||
The `info` command prints details about an OpenSearch Benchmark component.
|
||||
|
||||
|
||||
@ -7,7 +7,9 @@ grand_parent: OpenSearch Benchmark Reference
|
||||
redirect_from: /benchmark/commands/list/
|
||||
---
|
||||
|
||||
<!-- vale off -->
|
||||
# list
|
||||
<!-- vale on -->
|
||||
|
||||
The `list` command lists the following elements used by OpenSearch Benchmark:
|
||||
|
||||
|
||||
@ -68,39 +68,57 @@ OpenSearch Benchmark stores metrics in the `benchmark-metrics-*` indexes. A new
|
||||
|
||||
The following fields found in the `_source` section of the metric's record are configurable in the `opensearch-benchmarks-metrics-*` file.
|
||||
|
||||
<!-- vale off -->
|
||||
## @timestamp
|
||||
<!-- vale on -->
|
||||
|
||||
The timestamp of when the sample was taken since the epoch, in milliseconds. For request-related metrics, such as `latency` or `service_time`, this is the timestamp of when OpenSearch Benchmark issued the request.
|
||||
|
||||
<!-- vale off -->
|
||||
## relative-time-ms
|
||||
<!-- vale on -->
|
||||
|
||||
The relative time since the start of the benchmark, in milliseconds. This is useful for comparing time-series graphs across multiple tests. For example, you can compare the indexing throughput over time across multiple tests.
|
||||
|
||||
<!-- vale off -->
|
||||
## test-execution-id
|
||||
<!-- vale on -->
|
||||
|
||||
A UUID that changes on every invocation of the workload. It is intended to group all samples of a benchmarking run.
|
||||
|
||||
<!-- vale off -->
|
||||
## test-execution-timestamp
|
||||
<!-- vale on -->
|
||||
|
||||
The timestamp of when the workload was invoked (always in UTC).
|
||||
|
||||
<!-- vale off -->
|
||||
## environment
|
||||
<!-- vale on -->
|
||||
|
||||
The `environment` describes the origin of a metric record. This is defined when initially [configuring]({{site.url}}{{site.baseurl}}/benchmark/configuring-benchmark/) OpenSearch Benchmark. You can use separate environments for different benchmarks but store the metric records in the same index.
|
||||
|
||||
<!-- vale off -->
|
||||
## workload, test_procedure, provision-config-instance
|
||||
<!-- vale on -->
|
||||
|
||||
The workload, test procedures, and configuration instances for which the metrics are produced.
|
||||
|
||||
<!-- vale off -->
|
||||
## name, value, unit
|
||||
<!-- vale on -->
|
||||
|
||||
The actual metric name and value, with an optional unit. Depending on the nature of a metric, it is either sampled periodically by OpenSearch Benchmark, for example, CPU utilization or query latency, or measured once, for example, the final size of the index.
|
||||
|
||||
<!-- vale off -->
|
||||
## sample-type
|
||||
<!-- vale on -->
|
||||
|
||||
Determines whether to configure a benchmark to run in warmup mode by setting it to `warmup` or `normal`. Only `normal` samples are considered for the results that are reported.
|
||||
|
||||
<!-- vale off -->
|
||||
## meta
|
||||
<!-- vale on -->
|
||||
|
||||
The meta information for each metric record, including the following:
|
||||
|
||||
|
||||
@ -13,7 +13,9 @@ All telemetry devices with a `--stats` can be used with clusters not provisioned
|
||||
|
||||
This page lists the telemetry devices supported by OpenSearch Benchmark.
|
||||
|
||||
<!-- vale off -->
|
||||
## jfr
|
||||
<!-- vale on -->
|
||||
|
||||
The `jfr` telemetry device enables the [Java Flight Recorder (JFR)](https://docs.oracle.com/javacomponents/jmc-5-5/jfr-runtime-guide/index.html) on the benchmark candidate. Up to Java Development Kit (JDK) 11, JFR ships only with Oracle JDK. OpenSearch Benchmark assumes that Oracle JDK is used for benchmarking. If you run benchmarks on JDK 11 or later, [JFR](https://jdk.java.net/jmc/) is also available on OpenJDK.
|
||||
|
||||
@ -26,21 +28,29 @@ The `jfr` devices support the following parameters:
|
||||
- `jfr-delay`: The length of time to wait before starting to record. Optional.
|
||||
- `jfr-duration`: The length of time to record. Optional.
|
||||
|
||||
<!-- vale off -->
|
||||
## jit
|
||||
<!-- vale on -->
|
||||
|
||||
The `jit` telemetry device enables JIT compiler logs for the benchmark candidate. If the HotSpot disassembler library is available, the logs will contain the disassembled JIT compiler output, which can be used for low-level analysis.
|
||||
|
||||
<!-- vale off -->
|
||||
## gc
|
||||
<!-- vale on -->
|
||||
|
||||
The `gc` telemetry device enables garbage collector (GC) logs for the benchmark candidate. You can use tools such as GCViewer to analyze the GC logs.
|
||||
|
||||
If the runtime JDK is Java 9 or higher, you can specify the `gc-log-config` parameter. The GC logging configuration consists of a list of tags and levels, such as the default value `gc*=info,safepoint=info,age*=trace`. Run `java -Xlog:help` to view a list of available levels and tags.
|
||||
|
||||
<!-- vale off -->
|
||||
## heapdump
|
||||
<!-- vale on -->
|
||||
|
||||
The `heapdump` telemetry device captures a heap dump after a benchmark has finished and right before the node is shut down.
|
||||
|
||||
<!-- vale off -->
|
||||
## node-stats
|
||||
<!-- vale on -->
|
||||
|
||||
The `node-stats` telemetry device regularly calls the cluster [Node Stats API]({{site.url}}{{site.baseurl}}/api-reference/nodes-apis/nodes-stats/) and records metrics from the following stats and their associated keys:
|
||||
|
||||
@ -70,7 +80,9 @@ The `node-stats` device supports the following parameters:
|
||||
- `node-stats-include-process`: A Boolean indicating whether process CPU stats should be included. Default is `true`.
|
||||
- `node-stats-include-indexing-pressure`: A Boolean indicating whether indexing presser stats should be included. Default is `true`.
|
||||
|
||||
<!-- vale off -->
|
||||
## recovery-stats
|
||||
<!-- vale on -->
|
||||
|
||||
The `recovery-stats` telemetry device regularly calls the [CAT Recovery API]({{site.url}}{{site.baseurl}}/api-reference/cat/cat-recovery/) and records one metrics document per shard.
|
||||
|
||||
@ -79,13 +91,17 @@ This telemetry device supports the following parameters:
|
||||
- `searchable-snapshots-stats-indices` A string with the index pattern, or list of index patterns, that searchable snapshots stats should additionally be collected from. If unset, only cluster-level stats will be collected. Default is `None`.
|
||||
- `searchable-snapshots-stats-sample-interval`: A positive number greater than zero denoting the sampling interval in seconds. Default is `1`.
|
||||
|
||||
<!-- vale off -->
|
||||
## shard-stats
|
||||
<!-- vale on -->
|
||||
|
||||
The `shard-stats` telemetry device regularly calls the cluster [Node Stats API]({{site.url}}{{site.baseurl}}/api-reference/nodes-apis/nodes-stats/) using a `level=shard` cluster parameter and records one metrics document per shard.
|
||||
|
||||
This device supports the `shard-stats-sample-interval` parameter, which defines the sampling interval in seconds. Default is `60`.
|
||||
|
||||
<!-- vale off -->
|
||||
## data-stream-stats
|
||||
<!-- vale on -->
|
||||
|
||||
The `data-stream-stats` telemetry device regularly calls the [Data Stream Stats API]({{site.url}}{{site.baseurl}}/im-plugin/data-streams/#step-2-create-a-data-stream) and records one metrics document for cluster-level stats (`_all`) and one metrics document per data stream.
|
||||
|
||||
@ -129,7 +145,9 @@ The following is an example of recorded documents given two data streams in the
|
||||
|
||||
This telemetry device supports the `data-stream-stats-sample-interval` parameter, which defines the sampling interval in seconds. Default is `10`.
|
||||
|
||||
<!-- vale off -->
|
||||
## ingest-pipeline-stats
|
||||
<!-- vale on -->
|
||||
|
||||
The `ingest-pipeline-stats` telemetry device makes a call at the beginning and end of the benchmark to the Node Stats API and records the deltas in the form of the following documents:
|
||||
|
||||
|
||||
@ -7,7 +7,9 @@ nav_order: 70
|
||||
redirect_from: /benchmark/workloads/corpora/
|
||||
---
|
||||
|
||||
<!-- vale off -->
|
||||
# corpora
|
||||
<!-- vale on -->
|
||||
|
||||
The `corpora` element contains all the document corpora used by the workload. You can use document corpora across workloads by copying and pasting any corpora definitions.
|
||||
|
||||
|
||||
@ -7,7 +7,9 @@ nav_order: 65
|
||||
redirect_from: /benchmark/workloads/indices/
|
||||
---
|
||||
|
||||
<!-- vale off -->
|
||||
# indices
|
||||
<!-- vale on -->
|
||||
|
||||
The `indices` element contains a list of all indices used in the workload.
|
||||
|
||||
|
||||
@ -6,11 +6,15 @@ grand_parent: OpenSearch Benchmark Reference
|
||||
nav_order: 100
|
||||
---
|
||||
|
||||
<!-- vale off -->
|
||||
# operations
|
||||
<!-- vale on -->
|
||||
|
||||
The `operations` element contains a list of all available operations for specifying a schedule.
|
||||
|
||||
<!-- vale off -->
|
||||
## bulk
|
||||
<!-- vale on -->
|
||||
|
||||
The `bulk` operation type allows you to run [bulk](/api-reference/document-apis/bulk/) requests as a task.
|
||||
|
||||
@ -74,7 +78,9 @@ If `detailed-results` is `true`, the following metadata is returned:
|
||||
- `bulk-request-size-bytes`: The total size of the bulk request body, in bytes.
|
||||
- `total-document-size-bytes`: The total size of all documents within the bulk request body, in bytes.
|
||||
|
||||
<!-- vale off -->
|
||||
## create-index
|
||||
<!-- vale on -->
|
||||
|
||||
The `create-index` operation runs the [Create Index API](/api-reference/index-apis/create-index/). It supports the following two modes of index creation:
|
||||
|
||||
@ -147,7 +153,9 @@ The `create-index` operation returns the following metadata:
|
||||
`unit`: Always `ops`, indicating the number of operations inside the workload.
|
||||
`success`: A Boolean indicating whether the operation has succeeded.
|
||||
|
||||
<!-- vale off -->
|
||||
## delete-index
|
||||
<!-- vale on -->
|
||||
|
||||
The `delete-index` operation runs the [Delete Index API](api-reference/index-apis/delete-index/). Like with the [`create-index`](#create-index) operation, you can delete all indexes found in the `indices` section of the workload or delete one or more indexes based on the string passed in the `index` setting.
|
||||
|
||||
@ -203,7 +211,9 @@ The `delete-index` operation returns the following metadata:
|
||||
`unit`: Always `ops`, for the number of operations inside the workload.
|
||||
`success`: A Boolean indicating whether the operation has succeeded.
|
||||
|
||||
<!-- vale off -->
|
||||
## cluster-health
|
||||
<!-- vale on -->
|
||||
|
||||
The `cluster-health` operation runs the [Cluster Health API](api-reference/cluster-api/cluster-health/), which checks the cluster health status and returns the expected status according to the parameters set for `request-params`. If an unexpected cluster health status is returned, the operation reports a failure. You can use the `--on-error` option in the OpenSearch Benchmark `execute-test` command to control how OpenSearch Benchmark behaves when the health check fails.
|
||||
|
||||
@ -245,7 +255,9 @@ The `cluster-health` operation returns the following metadata:
|
||||
- `cluster-status`: The current cluster status.
|
||||
- `relocating-shards`: The number of shards currently relocating to a different node.
|
||||
|
||||
<!-- vale off -->
|
||||
## refresh
|
||||
<!-- vale on -->
|
||||
|
||||
The `refresh` operation runs the Refresh API. The `operation` returns no metadata.
|
||||
|
||||
@ -269,7 +281,9 @@ Parameter | Required | Type | Description
|
||||
:--- | :--- | :--- | :---
|
||||
`index` | No | String | The names of the indexes or data streams to refresh.
|
||||
|
||||
<!-- vale off -->
|
||||
## search
|
||||
<!-- vale on -->
|
||||
|
||||
The `search` operation runs the [Search API](/api-reference/search/), which you can use to run queries in OpenSearch Benchmark indexes.
|
||||
|
||||
|
||||
@ -6,7 +6,9 @@ grand_parent: OpenSearch Benchmark Reference
|
||||
nav_order: 110
|
||||
---
|
||||
|
||||
<!-- vale off -->
|
||||
# test_procedures
|
||||
<!-- vale on -->
|
||||
|
||||
If your workload only defines one benchmarking scenario, specify the schedule at the top level. Use the `test-procedures` element to specify additional properties, such as a name or description. A test procedure is like a benchmarking scenario. If you have multiple test procedures, you can define a variety of challenges.
|
||||
|
||||
@ -20,8 +22,9 @@ Parameter | Required | Type | Description
|
||||
`default` | No | Boolean | When set to `true`, selects the default test procedure if you did not specify a test procedure on the command line. If the workload only defines one test procedure, it is implicitly selected as the default. Otherwise, you must define `"default": true` on exactly one challenge.
|
||||
[`schedule`](#Schedule) | Yes | Array | Defines the order in which workload tasks are run.
|
||||
|
||||
|
||||
<!-- vale off -->
|
||||
## schedule
|
||||
<!-- vale on -->
|
||||
|
||||
The `schedule` element contains a list of a tasks, which are operations supported by OpenSearch Benchmark, that are run by the workload during the benchmark test.
|
||||
|
||||
|
||||
@ -12,7 +12,9 @@ OpenSearch Benchmark configuration data is stored in `~/.benchmark/benchmark.ini
|
||||
|
||||
The file is separated into the following sections, which you can customize based on the needs of your cluster.
|
||||
|
||||
<!-- vale off -->
|
||||
## meta
|
||||
<!-- vale on -->
|
||||
|
||||
This section contains meta information about the configuration file.
|
||||
|
||||
@ -20,7 +22,9 @@ This section contains meta information about the configuration file.
|
||||
| :---- | :---- | :---- |
|
||||
| `config.version` | Integer | The version of the configuration file format. This property is managed by OpenSearch Benchmark and should not be changed. |
|
||||
|
||||
<!-- vale off -->
|
||||
## system
|
||||
<!-- vale on -->
|
||||
|
||||
This section contains global information for the current benchmark environment. This information should be identical on all machines on which OpenSearch Benchmark is installed.
|
||||
|
||||
@ -31,7 +35,9 @@ This section contains global information for the current benchmark environment.
|
||||
| `async.debug` | Boolean | Enables debug mode on OpenSearch Benchmark's asyncio event loop. Default is `false`. |
|
||||
| `passenv` | String | A comma-separated list of environment variable names that should be passed to OpenSearch for processing. |
|
||||
|
||||
<!-- vale off -->
|
||||
## node
|
||||
<!-- vale on -->
|
||||
|
||||
This section contains node-specific information that can be customized according to the needs of your cluster.
|
||||
|
||||
@ -40,7 +46,9 @@ This section contains node-specific information that can be customized according
|
||||
| `root.dir` | String | The directory that stores all OpenSearch Benchmark data. OpenSearch Benchmark assumes control over this directory and all its subdirectories. |
|
||||
| `src.root.dir` | String | The directory from which the OpenSearch source code and any OpenSearch plugins are called. Only relevant for benchmarks from [sources](#source). |
|
||||
|
||||
<!-- vale off -->
|
||||
## source
|
||||
<!-- vale on -->
|
||||
|
||||
This section contains more details about the OpenSearch source tree.
|
||||
|
||||
@ -51,7 +59,9 @@ This section contains more details about the OpenSearch source tree.
|
||||
| `cache` | Boolean | Enables OpenSearch's internal source artifact cache, `opensearch*.tar.gz`, and any plugin zip files. Artifacts are cached based on their Git revision. Default is `true`. |
|
||||
| `cache.days` | Integer | The number of days that an artifact should be kept in the source artifact cache. Default is `7`. |
|
||||
|
||||
<!-- vale off -->
|
||||
## benchmarks
|
||||
<!-- vale on -->
|
||||
|
||||
This section contains the settings that can be customized in the OpenSearch Benchmark data directory.
|
||||
|
||||
@ -59,7 +69,9 @@ This section contains the settings that can be customized in the OpenSearch Benc
|
||||
| :---- | :---- | :---- |
|
||||
| `local.dataset.cache` | String | The directory in which benchmark datasets are stored. Depending on the benchmarks that are run, this directory may contain hundreds of GB of data. Default path is `$HOME/.benchmark/benchmarks/data`. |
|
||||
|
||||
<!-- vale off -->
|
||||
## results_publishing
|
||||
<!-- vale on -->
|
||||
|
||||
This section defines how benchmark metrics are stored.
|
||||
|
||||
@ -70,7 +82,9 @@ This section defines how benchmark metrics are stored.
|
||||
| metrics.request.downsample.factor | Integer| (default: 1): Determines how many service time and latency samples are saved in the metrics store. By default, all values are saved. If you want to, for example. keep only every 100th sample, specify `100`. This is useful to avoid overwhelming the metrics store in benchmarks with many clients. Default is `1`. |
|
||||
| `output.processingtime` | Boolean | If set to `true`, OpenSearch shows the additional metric processing time in the command line report. Default is `false`. |
|
||||
|
||||
<!-- vale off -->
|
||||
### `datastore.type` parameters
|
||||
<!-- vale on -->
|
||||
|
||||
When `datastore.type` is set to `opensearch`, the following reporting settings can be customized.
|
||||
|
||||
@ -116,12 +130,15 @@ datastore.user = user-name
|
||||
datastore.password = the-password-to-your-cluster
|
||||
```
|
||||
|
||||
<!-- vale off -->
|
||||
## workloads
|
||||
<!-- vale on -->
|
||||
|
||||
This section defines how workloads are retrieved. All keys are read by OpenSearch using the syntax `<<workload-repository-name>>.url`, which you can select using the OpenSearch Benchmark CLI `--workload-repository=workload-repository-name"` option. By default, OpenSearch chooses the workload repository using the `default.url` `https://github.com/opensearch-project/opensearch-benchmark-workloads`.
|
||||
|
||||
|
||||
<!-- vale off -->
|
||||
## defaults
|
||||
<!-- vale on -->
|
||||
|
||||
This section defines the default values of certain OpenSearch Benchmark CLI parameters.
|
||||
|
||||
@ -129,7 +146,9 @@ This section defines the default values of certain OpenSearch Benchmark CLI para
|
||||
| :---- | :---- | :---- |
|
||||
| `preserve_benchmark_candidate` | Boolean | Determines whether OpenSearch installations are preserved or wiped by default after a benchmark. To preserve an installation for a single benchmark, use the command line flag `--preserve-install`. Default is `false`.
|
||||
|
||||
<!-- vale off -->
|
||||
## distributions
|
||||
<!-- vale on -->
|
||||
|
||||
This section defines how OpenSearch versions are distributed.
|
||||
|
||||
|
||||
@ -124,7 +124,7 @@ docker pull public.ecr.aws/opensearchproject/opensearch-benchmark:latest
|
||||
```
|
||||
{% include copy.html %}
|
||||
|
||||
### Running Benchmark with Docker
|
||||
### Running OpenSearch Benchmark with Docker
|
||||
|
||||
To run OpenSearch Benchmark, use `docker run` to launch a container. OpenSearch Benchmark subcommands are passed as arguments when you start the container. OpenSearch Benchmark then processes the command and stops the container after the requested operation completes.
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@ redirect_from:
|
||||
- /monitoring-plugins/pa/rca/index/
|
||||
---
|
||||
|
||||
# Root Cause Analysis
|
||||
# Root cause analysis
|
||||
|
||||
The OpenSearch Performance Analyzer plugin (PA) captures OpenSearch and JVM activity, plus their lower-level resource usage (e.g. disk, network, CPU, and memory). Based on this instrumentation, Performance Analyzer computes and exposes diagnostic metrics so that administrators can measure and understand the bottlenecks in their OpenSearch clusters.
|
||||
|
||||
|
||||
@ -28,7 +28,7 @@ GET _plugins/_performanceanalyzer/rca?name=HotShardClusterRca
|
||||
```
|
||||
{% include copy-curl.html %}
|
||||
|
||||
#### Example Response
|
||||
#### Example response
|
||||
|
||||
The response contains a list of unhealthy shards:
|
||||
|
||||
|
||||
@ -1623,7 +1623,7 @@ GET _plugins/_security/health
|
||||
|
||||
The following API is available for audit logging in the Security plugin.
|
||||
|
||||
### Enable Audit Logs
|
||||
### Enable audit logs
|
||||
|
||||
This API allows you to enable or disable audit logging, define the configuration for audit logging and compliance, and make updates to settings.
|
||||
|
||||
|
||||
@ -42,7 +42,7 @@ plugins.security.authcz.impersonation_dn:
|
||||
```
|
||||
|
||||
|
||||
## Impersonating Users
|
||||
## Impersonating users
|
||||
|
||||
To impersonate another user, submit a request to the system with the HTTP header `opendistro_security_impersonate_as` set to the name of the user to be impersonated. A good test is to make a GET request to the `_plugins/_security/authinfo` URI:
|
||||
|
||||
|
||||
@ -148,9 +148,9 @@ See [Ingest APIs]({{site.url}}{{site.baseurl}}/api-reference/ingest-apis/index/)
|
||||
- cluster:admin/ingest/pipeline/simulate
|
||||
- cluster:admin/ingest/processor/grok/get
|
||||
|
||||
### Anomaly Detection permissions
|
||||
### Anomaly detection permissions
|
||||
|
||||
See [Anomaly detection API]({{site.url}}{{site.baseurl}}/observing-your-data/ad/api/).
|
||||
See [Anomaly Detection API]({{site.url}}{{site.baseurl}}/observing-your-data/ad/api/).
|
||||
|
||||
- cluster:admin/opendistro/ad/detector/delete
|
||||
- cluster:admin/opendistro/ad/detector/info
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user