Update _clients/logstash/index.md

Co-authored-by: Vijayan Balasubramanian <VijayanB@users.noreply.github.com>
2021-08-03 13:30:21 -07:00 · 2021-08-02 17:34:06 -07:00 · 2021-08-02 17:33:56 -07:00 · 2021-08-02 17:33:45 -07:00 · 2021-08-02 13:00:04 -07:00 · 2021-08-02 11:16:39 -07:00
49 changed files with 1207 additions and 1210 deletions
@@ -34,7 +34,7 @@ If you encounter problems or have questions when contributing to the documentati

 After each commit to this repository, GitHub Pages automatically uses [Jekyll](https://jekyllrb.com) to rebuild the [website](https://docs-beta.opensearch.org). The whole process takes around 30 seconds.

-This repository contains many [Markdown](https://guides.github.com/features/mastering-markdown/) files in the `/docs` directory. Each Markdown file correlates with one page on the website.
+This repository contains many [Markdown](https://guides.github.com/features/mastering-markdown/) files in the `/docs` directory. Each Markdown file correlates with one page on the website. For example, the Markdown file for [this page](https://docs-beta.opensearch.org/docs/opensearch/) is [here](https://github.com/opensearch-project/documentation-website/blob/master/docs/opensearch/index.md).

 Using plain text on GitHub has many advantages:

@@ -0,0 +1,246 @@
+---
+layout: default
+title: Advanced configurations
+parent: Logstash
+nav_order: 230
+---
+
+# Advanced configurations
+
+This section describes how to set up advanced configuration options, like referencing field values and conditional statements, for Logstash.
+
+## Referencing field values
+
+To get access to a field, use the `- field` syntax.
+You can also surround the field name by square brackets `- [field]` which makes it more explicit that you're referring to a field.
+
+
+For example, if you have the following event:
+
+```bash
+{
+  "request": "/products/view/123",
+  "verb": "GET",
+  "response": 200,
+  "headers": {
+  "request_path" => "/"
+  }
+}
+```
+
+To access the `request` field, use `- request` or `- [request]`.
+
+If you want to reference nested fields, use the square brackets syntax and specify the path to the field. With each level being enclosed within square brackets: `- [headers][request_path]`.
+
+You can reference fields using the `sprintf` format. This is also called string expansion. You need to add a % sign and then wrap the field reference within curly brackets.
+
+You need to reference field values when using conditional statements.
+
+For example, you can make the file name dynamic and contain the type of the processed events - either `access` or `error`. The `type` option is mainly used for conditionally applying filter plugins based on the type of events being processed.
+
+Let's add a `type` option and specify a value of `access`.
+
+
+```yml
+input {
+  file {
+    path => ""
+  start_position => "beginning"
+  type => "access"
+  }
+  http {
+    type => "access"
+  }
+}
+
+filter {
+  mutate {
+    remove_field => {"host"}
+  }
+}
+
+output {
+  stdout {
+    codec => rubydebug
+  }
+file {
+  path => "%{[type]}.log"
+  }
+}
+```
+
+Start Logstash and send an HTTP request. The processed event is output in the terminal. The event now includes a field named `type`.
+
+You'll see the `access.log` file created within the Logstash directory.
+
+## Conditional statements
+
+You can use conditional statements to control the flow of code execution based on some conditions.
+
+Syntax:
+
+```yml
+if EXPR {
+  ...
+} else if EXPR {
+  ...
+} else {
+  ...
+}
+```
+
+`EXPR` is any valid Logstash syntax that evaluates to a boolean value.
+For example, you can check if an event type is set to `access` or `error` and perform some action based on that:
+
+```yml
+if [type] == "access" {
+...
+} else if [type] == "error" {
+file { .. }
+} else {
+...
+}
+```
+
+You can compare a field value to some arbitrary value:
+
+```yml
+if [headers][content_length] >= 1000 {
+...
+}
+```
+
+You can regex:
+
+```yml
+if [some_field =~ /[0-9]+/ {
+  //some field only contains digits
+}
+```
+
+You can use arrays:
+
+```yml
+if [some_field] in ["one", "two", "three"] {
+  some field is either "one", "two", or "three"
+}
+```
+
+You can use boolean operators:
+
+```yml
+if [type] == "access" or [type] == "error" {
+  ...
+}
+```
+
+
+## Formatting dates
+
+You can use the `sprintf` format or string expansion to format dates.
+For example, you might want the current date to be part of the filename.
+
+To format the date, add a plus sign in curly brackets followed by the date format - `%{+yyyy-MM-dd}`.
+
+```yml
+file {
+  path => "%{[type]}_%{+yyyy_MM_dd}.log"
+}
+```
+
+This is the date stored within the @timestamp fields, which is the time and date of the event.
+Send a request to the pipeline and verify that a filename is outputted that contains the events date.
+
+You can embed the date in other outputs as well, for example into the index name in OpenSearch.
+
+## Sending time information
+
+You can set the time of events.
+
+Logstash already sets the time when the event is received by the input plugin within the @timestamp field.
+In some scenarios, you might need to use a different timestamp.
+For example, if you have an eCommerce store and you process the orders daily at midnight. When Logstash receives the events at midnight, it sets the timestamp to the current time.
+But you want it to be the time when the order is placed and not when Logstash received the event.
+
+Let's change the event timestamp to the date the request is received by the web server. You can do this using a filter plugin named `dates`.
+The `dates` filter passes a `date` or `datetime` value from a field and uses the results as the event timestamp.
+
+Add the `date` plugin at the bottom of the `filter` block:
+
+```yml
+date {
+  match => [ "timestamp", "dd/MMM/yyyy:HH:mm:ss Z" ]
+}
+```
+
+timestamp is the field that the `grok` pattern creates.
+`Z` is the timezone. i.e., UTC offsets.
+
+Start Logstash and send an HTTP request.
+
+You can see that the filename contains the date of the request instead of the present date.
+
+If the passing of the date fails, the `filter` plugin adds a tag named `_datepassfailure` to the text field.
+
+After you have set the @timestamp field to a new value, you don't really need the other `timestamp` field anymore. You can remove it with the `remove_field` option.
+
+```yml
+date {
+  match => [ "timestamp", "dd/MMM/yyyy:HH:mm:ss Z" ]
+  remove_field => [ "timestamp" ]
+}
+```
+
+## Parsing user agents
+
+The user agent is the last part of a log entry that consists of the name of the browser, the browser version, and the OS of the device.
+
+Users might be using a wide range of browsers, devices, and OS's. Doing this manually is hard.
+
+You can't use `grok` patterns because the `grok` pattern only matches the usage in the string as whole and doesn't figure out which browser the visitor used for instance.
+
+Logstash ships with a file containing regular expressions for this purpose. This makes it really easy to extract user agent information, which you could send to OpenSearch and run aggregations on.
+
+To do this, add a `source` option that contains the name of the field. In this case, that's the `agent` field.
+By default the user agent plugin, adds a number of fields at the top-level of the event.
+Since that can get pretty confusing, we can add an option named `target` with a value of `ua`, short for user agent. What this does is that it nests the fields within an object named `ua`, making things more organized.
+
+```yml
+useragent {
+  source => "agent"
+  target => "ua"
+}
+```
+
+Start Logstah and send an HTTP request.
+
+You can see a field named `ua` with a number of keys including the browser name and version, the OS, and the device.
+
+You could OpenSearch Dashboards to create a pie chart that shows how many visitors are from mobile devices and how many are desktop users. Or, you could get statistics on which browser versions are popular.
+
+## Enriching geographical data
+
+You can take an IP address and perform geographical lookup to resolve the geographical location of the user using the `geoip` filter.
+
+The `geoip` filter plugin ships with a database called `geolite 2`, which is provided by a company named MaxMind. `geolite 2` is a popular source of geographical data and it's available for free.
+Add the `geoip` plugin at the bottom of the `else` block.
+
+The value of the `source` option is the name of the field containing the IP address, in this case that's `clientip`. You can make this field available using the `grok` pattern.
+
+```yml
+geoip {
+  source => "clientip"
+}
+```
+
+Start Logstash and send an HTTP request.
+
+Within the terminal, you see a new field named `geoip` that contains information such as the timezone, country, continent, city, postal code, and the latitude / longitude pair.
+
+If you only need the country name for instance, include an option named `fields` with an array of the field names that you want the `geoip` plugin to return.
+
+Some of the fields are not always available such as city name and region because translating IP addresses into geographical locations is generally not that accurate. If the `geoip` plugin fails to look up the geographical location, it adds a tag named `geoip_lookup_failure`.
+
+You can use the `geoip` plugin with the OpenSearch output because `location` object within the `geoip` object, is a standard format for representing geospatial data in JSON. This is the same format as OpenSearch uses for its `geo_point` data type.
+
+You can use the powerful geospatial queries of OpenSearch for working with geographical data.
@@ -0,0 +1,157 @@
+---
+layout: default
+title: Common filter plugins
+parent: Logstash
+nav_order: 220
+---
+
+# Common filter plugins
+
+This page contains a list of common filter plugins.
+
+## mutate
+
+You can use the `mutate` filter to change the data type of a field. For example, you can use the `mutate` filter if you're sending events to OpenSearch and you need to change the data type of a field to match any existing mappings.
+
+To convert the `quantity` field from a `string` type to an `integer` type:
+
+```yml
+input {
+  http {
+    host => "127.0.0.1"
+    port => 8080
+  }
+}
+
+filter {
+  mutate {
+   convert => {"quantity" => "integer"}
+  }
+}
+
+output {
+  file {
+    path => "output.txt"
+  }
+}
+```
+
+#### Sample output
+
+You can see that the type of the `quantity` field is changed from a `string` to an `integer`.
+
+```yml
+{
+  "quantity" => 3,
+  "host" => "127.0.0.1",
+  "@timestamp" => 2021-05-23T19:02:08.026Z,
+  "amount" => 10,
+  "@version" => "1",
+  "headers" => {
+    "request_path" => "/",
+    "connection" => "keep-alive",
+    "content_length" => "41",
+    "http_user_agent" => "PostmanRuntime/7.26.8",
+    "request_method" => "PUT",
+    "cache_control" => "no-cache",
+    "http_accept" => "*/*",
+    "content_type" => "application/json",
+    "http_version" => "HTTP/1.1",
+    "http_host" => "127.0.0.1:8080",
+    "accept_encoding" => "gzip, deflate, br",
+    "postman_token" => "ffd1cdcb-7a1d-4d63-90f8-0f2773069205"
+   }
+}
+```
+
+Other data types you can convert to are `float`, `string`, and `boolean` values. If you pass in an array, the `mutate` filter converts all the elements in the array. If you pass a `string` like "world" to cast to an `integer` type, the result is 0 and Logstash continues processing events.
+
+Logstash supports a few common options for all filter plugins:
+
+Option | Description
+:--- | :---
+`add_field` | Adds one or more fields to the event.
+`remove_field` | Removes one or more events from the field.
+`add_tag` | Adds one or more tags to the event. You can use tags to perform conditional processing on events depending on which tags they contain.
+`remove_tag` | Removes one or more tags from the event.
+
+For example, you can remove the `host` field from the event:
+
+```yml
+input {
+  http {
+    host => "127.0.0.1"
+    port => 8080
+  }
+}
+
+filter {
+  mutate {
+    remove_field => {"host"}
+  }
+}
+
+output {
+  file {
+    path => "output.txt"
+  }
+}
+```
+
+## grok
+
+With the `grok` filter, you can parse unstructured data and and structure it into fields. The `grok` filter uses text patterns to match text in your logs. You can think of text patterns as variables containing regular expressions.
+
+The format of a text pattern is as follows:
+
+```bash
+%{SYNTAX:SEMANTIC}
+```
+
+`SYNTAX` is the format a piece of text should be in for the pattern to match. You can enter any of `grok`'s predefined patterns. For example, you can use the email identifier to match an email address from a given piece of text.
+
+`SEMANTIC` is an arbitrary name for the matched text. For example, if you're using the email identifier syntax, you can name it “email.”
+
+The following request consists of the IP address of the visitor, name of the visitor, the timestamp of the request, the HTTP verb and URL, the HTTP status code, and the number of bytes:
+
+```bash
+184.252.108.229 - joe [20/Sep/2017:13:22:22 +0200] GET /products/view/123 200 12798
+```
+
+To split this request into different fields:
+
+```yml
+filter {
+  grok {
+   match => { "message" => " %{IP: ip_address} %{USER:identity}
+                             %{USER:auth} \[%{HTTPDATE:reg_ts}\]
+                             \"%{WORD:http_verb}
+                             %{URIPATHPARAM: req_path}
+                             \" %{INT:http_status:int}
+                             %{INT:num_bytes:int}"}
+  }
+}
+```
+
+where:
+
+- `IP`: matches the IP address field.
+- `USER`: matches the user name.
+- `WORD`: matches the HTTP verb.
+- `URIPATHPARAM`: matches the URI path.
+- `INT`: matches the HTTP status field.
+- `INT`: matches the number of bytes.
+
+This is what the event looks like after the `grok` filter breaks it down into individual fields:
+
+```yml
+ip_address: 184.252.108.229
+identity: joe
+reg_ts: 20/Sep/2017:13:22:22 +0200
+http_verb:GET
+req_path: /products/view/123
+http_status: 200
+num_bytes: 12798
+```
+
+For common log formats, you use the predefined patterns defined here⁠---[Logstash patterns](https://github.com/logstash-plugins/logstash-patterns-core/blob/master/patterns/ecs-v1). You can make any adjustments to the results with the `mutate` filter.
@@ -0,0 +1,40 @@
+---
+layout: default
+title: Logstash execution model
+parent: Logstash
+nav_order: 210
+---
+
+# Logstash execution model
+
+Here's a brief introduction to how Logstash processes events internally.
+
+## Handling events concurrently
+
+You can configure Logstash to have a number of inputs listening for events. Each input runs in its own thread to avoid inputs blocking each other. If you have two incoming events at the same time, Logstash handles both events concurrently.
+
+After receiving an event and possibly applying an input codec, Logstash sends the event to a work queue. Pipeline workers or batchers perform the rest of the work involving filters and outputs along with any codec used at the output. Each pipeline worker also runs within its own thread meaning that Logstash processes multiple events simultaneously.
+
+## Processing events in batches
+
+A pipeline worker consumes events from the work queue in batches to optimize the throughput of the pipeline as a whole.
+
+One reason why Logstash works in batches is that some code needs to be executed regardless of how many events are processed at a time within the pipeline worker. Instead of executing that code 100 times for 100 events, it’s more efficient to execute it once for a batch of 100 events.
+
+Another reason is that a few output plugins group together events as batches. For example, if you send 100 requests to OpenSearch, the OpenSearch output plugin uses the bulk API to send a single request that groups together the 100 requests.
+
+Logstash determines the batch size by two configuration options⁠---a number representing the maximum batch size and the batch delay. The batch delay is how long Logstash waits before processing the unprocessed batch of events.
+If you set the maximum batch size to 50 and the batch delay to 100 ms, Logstash processes a batch if they're either 50 unprocessed events in the work queue or if one hundred milliseconds have elapsed.
+
+The reason that a batch is processed, even if the maximum batch size isn’t reached, is to reduce the delay in processing and to continue to process events in a timely manner. This works well for pipelines that process a low volume of events.
+
+Imagine that you’ve a pipeline that processes error logs from web servers and pushes them to OpenSearch. You’re using OpenSearch Dashboards to analyze the error logs. Because you’re possibly dealing with a fairly low number of events, it might take a long time to reach 50 events. Logstash processes the events before reaching this threshold because otherwise there would be a long delay before we see the errors appear in OpenSearch Dashboards.
+
+The default batch size and batch delay work for most cases. You don’t need to change the default values unless you need to minutely optimize the performance.
+
+## Optimizing based on CPU cores
+
+The number of pipeline workers are proportional to the number of CPU cores on the nodes.
+If you have 5 workers running on a server with 2 CPU cores, the 5 workers won't be able to process events concurrently. On the other hand, running 5 workers on a server running 10 CPU cores limits the throughput of a Logstash instance.
+
+Instead of running a fixed number of workers, which results in poor performance in some cases, Logstash examines the number of CPU cores of the instance and selects the number of pipeline workers to optimize its performance for the platform on which its running. For instance, your local development machine might not have the same processing power as a production server. So you don't need to manually configure Logstash for different machines.
@@ -0,0 +1,356 @@
+---
+layout: default
+title: Logstash
+nav_order: 200
+has_children: true
+has_toc: true
+---
+
+# Logstash
+
+Logstash is a real-time event processing engine. It's part of the OpenSearch stack which includes OpenSearch, Beats, and OpenSearch Dashboards.
+
+You can send events to Logstash from many different sources. Logstash processes the events and sends it one or more destinations. For example, you can send access logs from a web server to Logstash. Logstash extracts useful information from each log and sends it to a destination like OpenSearch.
+
+Sending events to Logstash lets you decouple event processing from your app. Your app only needs to send events to Logstash and doesn’t need to know anything about what happens to the events afterwards.
+
+The open-source community originally built Logstash for processing log data but now you can process any type of events, including events in XML or JSON format.
+
+## Structure of a pipeline
+
+The way that Logstash works is that you configure a pipeline that has three phases⁠---inputs, filters, and outputs.
+
+Each phase uses one or more plugins. Logstash has over 200 built-in plugins so chances are that you’ll find what you need. Apart from the built-in plugins, you can use plugins from the community or even write your own.
+
+The structure of a pipeline is as follows:
+
+```yml
+input {
+  input_plugin => {}
+}
+
+filter {
+  filter_plugin => {}
+}
+
+output {
+  output_plugin => {}
+}
+```
+
+where:
+
+* `input` receives events like logs from multiple sources simultaneously. Logstash supports a number of input plugins for TCP/UDP, files, syslog, Microsoft Windows EventLogs, stdin, HTTP, and so on. You can also use an open source collection of input tools called Beats to gather events. The input plugin sends the events to a filter.
+* `filter` parses and enriches the events in one way or the other. Logstash has a large collection of filter plugins that modify events and pass them on to an output. For example, a `grok` filter parses unstructured events into fields and a `mutate` filter changes fields. Filters are executed sequentially.
+* `output` ships the filtered events to one or more destinations. Logstash supports a wide range of output plugins for destinations like OpenSearch, TCP/UDP, emails, files, stdout, HTTP, Nagios, and so on.
+
+Both the input and output phases support codecs to process events as they enter or exit the pipeline.
+Some of the popular codecs are `json` and `multiline`. The `json` codec processes data that’s in JSON format and the `multiline` codec merges multiple line events into a single line.
+
+You can also write conditional statements within pipeline configurations to perform certain actions, if a certain criteria is met.
+
+## Install Logstash
+
+The OpenSearch Logstash plugin has two installation options at this time: Linux (ARM64/X64) and Docker (ARM64/X64).
+
+Make sure you have [Java Development Kit (JDK)](https://www.oracle.com/java/technologies/javase-downloads.html) version 8 or 11 installed.
+
+### Tarball
+
+1. Download the Logstash tarball from [OpenSearch downloads](https://opensearch.org/downloads.html).
+
+2. Navigate to the downloaded folder in the terminal and extract the files:
+
+     ```bash
+     tar -zxvf logstash-oss-with-opensearch-output-plugin-7.13.2-linux-x64.tar.gz
+     ```
+
+3. Navigate to the `logstash-7.13.2` directory.
+- You can add your pipeline configurations to the `config` directory. Logstash saves any data from the plugins in the `data` directory. The `bin` directory contains the binaries for starting Logstash and managing plugins.
+
+### Docker
+
+1. Pull the Logstash oss package with the OpenSearch output plugin image:
+
+```
+docker pull opensearchproject/logstash-oss-with-opensearch-output-plugin:7.13.2
+```
+
+1. Create a Docker network:
+
+```
+docker network create test
+```
+
+1. Start OpenSearch with this network:
+
+```
+docker run -p 9200:9200 -p 9600:9600 --name opensearch --net test -e "discovery.type=single-node" opensearchproject/opensearch:1.0.0
+```
+
+1. Start Logstash:
+
+```
+docker run -it --rm --name logstash --net test openserachproject/logstash-oss-with-opensearch-output-plugin:7.13.2 -e 'input { stdin { } } output {
+  opensearch {
+    hosts => ["https://opensearch:9200"]
+    index => "opensearch-logstash-docker-%{+YYYY.MM.dd}"
+    user => "admin"
+    password => "admin"
+    ssl => true
+    ssl_certificate_verification => false
+  }
+}'
+```
+
+## Process text from the terminal
+
+You can define a pipeline that listens for events on `stdin` and outputs events on `stdout`. `stdin` and `stdout` refer to the terminal in which you’re running Logstash.
+
+To enter some text in the terminal and see the event data in the output:
+
+1. Use the `-e` argument to pass a pipeline configuration directly to the Logstash binary. In this case, `stdin` is the input plugin and `stdout` is the output plugin:
+
+    ```bash
+    bin/logstash -e "input { stdin { } } output { stdout { } }"
+    ```
+    Add the `—debug` flag to see a more detailed output.
+
+2. Enter "hello world" in your terminal. Logstash processes the text and outputs it back to the terminal:
+
+    ```yml
+    {
+     "message" => "hello world",
+     "host" => "a483e711a548.ant.amazon.com",
+     "@timestamp" => 2021-05-30T05:15:56.816Z,
+     "@version" => "1"
+    }
+    ```
+
+    The `message` field contains your raw input. The `host` field is an IP address when you don’t run Logstash locally. `@timestamp` shows the date and time for when the event is processed. Logstash uses the `@version` field for internal processing.
+
+3. Press `Ctrl + C` to shut down Logstash.
+
+### Troubleshooting
+
+If you already have a Logstash process running, you’ll get an error. To fix this issue:
+
+1. Delete the `.lock` file from the `data` directory:
+
+    ```bash
+    cd data
+    rm -rf .lock
+    ```
+
+2. Restart Logstash.
+
+## Process JSON or HTTP input and output it to a file
+
+To define a pipeline that handles JSON requests:
+
+1. Open the `config/pipeline.conf` file in any text editor you like. You can create a pipeline configuration file with any extension, the `.conf` extension is a Logstash convention. Add the `json` codec to accept JSON as the input and the `file` plugin to output the processed events to a `.txt` file:
+
+    ```yml
+    input {
+      stdin {
+        codec => json
+      }
+    }
+    output {
+      file {
+        path => "output.txt"
+      }
+    }
+    ```
+
+    To process inputs from a file, add an input file to the `events-data` directory and then pass its path to the `file` plugin at the input:
+
+    ```yml
+    input {
+      file {
+        path => "events-data/input_data.log"
+      }
+    }
+    ```
+
+2. Start Logstash:
+
+    ```bash
+    $ bin/logstash -f config/pipeline.conf
+    ```
+
+    `config/pipeline.conf` is a relative path to the `pipeline.conf` file. You can use an absolute path as well.
+
+3. Add a JSON object in the terminal:
+
+    ```json
+    { "amount": 10, "quantity": 2}
+    ```
+
+    The pipeline only handles a single line of input. If you paste some JSON that spans multiple lines, you’ll get an error.
+
+4. Check that the fields from the JSON object are added to the `output.txt` file:
+
+    ```json
+    $ cat output.txt
+
+    {
+      "@version": "1",
+      "@timestamp": "2021-05-30T05:52:52.421Z",
+      "host": "a483e711a548.ant.amazon.com",
+      "amount": 10,
+      "quantity": 2
+    }
+    ```
+
+    If you type in some invalid JSON as the input, you'll see a JSON parsing error. Logstash doesn't discard the invalid JSON because you still might want to do something with it. For example, you can trigger an email or send a notification to a Slack channel.
+
+To define a pipeline that handles HTTP requests:
+
+1. Use the `http` plugin to send events to Logstash through HTTP:
+
+    ```yml
+    input {
+      http {
+        host => "127.0.0.1"
+        port => 8080
+      }
+    }
+
+    output {
+      file {
+        path => "output.txt"
+      }
+    }
+    ```
+
+    If you don’t specify any options, the `http` plugin binds to `localhost` and listens on port 8080.
+
+2. Start Logstash:
+
+    ```bash
+    $ bin/logstash -f config/pipeline.conf
+    ```
+
+3. Use Postman to send an HTTP request. Set `Content-Type` to an HTTP header with a value of `application/json`:
+
+    ```json
+    PUT 127.0.0.1:8080
+
+    {
+      "amount": 10,
+      "quantity": 2
+    }
+    ```
+
+    Or, you can use the `curl` command:
+
+    ```bash
+    curl -XPUT -H "Content-Type: application/json" -d ' {"amount": 7, "quantity": 3 }' http://localhost:8080 (http://localhost:8080/)
+    ```
+
+    Even though we haven't added the `json` plugin to the input, the pipeline configuration still works because the HTTP plugin automatically applies the appropriate codec based on the `Content-Type` header.
+    If you specify a value of `applications/json`, Logstash parses the request body as JSON.
+
+    The `headers` field contains the HTTP headers that Logstash receives:
+
+    ```json
+    {
+      "host": "127.0.0.1",
+      "quantity": "3",
+      "amount": 10,
+      "@timestamp": "2021-05-30T06:05:48.135Z",
+      "headers": {
+        "http_version": "HTTP/1.1",
+        "request_method": "PUT",
+        "http_user_agent": "PostmanRuntime/7.26.8",
+        "connection": "keep-alive",
+        "postman_token": "c6cd29cf-1b37-4420-8db3-9faec66b9e7e",
+        "http_host": "127.0.0.1:8080",
+        "cache_control": "no-cache",
+        "request_path": "/",
+        "content_type": "application/json",
+        "http_accept": "*/*",
+        "content_length": "41",
+        "accept_encoding": "gzip, deflate, br"
+      },
+    "@version": "1"
+    }
+    ```
+
+
+## Automatically reload the pipeline configuration
+
+You can configure Logstash to detect any changes to the pipeline configuration file or the input log file and automatically reload the configuration.
+
+The `stdin` plugin doesn’t supporting automatic reloading.
+{: .note }
+
+1. Add an option named `start_position` with a value of `beginning` to the input plugin:
+
+    ```yml
+    input {
+      file {
+        path => "/Users/<user>/Desktop/logstash7-12.1/events-data/input_file.log"
+        start_position => "beginning"
+      }
+    }
+    ```
+
+    Logstash only processes any new events added to the input file and ignores the ones that it has already processed to avoid processing the same event more than once on restart.
+
+    Logstash records its progress in a file that's referred to as a `sinceDB` file. Logstash creates a `sinceDB` file for each file that it watches for changes.
+
+2. Open the `sinceDB` file to check how much of the input files are processed:
+
+    ```bash
+    cd data/plugins/inputs/file/
+    ls -al
+
+    -rw-r--r--  1 user  staff   0 Jun 13 10:50 .sincedb_9e484f2a9e6c0d1bdfe6f23ac107ffc5
+
+    cat .sincedb_9e484f2a9e6c0d1bdfe6f23ac107ffc5
+
+    51575938 1 4 7727
+    ```
+
+    The last number in the `sinceDB` file (7727) is the byte offset of the last known event processed.
+
+5. To process the input file from the beginning, delete the `sinceDB` file:
+
+    ```yml
+    rm .sincedb_*
+    ```
+
+2. Start Logstash with a `—-config.reload.automatic` argument:
+
+    ```bash
+    bin/logstash -f config/pipeline.conf --config.reload.automatic
+    ```
+
+    The `reload` option only reloads if you add a new line at the end of the pipeline configuration file.
+
+    Sample output:
+
+    ```yml
+    {
+       "message" => "216.243.171.38 - - [20/Sep/2017:19:11:52 +0200] \"GET /products/view/123 HTTP/1.1\" 200 12798 \"https://codingexplained.com/products\" \"Mozilla/5.0 (compatible; YandexBot/3.0; +http://yandex.com/bots)\"",
+       "@version" => "1",
+          "host" => "a483e711a548.ant.amazon.com",
+          "path" => "/Users/kumarjao/Desktop/odfe1/logstash-7.12.1/events-data/input_file.log",
+       "@timestamp" => 2021-06-13T18:03:30.423Z
+    }
+    {
+       "message" => "91.59.108.75 - - [20/Sep/2017:20:11:43 +0200] \"GET /js/main.js HTTP/1.1\" 200 588 \"https://codingexplained.com/products/view/863\" \"Mozilla/5.0 (Windows NT 6.1; WOW64; rv:45.0) Gecko/20100101 Firefox/45.0\"",
+      "@version" => "1",
+          "host" => "a483e711a548.ant.amazon.com",
+          "path" => "/Users/kumarjao/Desktop/odfe1/logstash-7.12.1/events-data/input_file.log",
+    "@timestamp" => 2021-06-13T18:03:30.424Z
+    }
+    ```
+
+7. Add a new line to the input file.
+    - Logstash immediately detects the change and processes the new line as an event.
+
+8. Make a change to the `pipeline.conf` file.
+    - Logstash immediately detects the change and reloads the modified pipeline.
@@ -0,0 +1,77 @@
+---
+layout: default
+title: Ship events to OpenSearch
+parent: Logstash
+nav_order: 220
+---
+
+# Ship events to OpenSearch
+
+You can Ship Logstash events to an OpenSearch cluster and then visualize your events with OpenSearch Dashboards.
+
+Make sure you have [Logstash]({{site.url}}{{site.baseurl}}/logstash/index/#install-logstash-on-mac--linux), [OpenSearch]({{site.url}}{{site.baseurl}}/opensearch/install/index/), and [OpenSearch Dashboards]({{site.url}}{{site.baseurl}}/dashboards/install/index/).
+{: .note }
+
+## OpenSearch output plugin
+
+To run the OpenSearch output plugin, add the following configuration in your `pipeline.conf` file:
+
+```yml
+output {
+  opensearch {
+    hosts       => "https://localhost:9200"
+    user        => "admin"
+    password    => "admin"
+    index       => "logstash-logs-%{+YYYY.MM.dd}"
+    ssl_certificate_verification => false
+  }
+}
+```
+
+
+## Sample walkthrough
+
+1.  Open the `config/pipeline.conf` file and add in the following configuration:
+
+    ```yml
+    input {
+      stdin {
+        codec => json
+      }
+    }
+
+    output {
+      opensearch {
+        hosts       => "https://localhost:9200"
+        user        => "admin"
+        password    => "admin"
+        index       => "logstash-logs-%{+YYYY.MM.dd}"
+        ssl_certificate_verification => false
+      }
+    }
+    ```
+
+    This Logstash pipeline accepts JSON input through the terminal and ships the events to an OpenSearch cluster running locally. Logstash writes the events to an index with the `logstash-logs-%{+YYYY.MM.dd}` naming convention.
+
+2. Start Logstash:
+
+    ```bash
+    $ bin/logstash -f config/pipeline.conf --config.reload.automatic
+    ```
+
+    `config/pipeline.conf` is a relative path to the `pipeline.conf` file. You can use an absolute path as well.
+
+3. Add a JSON object in the terminal:
+
+    ```json
+    { "amount": 10, "quantity": 2}
+    ```
+
+4. Start OpenSearch Dashboards and choose **Dev Tools**:
+
+    ```json
+    GET _cat/indices?v
+
+    health | status | index | uuid | pri | rep | docs.count | docs.deleted | store.size | pri.store.size
+    green | open | logstash-logs-2021.07.01 | iuh648LYSnmQrkGf70pplA | 1 | 1 | 1 | 0 | 10.3kb | 5.1kb
+    ```
@@ -27,7 +27,7 @@ color_scheme: opensearch
 # Define Jekyll collections
 collections:
  # Define a collection named "tests", its documents reside in the "_tests" directory
-  upgrade-to:
+  migrate:
    permalink: /:collection/:path/
    output: true
  opensearch:
@@ -61,8 +61,8 @@ collections:
 just_the_docs:
  # Define the collections used in the theme
  collections:
-    upgrade-to:
-      name: Upgrade to OpenSearch
+    migrate:
+      name: Migrate to OpenSearch
      # nav_exclude: true
      nav_fold: true
      # search_exclude: true
@@ -1,14 +1,12 @@
 ---
 layout: default
-title: Upgrade Docker clusters to OpenSearch
+title: Docker migration
 nav_order: 25
-redirect_from:
-  - /migrate/docker-migrate/
 ---

-# Upgrade Docker clusters to OpenSearch
+# Docker migration

-If you use a container orchestration system like Kubernetes (or manage your containers manually) and want to avoid downtime, think of the process not as an upgrade of each node, but as a decommissioning and replacement of each node. One by one, add OpenSearch nodes to the cluster and remove Elasticsearch OSS nodes, pointing to existing data volumes as necessary and allowing time for all indices to return to a green status prior to proceeding.
+If you use a container orchestration system like Kubernetes (or manage your containers manually) and want to avoid downtime, think of the process not as an upgrade of each node, but as a decommissioning and replacement of each node. One by one, add OpenSearch nodes to the cluster and remove Elasticsearch OSS nodes, allowing time for all indices to return to a green status prior to proceeding.

 If you use Docker Compose, we highly recommend that you perform what amounts to a [cluster restart upgrade]({{site.url}}{{site.baseurl}}/migrate/upgrade-migrate/). Update your cluster configuration with new images, new settings, and new environment variables, and test it. Then stop and start the cluster. This process requires downtime, but takes very few steps and lets you continue to treat the cluster as a single entity that you can reliably deploy and redeploy.

@@ -0,0 +1,13 @@
+---
+layout: default
+title: About migrating
+nav_order: 1
+redirect_from: /migrate/
+---
+
+# About migrating
+
+The process of migrating from Elasticsearch OSS (including Open Distro for Elasticsearch) to OpenSearch varies depending on your current version of Elasticsearch OSS, install type, tolerance for downtime, and cost-sensitivity. Rather than concrete steps to cover every situation, we have general guidance for the process.
+
+To safeguard against data loss, we recommend that you take a [snapshot]({{site.url}}{{site.baseurl}}/opensearch/snapshot-restore/) of all indices prior to any migration.
+{: .tip }
@@ -1,12 +1,10 @@
 ---
 layout: default
-title: Use snapshots to migrate data
+title: Snapshot migration
 nav_order: 5
-redirect_from:
-  - /migrate/snapshot-migrate/
 ---

-# Use snapshots to migrate data
+# Snapshot migration

 One popular approach is to take a [snapshot]({{site.url}}{{site.baseurl}}/opensearch/snapshot-restore/) of your Elasticsearch OSS 6.x or 7.x indices, [create an OpenSearch cluster]({{site.url}}{{site.baseurl}}/opensearch/install/), restore the snapshot on the new cluster, and point your clients to the new host.

@@ -2,15 +2,13 @@
 layout: default
 title: Upgrade from Elasticsearch OSS to OpenSearch
 nav_order: 15
-redirect_from:
-  - /migrate/upgrade-migrate/
 ---

-# Upgrade from Elasticsearch OSS to OpenSearch
+# Upgrade from Elasticsearch OSS to OpenSearch (Linux)

-If you want to upgrade from an existing Elasticsearch OSS cluster to OpenSearch and find the [snapshot approach]({{site.url}}{{site.baseurl}}/migrate/snapshot-migrate/) unappealing, you can upgrade your existing nodes from Elasticsearch OSS to OpenSearch.
+If you want to migrate an existing Elasticsearch OSS cluster to OpenSearch and find the [snapshot approach]({{site.url}}{{site.baseurl}}/migrate/snapshot-migrate/) unappealing, you can upgrade the cluster instead. The first step is to upgrade your Elasticsearch OSS cluster to version 6.x or 7.x.

-If your existing cluster runs an older version of Elasticsearch OSS, the first step is to upgrade to version 6.x or 7.x. Elasticsearch OSS supports two types of upgrades: rolling and cluster restart.
+Elasticsearch OSS supports two types of upgrades: rolling and cluster restart.

 - Rolling upgrades let you shut down one node at a time for minimal disruption of service.

@@ -123,7 +121,7 @@ Elasticsearch OSS version | Rolling upgrade path | Cluster restart upgrade path
   sudo systemctl stop elasticsearch.service
   ```

-   For tarball installations, find the process ID (`ps aux`) and kill it (`kill <pid>`).
+   For tarball installations, find the process ID and kill it.

 1. Upgrade the node (rolling) or all nodes (cluster restart).

@@ -15,7 +15,7 @@ Data Prepper is an independent component, not an OpenSearch plugin, that convert
 To use the Docker image, pull it like any other image:

 ```bash
-docker pull opensearchproject/data-prepper:latest
+docker pull opensearch/opensearch-data-prepper:latest
 ```

 Otherwise, [download](https://opensearch.org/downloads.html) the appropriate archive for your operating system and unzip it.
@@ -0,0 +1,256 @@
+---
+layout: default
+title: CAT API
+nav_order:  20
+---
+
+# cat API
+
+You can get essential statistics about your cluster in an easy-to-understand, tabular format using the compact and aligned text (CAT) API. The cat API is a human-readable interface that returns plain text instead of traditional JSON.
+
+Using the cat API, you can answer questions like which node is the elected master, what state is the cluster in, how many documents are in each index, and so on.
+
+To see the available operations in the cat API, use the following command:
+
+```
+GET _cat
+```
+
+You can also use the following string parameters with your query.
+
+Parameter | Description
+:--- | :--- |
+`?v` |  Makes the output more verbose by adding headers to the columns. It also adds some formatting to help align each of the columns together. All examples on this page include the `v` parameter.
+`?help` | Lists the default and other available headers for a given operation.
+`?h`  |  Limits the output to specific headers.
+`?format` |  Outputs the result in JSON, YAML, or CBOR formats.
+`?sort` | Sorts the output by the specified columns.
+
+To see what each column represents, use the `?v` parameter:
+
+```
+GET _cat/<operation_name>?v
+```
+
+To see all the available headers, use the `?help` parameter:
+
+```
+GET _cat/<operation_name>?help
+```
+
+To limit the output to a subset of headers, use the `?h` parameter:
+
+```
+GET _cat/<operation_name>?h=<header_name_1>,<header_name_2>&v
+```
+
+Typically, for any operation you can find out what headers are available using the `?help` parameter, and then use the `?h` parameter to limit the output to only the headers that you care about.
+
+---
+
+#### Table of contents
+1. TOC
+{:toc}
+
+---
+## Aliases
+
+Lists the mapping of aliases to indices, plus routing and filtering information.
+
+```
+GET _cat/aliases?v
+```
+
+To limit the information to a specific alias, add the alias name after your query.
+
+```
+GET _cat/aliases/<alias>?v
+```
+
+## Allocation
+
+Lists the allocation of disk space for indices and the number of shards on each node.
+Default request:
+```
+GET _cat/allocation?v
+```
+
+## Count
+
+Lists the number of documents in your cluster.
+
+```
+GET _cat/count?v
+```
+
+To see the number of documents in a specific index, add the index name after your query.
+
+```
+GET _cat/count/<index>?v
+```
+
+## Field data
+
+Lists the memory size used by each field per node.
+
+```
+GET _cat/fielddata?v
+```
+
+To limit the information to a specific field, add the field name after your query.
+
+```
+GET _cat/fielddata/<fields>?v
+```
+
+## Health
+
+Lists the status of the cluster, how long the cluster has been up, the number of nodes, and other useful information that helps you analyze the health of your cluster.
+
+```
+GET _cat/health?v
+```
+
+## Indices
+
+Lists information related to indices⁠—how much disk space they are using, how many shards they have, their health status, and so on.
+
+```
+GET _cat/indices?v
+```
+
+To limit the information to a specific index, add the index name after your query.
+
+```
+GET _cat/indices/<index>?v
+```
+
+## Master
+
+Lists information that helps identify the elected master node.
+
+```
+GET _cat/master?v
+```
+
+## Node attributes
+
+Lists the attributes of custom nodes.
+
+```
+GET _cat/nodeattrs?v
+```
+
+## Nodes
+
+Lists node-level information, including node roles and load metrics.
+
+A few important node metrics are `pid`, `name`, `master`, `ip`, `port`, `version`, `build`, `jdk`, along with `disk`, `heap`, `ram`, and `file_desc`.
+
+```
+GET _cat/nodes?v
+```
+
+## Pending tasks
+
+Lists the progress of all pending tasks, including task priority and time in queue.
+
+```
+GET _cat/pending_tasks?v
+```
+
+## Plugins
+
+Lists the names, components, and versions of the installed plugins.
+
+```
+GET _cat/plugins?v
+```
+
+## Recovery
+
+Lists all completed and ongoing index and shard recoveries.
+
+```
+GET _cat/recovery?v
+```
+
+To see only the recoveries of a specific index, add the index name after your query.
+
+```
+GET _cat/recovery/<index>?v
+```
+
+## Repositories
+
+Lists all snapshot repositories and their types.
+
+```
+GET _cat/repositories?v
+```
+
+## Segments
+
+Lists Lucene segment-level information for each index.
+
+```
+GET _cat/segments?v
+```
+
+To see only the information about segments of a specific index, add the index name after your query.
+
+```
+GET _cat/segments/<index>?v
+```
+
+## Shards
+
+Lists the state of all primary and replica shards and how they are distributed.
+
+```
+GET _cat/shards?v
+```
+
+To see only the information about shards of a specific index, add the index name after your query.
+
+```
+GET _cat/shards/<index>?v
+```
+
+## Snapshots
+
+Lists all snapshots for a repository.
+
+```
+GET _cat/snapshots/<repository>?v
+```
+
+## Tasks
+
+Lists the progress of all tasks currently running on your cluster.
+
+```
+GET _cat/tasks?v
+```
+
+## Templates
+
+Lists the names, patterns, order numbers, and version numbers of index templates.
+
+```
+GET _cat/templates?v
+```
+
+## Thread pool
+
+Lists the active, queued, and rejected threads of different thread pools on each node.
+
+```
+GET _cat/thread_pool?v
+```
+
+To limit the information to a specific thread pool, add the thread pool name after your query.
+
+```
+GET _cat/thread_pool/<thread_pool>?v
+```
@@ -8,10 +8,10 @@ nav_order: 5

 Most OpenSearch configuration can take place in the cluster settings API. Certain operations require you to modify `opensearch.yml` and restart the cluster.

-Whenever possible, use the cluster settings API instead; `opensearch.yml` is local to each node, whereas the API applies the setting to all nodes in the cluster. Certain settings, however, require `opensearch.yml`. In general, these settings relate to networking, cluster formation, and the local file system. To learn more, see [Cluster formation]({{site.url}}{{site.baseurl}}/opensearch/cluster/).
+Whenever possible, use the cluster settings API instead; `opensearch.yml` is local to each node, whereas the API applies the setting to all nodes in the cluster.


-## Update cluster settings using the API
+## Cluster settings API

 The first step in changing a setting is to view the current settings:

@@ -37,7 +37,7 @@ If you specify the same setting in multiple places, OpenSearch uses the followin
 To change a setting, just specify the new one as either persistent or transient. This example shows the flat settings form:

 ```json
-PUT _cluster/settings
+PUT /_cluster/settings
 {
  "persistent" : {
    "action.auto_create_index" : false
@@ -48,7 +48,7 @@ PUT _cluster/settings
 You can also use the expanded form, which lets you copy and paste from the GET response and change existing values:

 ```json
-PUT _cluster/settings
+PUT /_cluster/settings
 {
  "persistent": {
    "action": {
@@ -63,6 +63,6 @@ PUT _cluster/settings

 ## Configuration file

-You can find `opensearch.yml` in `/usr/share/opensearch/config/opensearch.yml` (Docker) or `/etc/opensearch/opensearch.yml` (most Linux distributions) on each node.
+You can find `opensearch.yml` in `/usr/share/opensearch/config/opensearch.yml` (Docker) or `/etc/opensearch/opensearch.yml` (RPM and DEB) on each node.

 The demo configuration includes a number of settings for the security plugin that you should modify before using OpenSearch for a production workload. To learn more, see [Security]({{site.url}}{{site.baseurl}}/security-plugin/).
@@ -93,7 +93,8 @@ services:
    expose:
      - "5601"
    environment:
-      OPENSEARCH_HOSTS: '["https://opensearch-node1:9200","https://opensearch-node2:9200"]' # must be a string with no spaces when specified as an environment variable
+      OPENSEARCH_URL: https://opensearch-node1:9200
+      OPENSEARCH_HOSTS: https://opensearch-node1:9200
    volumes:
      - ./custom-opensearch_dashboards.yml:/usr/share/opensearch-dashboards/config/opensearch_dashboards.yml
    networks:
@@ -138,7 +138,7 @@ services:
    expose:
      - "5601"
    environment:
-      OPENSEARCH_HOSTS: '["https://opensearch-node1:9200","https://opensearch-node2:9200"]' # must be a string with no spaces when specified as an environment variable
+      OPENSEARCH_HOSTS: https://opensearch-node1:9200
    networks:
      - opensearch-net

@@ -9,7 +9,7 @@ nav_order: 60
 The OpenSearch logs include valuable information for monitoring cluster operations and troubleshooting issues. The location of the logs differs based on the installation type:

 - On Docker, OpenSearch writes most logs to the console and stores the remainder in `opensearch/logs/`. The tarball installation also uses `opensearch/logs/`.
- On most Linux installations, OpenSearch writes logs to `/var/log/opensearch/`.
+- On the RPM and Debian installations, OpenSearch writes logs to `/var/log/opensearch/`.

 Logs are available as `.log` (plain text) and `.json` files.

@@ -6,7 +6,7 @@ nav_order: 96

 # Popular APIs

-This page contains sample requests for popular OpenSearch operations.
+This page contains sample requests for popular OpenSearch APIs.


 ---
@@ -80,7 +80,7 @@ POST _bulk
 ## List all indices

 ```
-GET _cat/indices?v&expand_wildcards=all
+GET _cat/indices?v
 ```


@@ -183,7 +183,7 @@ PUT _snapshot/my-repository/my-snapshot
 ```json
 POST _snapshot/my-repository/my-snapshot/_restore
 {
-  "indices": "-.opendistro_security",
+  "indices": "-.opensearch_security",
  "include_global_state": false
 }
 ```
@@ -2,7 +2,7 @@
 layout: default
 title: Bulk
 parent: REST API reference
-nav_order: 5
+nav_order: 15
 ---

 # Bulk
@@ -1,61 +0,0 @@
---
-layout: default
-title: cat aliases
-parent: CAT
-grand_parent: REST API reference
-nav_order: 1
-has_children: false
---
-
-# cat aliases
-
-The cat aliases operation lists the mapping of aliases to indices, plus routing and filtering information.
-
-## Example
-
-```json
-GET _cat/aliases?v
-```
-
-To limit the information to a specific alias, add the alias name after your query:
-
-```json
-GET _cat/aliases/<alias>?v
-```
-
-If you want to get information for more than one alias, separate the alias names with commas:
-
-```json
-GET _cat/aliases/alias1,alias2,alias3
-```
-
-## Path and HTTP methods
-
-```
-GET _cat/aliases/<alias>
-GET _cat/aliases
-```
-
-
-## URL parameters
-
-All cat aliases URL parameters are optional.
-
-In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index#common-url-parameters), you can specify the following parameters:
-
-Parameter | Type | Description
-:--- | :--- | :---
-local | Boolean | Whether to return information from the local node only instead of from the master node. Default is false.
-expand_wildcards | Enum | Expands wildcard expressions to concrete indices. Combine multiple values with commas. Supported values are `all`, `open`, `closed`, `hidden`, and `none`. Default is `open`.
-
-## Response
-
-The following response shows that `alias1` refers to a `movies` index and has a configured filter:
-
-```json
-alias   | index     | filter  | routing.index | routing.search  | is_write_index
-alias1  | movies    |   *     |      -        |       -         |      -
-.kibana | .kibana_1 |   -     |      -        |       -         |      -
-```
-
-To learn more about index aliases, see [Index aliases]({{site.url}}{{site.baseurl}}/opensearch/index-alias).
@@ -1,61 +0,0 @@
---
-layout: default
-title: cat allocation
-parent: CAT
-grand_parent: REST API reference
-nav_order: 5
-has_children: false
---
-
-# cat allocation
-
-The cat allocation operation lists the allocation of disk space for indices and the number of shards on each node.
-
-## Example
-
-```json
-GET _cat/allocation?v
-```
-
-To limit the information to a specific node, add the node name after your query:
-
-```json
-GET _cat/allocation/<node_name>
-```
-
-If you want to get information for more than one node, separate the node names with commas:
-
-```json
-GET _cat/aliases/node_name_1,node_name_2,node_name_3
-```
-
-## Path and HTTP methods
-
-```
-GET _cat/allocation?v
-GET _cat/allocation/<node_name>
-```
-
-## URL parameters
-
-All cat allocation URL parameters are optional.
-
-In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index#common-url-parameters), you can specify the following parameters:
-
-Parameter | Type | Description
-:--- | :--- | :---
-bytes | Byte size | Specify the units for byte size. For example, `7kb` or `6gb`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).
-local | Boolean | Whether to return information from the local node only instead of from the master node. Default is false.
-master_timeout | Time | The amount of time to wait for a connection to the master node. Default is 30 seconds.
-
-
-
-## Response
-
-The following response shows that 8 shards are allocated to each the two nodes available:
-
-```json
-shards | disk.indices | disk.used | disk.avail | disk.total | disk.percent host | ip          | node
-  8    |   989.4kb    |   25.9gb  |   32.4gb   |   58.4gb   |   44 172.18.0.4   | 172.18.0.4  | odfe-node1
-  8    |   962.4kb    |   25.9gb  |   32.4gb   |   58.4gb   |   44 172.18.0.3   | 172.18.0.3  | odfe-node2
-```
@@ -1,51 +0,0 @@
---
-layout: default
-title: cat count
-parent: CAT
-grand_parent: REST API reference
-nav_order: 10
-has_children: false
---
-
-# cat count
-
-The cat count operation lists the number of documents in your cluster.
-
-## Example
-
-```json
-GET _cat/count?v
-```
-
-To see the number of documents in a specific index or alias, add the index or alias name after your query:
-
-```json
-GET _cat/count/<index_or_alias>?v
-```
-
-If you want to get information for more than one index or alias, separate the index or alias names with commas:
-
-```json
-GET _cat/aliases/index_or_alias_1,index_or_alias_2,index_or_alias_3
-```
-
-## Path and HTTP methods
-
-```
-GET _cat/count?v
-GET _cat/count/<index>?v
-```
-
-## URL parameters
-
-All cat count URL parameters are optional. You can specify any of the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index#common-url-parameters).
-
-
-## Response
-
-The following response shows the overall document count as 1625:
-
-```json
-epoch      | timestamp | count
-1624237738 | 01:08:58  | 1625
-```
@@ -1,57 +0,0 @@
---
-layout: default
-title: cat field data
-parent: CAT
-grand_parent: REST API reference
-nav_order: 15
-has_children: false
---
-
-# cat fielddata
-
-The cat fielddata operation lists the memory size used by each field per node.
-
-## Example
-
-```json
-GET _cat/fielddata?v
-```
-
-To limit the information to a specific field, add the field name after your query:
-
-```json
-GET _cat/fielddata/<field_name>?v
-```
-
-If you want to get information for more than one field, separate the field names with commas:
-
-```json
-GET _cat/aliases/field_name_1,field_name_2,field_name_3
-```
-
-## Path and HTTP methods
-
-```
-GET _cat/fielddata?v
-GET _cat/fielddata/<field_name>?v
-```
-
-## URL parameters
-
-All cat fielddata URL parameters are optional.
-
-In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index#common-url-parameters), you can specify the following parameter:
-
-Parameter | Type | Description
-:--- | :--- | :---
-bytes | Byte size | Specify the units for byte size. For example, `7kb` or `6gb`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).
-
-## Response
-
-The following response shows the memory size for all fields as 284 bytes:
-
-```json
-id                     host       ip         node       field size
-1vo54NuxSxOrbPEYdkSF0w 172.18.0.4 172.18.0.4 odfe-node1 _id   284b
-ZaIkkUd4TEiAihqJGkp5CA 172.18.0.3 172.18.0.3 odfe-node2 _id   284b
-```
@@ -1,42 +0,0 @@
---
-layout: default
-title: cat health
-parent: CAT
-grand_parent: REST API reference
-nav_order: 20
-has_children: false
---
-
-# cat health
-
-The cat health operation lists the status of the cluster, how long the cluster has been up, the number of nodes, and other useful information that helps you analyze the health of your cluster.
-
-## Example
-
-```json
-GET _cat/health?v
-```
-
-## Path and HTTP methods
-
-```
-GET _cat/health?v
-```
-
-## URL parameters
-
-All cat health URL parameters are optional.
-
-Parameter | Type | Description
-:--- | :--- | :---
-time | Time | Specify the units for time. For example, `5d` or `7h`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).
-ts | Boolean | If true, returns HH:MM:SS and Unix epoch timestamps. Default is true.
-
-## Response
-
-```json
-GET _cat/health?v&time=5d
-
-epoch | timestamp | cluster | status | node.total | node.data | shards | pri | relo | init | unassign | pending_tasks | max_task_wait_time | active_shards_percent
-1624248112 | 04:01:52 | odfe-cluster | green | 2 | 2 | 16 | 8 | 0 | 0 | 0 | 0 | - | 100.0%
-```
@@ -1,61 +0,0 @@
---
-layout: default
-title: cat indices
-parent: CAT
-grand_parent: REST API reference
-nav_order: 25
-has_children: false
---
-
-# cat indices
-
-The cat indices operation lists information related to indices⁠—how much disk space they are using, how many shards they have, their health status, and so on.
-
-## Example
-
-```
-GET _cat/indices?v
-```
-
-To limit the information to a specific index, add the index name after your query.
-
-```
-GET _cat/indices/<index>?v
-```
-
-If you want to get information for more than one index, separate the indices with commas:
-
-```json
-GET _cat/aliases/index1,index2,index3
-```
-
-## Path and HTTP methods
-
-```
-GET _cat/indices/<index>
-GET _cat/indices
-```
-
-## URL parameters
-
-All cat indices URL parameters are optional.
-
-In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index#common-url-parameters), you can specify the following parameters:
-
-Parameter | Type | Description
-:--- | :--- | :---
-bytes | Byte size | Specify the units for byte size. For example, `7kb` or `6gb`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).
-health | String | Limit indices based on their health status. Supported values are `green`, `yellow`, and `red`.
-include_unloaded_segments | Boolean | Whether to include information from segments not loaded into memory. Default is false.
-master_timeout | Time | The amount of time to wait for a connection to the master node. Default is 30 seconds.
-pri | Boolean | Whether to return information only from the primary shards. Default is false.
-time | Time | Specify the units for time. For example, `5d` or `7h`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).
-expand_wildcards | Enum | Expands wildcard expressions to concrete indices. Combine multiple values with commas. Supported values are `all`, `open`, `closed`, `hidden`, and `none`. Default is `open`.
-
-
-## Response
-
-```json
-health | status | index | uuid | pri | rep | docs.count | docs.deleted | store.size | pri.store.size
-green  | open | movies | UZbpfERBQ1-3GSH2bnM3sg | 1 | 1 | 1 | 0 | 7.7kb | 3.8kb
-```
@@ -1,42 +0,0 @@
---
-layout: default
-title: cat master
-parent: CAT
-grand_parent: REST API reference
-nav_order: 30
-has_children: false
---
-
-# cat master
-
-The cat master operation lists information that helps identify the elected master node.
-
-## Example
-
-```
-GET _cat/master?v
-```
-
-## Path and HTTP methods
-
-```
-GET _cat/master
-```
-
-## URL parameters
-
-All cat master URL parameters are optional.
-
-In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index#common-url-parameters), you can specify the following parameters:
-
-Parameter | Type | Description
-:--- | :--- | :---
-master_timeout | Time | The amount of time to wait for a connection to the master node. Default is 30 seconds.
-
-
-## Response
-
-```json
-id                     |   host     |     ip     |   node
-ZaIkkUd4TEiAihqJGkp5CA | 172.18.0.3 | 172.18.0.3 | odfe-node2
-```
@@ -1,43 +0,0 @@
---
-layout: default
-title: cat nodeattrs
-parent: CAT
-grand_parent: REST API reference
-nav_order: 35
-has_children: false
---
-
-# cat nodeattrs
-
-The cat nodeattrs operation lists the attributes of custom nodes.
-
-## Example
-
-```
-GET _cat/nodeattrs?v
-```
-
-## Path and HTTP methods
-
-```
-GET _cat/nodeattrs
-```
-
-## URL parameters
-
-All cat nodeattrs URL parameters are optional.
-
-In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index#common-url-parameters), you can specify the following parameters:
-
-Parameter | Type | Description
-:--- | :--- | :---
-local | Boolean | Whether to return information from the local node only instead of from the master node. Default is false.
-master_timeout | Time | The amount of time to wait for a connection to the master node. Default is 30 seconds.
-
-
-## Response
-
-```json
-node | host | ip | attr | value
-odfe-node2 | 172.18.0.3 | 172.18.0.3 | testattr | test
-```
@@ -1,50 +0,0 @@
---
-layout: default
-title: cat nodes
-parent: CAT
-grand_parent: REST API reference
-nav_order: 40
-has_children: false
---
-
-# cat nodes
-
-The cat nodes operation lists node-level information, including node roles and load metrics.
-
-A few important node metrics are `pid`, `name`, `master`, `ip`, `port`, `version`, `build`, `jdk`, along with `disk`, `heap`, `ram`, and `file_desc`.
-
-## Example
-
-```
-GET _cat/nodes?v
-```
-
-## Path and HTTP methods
-
-```
-GET _cat/nodes
-```
-
-## URL parameters
-
-All cat nodes URL parameters are optional.
-
-In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index#common-url-parameters), you can specify the following parameters:
-
-Parameter | Type | Description
-:--- | :--- | :---
-bytes | Byte size | Specify the units for byte size. For example, `7kb` or `6gb`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).
-full_id | Boolean | If true, return the full node ID. If false, return the shortened node ID. Defaults to false.
-local | Boolean | Whether to return information from the local node only instead of from the master node. Default is false.
-master_timeout | Time | The amount of time to wait for a connection to the master node. Default is 30 seconds.
-time | Time | Specify the units for time. For example, `5d` or `7h`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).
-include_unloaded_segments | Boolean | Whether to include information from segments not loaded into memory. Default is false.
-
-
-## Response
-
-```json
-ip         | heap.percent | ram.percent | cpu load_1m | load_5m | load_15m | node.role | master | name
-172.18.0.3 |     31       |     97      |       3     |  0.03   |   0.10   |  0.14 dimr |  *    |  odfe-node2
-172.18.0.4 |     45       |     97      |       3     |  0.19   |   0.14   |  0.15 dimr |  -    |  odfe-node1
-```
@@ -1,44 +0,0 @@
---
-layout: default
-title: cat pending tasks
-parent: CAT
-grand_parent: REST API reference
-nav_order: 45
-has_children: false
---
-
-# cat pending tasks
-
-The cat pending tasks operation lists the progress of all pending tasks, including task priority and time in queue.
-
-## Example
-
-```
-GET _cat/pending_tasks?v
-```
-
-## Path and HTTP methods
-
-```
-GET _cat/pending_tasks
-```
-
-## URL parameters
-
-All cat nodes URL parameters are optional.
-
-In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index#common-url-parameters), you can specify the following parameters:
-
-Parameter | Type | Description
-:--- | :--- | :---
-local | Boolean | Whether to return information from the local node only instead of from the master node. Default is false.
-master_timeout | Time | The amount of time to wait for a connection to the master node. Default is 30 seconds.
-time | Time | Specify the units for time. For example, `5d` or `7h`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).
-
-
-## Response
-
-```json
-insertOrder | timeInQueue | priority | source
-  1786      |    1.8s     |  URGENT  | shard-started
-```
@@ -1,62 +0,0 @@
---
-layout: default
-title: cat plugins
-parent: CAT
-grand_parent: REST API reference
-nav_order: 50
-has_children: false
---
-
-# cat plugins
-
-The cat plugins operation lists the names, components, and versions of the installed plugins.
-
-## Example
-
-```
-GET _cat/plugins?v
-```
-
-## Path and HTTP methods
-
-```
-GET _cat/plugins
-```
-
-## URL parameters
-
-All cat plugins URL parameters are optional.
-
-In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index#common-url-parameters), you can specify the following parameters:
-
-Parameter | Type | Description
-:--- | :--- | :---
-local | Boolean | Whether to return information from the local node only instead of from the master node. Default is false.
-master_timeout | Time | The amount of time to wait for a connection to the master node. Default is 30 seconds.
-
-
-## Response
-
-```json
-name       component                       version
-odfe-node2 opendistro-alerting             1.13.1.0
-odfe-node2 opendistro-anomaly-detection    1.13.0.0
-odfe-node2 opendistro-asynchronous-search  1.13.0.1
-odfe-node2 opendistro-index-management     1.13.2.0
-odfe-node2 opendistro-job-scheduler        1.13.0.0
-odfe-node2 opendistro-knn                  1.13.0.0
-odfe-node2 opendistro-performance-analyzer 1.13.0.0
-odfe-node2 opendistro-reports-scheduler    1.13.0.0
-odfe-node2 opendistro-sql                  1.13.2.0
-odfe-node2 opendistro_security             1.13.1.0
-odfe-node1 opendistro-alerting             1.13.1.0
-odfe-node1 opendistro-anomaly-detection    1.13.0.0
-odfe-node1 opendistro-asynchronous-search  1.13.0.1
-odfe-node1 opendistro-index-management     1.13.2.0
-odfe-node1 opendistro-job-scheduler        1.13.0.0
-odfe-node1 opendistro-knn                  1.13.0.0
-odfe-node1 opendistro-performance-analyzer 1.13.0.0
-odfe-node1 opendistro-reports-scheduler    1.13.0.0
-odfe-node1 opendistro-sql                  1.13.2.0
-odfe-node1 opendistro_security             1.13.1.0
-```
@@ -1,57 +0,0 @@
---
-layout: default
-title: cat recovery
-parent: CAT
-grand_parent: REST API reference
-nav_order: 50
-has_children: false
---
-
-# cat recovery
-
-The cat recovery operation lists all completed and ongoing index and shard recoveries.
-
-## Example
-
-```
-GET _cat/recovery?v
-```
-
-To see only the recoveries of a specific index, add the index name after your query.
-
-```
-GET _cat/recovery/<index>?v
-```
-
-If you want to get information for more than one index, separate the indices with commas:
-
-```json
-GET _cat/aliases/index1,index2,index3
-```
-
-## Path and HTTP methods
-
-```
-GET _cat/recovery
-```
-
-## URL parameters
-
-All cat recovery URL parameters are optional.
-
-In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index#common-url-parameters), you can specify the following parameters:
-
-Parameter | Type | Description
-:--- | :--- | :---
-active_only | Boolean | Whether to only include ongoing shard recoveries. Default is false.
-bytes | Byte size | Specify the units for byte size. For example, `7kb` or `6gb`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).
-detailed | Boolean | Whether to include detailed information about shard recoveries. Default is false.
-time | Time | Specify the units for time. For example, `5d` or `7h`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).
-
-## Response
-
-```json
-index | shard | time | type | stage | source_host | source_node | target_host | target_node | repository | snapshot | files | files_recovered | files_percent | files_total | bytes | bytes_recovered | bytes_percent | bytes_total | translog_ops | translog_ops_recovered | translog_ops_percent
-movies | 0 | 117ms | empty_store | done | n/a | n/a | 172.18.0.4 | odfe-node1 | n/a | n/a | 0 | 0 | 0.0% | 0 | 0 | 0 | 0.0% | 0 | 0 | 0 | 100.0%
-movies | 0 | 382ms | peer | done | 172.18.0.4 | odfe-node1 | 172.18.0.3 | odfe-node2 | n/a | n/a | 1 | 1 |  100.0% | 1 | 208 | 208 | 100.0% | 208 | 1 | 1 | 100.0%
-```
@@ -1,44 +0,0 @@
---
-layout: default
-title: cat repositories
-parent: CAT
-grand_parent: REST API reference
-nav_order: 55
-has_children: false
---
-
-# cat repositories
-
-The cat repositories operation lists all completed and ongoing index and shard recoveries.
-
-## Example
-
-```
-GET _cat/repositories?v
-```
-
-## Path and HTTP methods
-
-```
-GET _cat/repositories
-```
-
-## URL parameters
-
-All cat repositories URL parameters are optional.
-
-In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index#common-url-parameters), you can specify the following parameters:
-
-Parameter | Type | Description
-:--- | :--- | :---
-local | Boolean | Whether to return information from the local node only instead of from the master node. Default is false.
-master_timeout | Time | The amount of time to wait for a connection to the master node. Default is 30 seconds.
-
-
-## Response
-
-```json
-id    type
-repo1   fs
-repo2   s3
-```
@@ -1,55 +0,0 @@
---
-layout: default
-title: cat segments
-parent: CAT
-grand_parent: REST API reference
-nav_order: 55
-has_children: false
---
-
-# cat segments
-
-The cat segments operation lists Lucene segment-level information for each index.
-
-## Example
-
-```
-GET _cat/segments?v
-```
-
-To see only the information about segments of a specific index, add the index name after your query.
-
-```
-GET _cat/segments/<index>?v
-```
-
-If you want to get information for more than one index, separate the indices with commas:
-
-```
-GET _cat/segments/index1,index2,index3
-```
-
-## Path and HTTP methods
-
-```
-GET _cat/segments
-```
-
-## URL parameters
-
-All cat segments URL parameters are optional.
-
-In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index#common-url-parameters), you can specify the following parameter:
-
-Parameter | Type | Description
-:--- | :--- | :---
-bytes | Byte size | Specify the units for byte size. For example, `7kb` or `6gb`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/)..
-
-
-## Response
-
-```json
-index | shard | prirep | ip | segment | generation | docs.count | docs.deleted | size | size.memory | committed | searchable | version | compound
-movies | 0 | p | 172.18.0.4 | _0 | 0 | 1 | 0 | 3.5kb | 1364 | true | true | 8.7.0 | true
-movies | 0 | r | 172.18.0.3 | _0 | 0 | 1 | 0 | 3.5kb | 1364 | true | true | 8.7.0 | true
-```
@@ -1,58 +0,0 @@
---
-layout: default
-title: cat shards
-parent: CAT
-grand_parent: REST API reference
-nav_order: 60
-has_children: false
---
-
-# cat shards
-
-The cat shards operation lists the state of all primary and replica shards and how they are distributed.
-
-## Example
-
-```
-GET _cat/shards?v
-```
-
-To see only the information about shards of a specific index, add the index name after your query.
-
-```
-GET _cat/shards/<index>?v
-```
-
-If you want to get information for more than one index, separate the indices with commas:
-
-```
-GET _cat/shards/index1,index2,index3
-```
-
-## Path and HTTP methods
-
-```
-GET _cat/shards
-```
-
-## URL parameters
-
-All cat shards URL parameters are optional.
-
-In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index#common-url-parameters), you can specify the following parameter:
-
-Parameter | Type | Description
-:--- | :--- | :---
-bytes | Byte size | Specify the units for byte size. For example, `7kb` or `6gb`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).
-local | Boolean | Whether to return information from the local node only instead of from the master node. Default is false.
-master_timeout | Time | The amount of time to wait for a connection to the master node. Default is 30 seconds.
-time | Time | Specify the units for time. For example, `5d` or `7h`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).
-
-
-## Response
-
-```json
-index | shard | prirep | state   | docs | store | ip |       | node
-plugins | 0   |   p    | STARTED |   0  |  208b | 172.18.0.4 | odfe-node1
-plugins | 0   |   r    | STARTED |   0  |  208b | 172.18.0.3 |  odfe-node2          
-```
@@ -1,44 +0,0 @@
---
-layout: default
-title: cat snapshots
-parent: CAT
-grand_parent: REST API reference
-nav_order: 65
-has_children: false
---
-
-# cat snapshots
-
-The cat snapshots operation lists all snapshots for a repository.
-
-## Example
-
-```
-GET _cat/snapshots?v
-```
-
-## Path and HTTP methods
-
-```
-GET _cat/snapshots
-```
-
-## URL parameters
-
-All cat snapshots URL parameters are optional.
-
-In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index#common-url-parameters), you can specify the following parameter:
-
-Parameter | Type | Description
-:--- | :--- | :---
-master_timeout | Time | The amount of time to wait for a connection to the master node. Default is 30 seconds.
-time | Time | Specify the units for time. For example, `5d` or `7h`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).
-
-
-## Response
-
-```json
-index | shard | prirep | state   | docs | store | ip |       | node
-plugins | 0   |   p    | STARTED |   0  |  208b | 172.18.0.4 | odfe-node1
-plugins | 0   |   r    | STARTED |   0  |  208b | 172.18.0.3 |  odfe-node2          
-```
@@ -1,45 +0,0 @@
---
-layout: default
-title: cat tasks
-parent: CAT
-grand_parent: REST API reference
-nav_order: 70
-has_children: false
---
-
-# cat tasks
-
-The cat tasks operation lists the progress of all tasks currently running on your cluster.
-
-## Example
-
-```
-GET _cat/tasks?v
-```
-
-## Path and HTTP methods
-
-```
-GET _cat/tasks
-```
-
-## URL parameters
-
-All cat tasks URL parameters are optional.
-
-In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index#common-url-parameters), you can specify the following parameter:
-
-Parameter | Type | Description
-:--- | :--- | :---
-nodes | List | A comma-separated list of node IDs or names to limit the returned information. Use `_local` to return information from the node you're connecting to, specify the node name to get information from specific nodes, or keep the parameter empty to get information from all nodes.
-detailed | Boolean | Returns detailed task information. (Default: false)
-parent_task_id | String | Returns tasks with a specified parent task ID (node_id:task_number). Keep empty or set to -1 to return all.
-time | Time | Specify the units for time. For example, `5d` or `7h`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).
-
-
-## Response
-
-```json
-action | task_id | parent_task_id | type | start_time | timestamp | running_time | ip | node
-cluster:monitor/tasks/lists | 1vo54NuxSxOrbPEYdkSF0w:168062 | - | transport | 1624337809471 | 04:56:49 | 489.5ms | 172.18.0.4 | odfe-node1     
-```
@@ -1,51 +0,0 @@
---
-layout: default
-title: cat templates
-parent: CAT
-grand_parent: REST API reference
-nav_order: 70
-has_children: false
---
-
-# cat templates
-
-The cat templates operation lists the names, patterns, order numbers, and version numbers of index templates.
-
-## Example
-
-```
-GET _cat/templates?v
-```
-
-If you want to get information for more than one template, separate the template names with commas:
-
-```
-GET _cat/shards/template_name_1,template_name_2,template_name_3
-```
-
-## Path and HTTP methods
-
-```
-GET _cat/templates
-```
-
-## URL parameters
-
-All cat templates URL parameters are optional.
-
-In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index#common-url-parameters), you can specify the following parameter:
-
-Parameter | Type | Description
-:--- | :--- | :---
-local | Boolean | Whether to return information from the local node only instead of from the master node. Default is false.
-master_timeout | Time | The amount of time to wait for a connection to the master node. Default is 30 seconds.
-
-
-## Response
-
-```
-name | index_patterns order version composed_of
-tenant_template | [kibana*] | 0  |    
-```
-
-To learn more about index templates, see [Index templates]({{site.url}}{{site.baseurl}}/opensearch/index-templates).
@@ -1,51 +0,0 @@
---
-layout: default
-title: cat thread pool
-parent: CAT
-grand_parent: REST API reference
-nav_order: 75
-has_children: false
---
-
-# cat thread pool
-
-The cat thread pool operation lists the active, queued, and rejected threads of different thread pools on each node.
-
-## Example
-
-```
-GET _cat/thread_pool?v
-```
-
-If you want to get information for more than one thread pool, separate the thread pool names with commas:
-
-```
-GET _cat/v/thread_pool_name_1,thread_pool_name_2,thread_pool_name_3
-```
-
-## Path and HTTP methods
-
-```
-GET _cat/thread_pool
-```
-
-## URL parameters
-
-All cat thread pool URL parameters are optional.
-
-In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index#common-url-parameters), you can specify the following parameter:
-
-Parameter | Type | Description
-:--- | :--- | :---
-local | Boolean | Whether to return information from the local node only instead of from the master node. Default is false.
-master_timeout | Time | The amount of time to wait for a connection to the master node. Default is 30 seconds.
-
-
-## Response
-
-```json
-node_name  name                      active queue rejected
-odfe-node2 ad-batch-task-threadpool    0     0        0
-odfe-node2 ad-threadpool               0     0        0
-odfe-node2 analyze                     0     0        0s 
-```
@@ -1,58 +0,0 @@
---
-layout: default
-title: CAT
-parent: REST API reference
-nav_order: 100
-has_children: true
-redirect_from:
-  - /opensearch/catapis/
---
-
-# cat API
-
-You can get essential statistics about your cluster in an easy-to-understand, tabular format using the compact and aligned text (CAT) API. The cat API is a human-readable interface that returns plain text instead of traditional JSON.
-
-Using the cat API, you can answer questions like which node is the elected master, what state is the cluster in, how many documents are in each index, and so on.
-
-## Example
-
-To see the available operations in the cat API, use the following command:
-
-```
-GET _cat
-```
-
-## Common URL parameters
-
-You can use the following string parameters with your query.
-
-Parameter | Description
-:--- | :--- |
-`?v` |  Makes the output more verbose by adding headers to the columns. It also adds some formatting to help align each of the columns together. All examples in this section include the `v` parameter.
-`?help` | Lists the default and other available headers for a given operation.
-`?h`  |  Limits the output to specific headers.
-`?format` |  Outputs the result in JSON, YAML, or CBOR formats.
-`?sort` | Sorts the output by the specified columns.
-
-To see what each column represents, use the `?v` parameter:
-
-```
-GET _cat/<operation_name>?v
-```
-
-To see all the available headers, use the `?help` parameter:
-
-```
-GET _cat/<operation_name>?help
-```
-
-To limit the output to a subset of headers, use the `?h` parameter:
-
-```
-GET _cat/<operation_name>?h=<header_name_1>,<header_name_2>&v
-```
-
-Typically, for any operation you can find out what headers are available using the `?help` parameter, and then use the `?h` parameter to limit the output to only the headers that you care about.
-
-If you use the security plugin, make sure you have the appropriate permissions.
-{: .note }
@@ -2,7 +2,7 @@
 layout: default
 title: Cluster allocation explain
 parent: REST API reference
-nav_order: 10
+nav_order: 30
 ---

 # Cluster allocation explain
@@ -15,7 +15,7 @@ If you add some options, you can instead get information on a specific shard, in
 ## Example

 ```json
-GET _cluster/allocation/explain?include_yes_decisions=true
+GET /_cluster/allocation/explain?include_yes_decisions=true
 {
  "index": "movies",
  "shard": 0,
@@ -2,7 +2,8 @@
 layout: default
 title: Cluster health
 parent: REST API reference
-nav_order: 15
+grand_parent: OpenSearch
+nav_order: 45
 ---

 # Cluster health
@@ -16,7 +17,7 @@ To get the status of a specific index, provide the index name.
 This request waits 50 seconds for the cluster to reach the yellow status or better:

 ```
-GET _cluster/health?wait_for_status=yellow&timeout=50s
+GET /_cluster/health?wait_for_status=yellow&timeout=50s
 ```

 If the cluster health becomes yellow or green before 50 seconds elapse, it returns a response immediately. Otherwise it returns a response as soon as it exceeds the timeout.
@@ -24,8 +25,8 @@ If the cluster health becomes yellow or green before 50 seconds elapse, it retur
 ## Path and HTTP methods

 ```
-GET _cluster/health
-GET _cluster/health/<index>
+GET /_cluster/health
+GET /_cluster/health/<index>
 ```

 ## URL parameters
@@ -34,18 +35,18 @@ All cluster health parameters are optional.

 Parameter | Type | Description
 :--- | :--- | :---
-expand_wildcards | Enum | Expands wildcard expressions to concrete indices. Combine multiple values with commas. Supported values are `all`, `open`, `closed`, `hidden`, and `none`. Default is `open`.
-level | Enum | The level of detail for returned health information. Supported values are `cluster`, `indices`, and `shards`. Default is `cluster`.
-local | Boolean | Whether to return information from the local node only instead of from the master node. Default is false.
-master_timeout | Time | The amount of time to wait for a connection to the master node. Default is 30 seconds.
-timeout | Time | The amount of time to wait for a response. If the timeout expires, the request fails. Default is 30 seconds.
-wait_for_active_shards | String | Wait until the specified number of shards is active before returning a response. `all` for all shards. Default is `0`.
-wait_for_events | Enum | Wait until all currently queued events with the given priority are processed. Supported values are `immediate`, `urgent`, `high`, `normal`, `low`, and `languid`.
-wait_for_no_relocating_shards | Boolean | Whether to wait until there are no relocating shards in the cluster. Default is false.
-wait_for_no_initializing_shards | Boolean | Whether to wait until there are no initializing shards in the cluster. Default is false.
-wait_for_status | Enum | Wait until the cluster is in a specific state or better. Supported values are `green`, `yellow`, and `red`.
+expand_wildcards | enum | Expands wildcard expressions to concrete indices. Combine multiple values with commas. Supported values are `all`, `open`, `closed`, `hidden`, and `none`. Default is `open`. 
+level | enum | The level of detail for returned health information. Supported values are `cluster`, `indices`, and `shards`. Default is `cluster`.
+local | boolean | Whether to return information from the local node only instead of from the master node. Default is false.
+master_timeout | time | The amount of time to wait for a connection to the master node. Default is 30 seconds.
+timeout | time | The amount of time to wait for a response. If the timeout expires, the request fails. Default is 30 seconds.
+wait_for_active_shards | string | Wait until the specified number of shards is active before returning a response. `all` for all shards. Default is `0`. 
+wait_for_events | enum | Wait until all currently queued events with the given priority are processed. Supported values are `immediate`, `urgent`, `high`, `normal`, `low`, and `languid`.
+wait_for_no_relocating_shards | boolean | Whether to wait until there are no relocating shards in the cluster. Default is false.
+wait_for_no_initializing_shards | boolean | Whether to wait until there are no initializing shards in the cluster. Default is false.
+wait_for_status | enum | Wait until the cluster is in a specific state or better. Supported values are `green`, `yellow`, and `red`.

-<!-- wait_for_nodes | string | Wait until the specified number of nodes is available. Also supports operators <=, >=, <, and >
+<!-- wait_for_nodes | string | Wait until the specified number of nodes is available. Also supports operators <=, >=, <, and > 
 # Not working properly when tested -->

 ## Response
@@ -68,4 +69,4 @@ wait_for_status | Enum | Wait until the cluster is in a specific state or better
  "task_max_waiting_in_queue_millis" : 0,
  "active_shards_percent_as_number" : 100.0
 }
-```
+```
@@ -1,83 +0,0 @@
---
-layout: default
-title: Cluster settings
-parent: REST API reference
-nav_order: 20
---
-
-# Cluster settings
-
-The cluster settings operation lets you check the current settings for your cluster, review default settings, and change settings. When you update a setting using the API, OpenSearch applies it to all nodes in the cluster.
-
-
-## Examples
-
-```json
-GET _cluster/settings?include_defaults=true
-```
-
-```json
-PUT _cluster/settings
-{
-  "persistent": {
-    "action": {
-      "auto_create_index": false
-    }
-  }
-}
-```
-
-
-## Path and HTTP methods
-
-```
-GET _cluster/settings
-PUT _cluster/settings
-```
-
-
-## URL parameters
-
-All cluster settings parameters are optional.
-
-Parameter | Type | Description
-:--- | :--- | :---
-flat_settings | Boolean | Whether to return settings in the flat form, which can improve readability, especially for heavily nested settings. For example, the flat form of `"cluster": { "max_shards_per_node": 500 }` is `"cluster.max_shards_per_node": "500"`.
-include_defaults (GET only) | Boolean | Whether to include default settings as part of the response. This parameter is useful for identifying the names and current values of settings you want to update.
-master_timeout | Time | The amount of time to wait for a response from the master node. Default is 30 seconds.
-timeout (PUT only) | Time | The amount of time to wait for a response from the cluster. Default is 30 seconds.
-
-
-## Request body
-
-The GET operation has no request body options.
-
-For a PUT operation, the request body must contain `transient` or `persistent`, along with the setting you want to update:
-
-```json
-PUT _cluster/settings
-{
-  "persistent": {
-    "cluster": {
-      "max_shards_per_node": 500
-    }
-  }
-}
-```
-
-For more information about transient settings, persistent settings, and precedence, see [OpenSearch configuration]({{site.url}}{{site.baseurl}}/opensearch/configuration/).
-
-
-## Response
-
-```json
-{
-  "acknowledged": true,
-  "persistent": {
-    "cluster": {
-      "max_shards_per_node": "500"
-    }
-  },
-  "transient": {}
-}
-```
@@ -362,19 +362,19 @@ Snapshots are only forward-compatible by one major version. If you have an old s
 If you're using the security plugin, snapshots have some additional restrictions:

 - To perform snapshot and restore operations, users must have the built-in `manage_snapshots` role.
- You can't restore snapshots that contain global state or the `.opendistro_security` index.
+- You can't restore snapshots that contain global state or the `.opensearch_security` index.

-If a snapshot contains global state, you must exclude it when performing the restore. If your snapshot also contains the `.opendistro_security` index, either exclude it or list all the other indices you want to include:
+If a snapshot contains global state, you must exclude it when performing the restore. If your snapshot also contains the `.opensearch_security` index, either exclude it or list all the other indices you want to include:

 ```json
 POST _snapshot/my-repository/3/_restore
 {
-  "indices": "-.opendistro_security",
+  "indices": "-.opensearch_security",
  "include_global_state": false
 }
 ```

-The `.opendistro_security` index contains sensitive data, so we recommend excluding it when you take a snapshot. If you do need to restore the index from a snapshot, you must include an admin certificate in the request:
+The `.opensearch_security` index contains sensitive data, so we recommend excluding it when you take a snapshot. If you do need to restore the index from a snapshot, you must include an admin certificate in the request:

 ```bash
 curl -k --cert ./kirk.pem --key ./kirk-key.pem -XPOST 'https://localhost:9200/_snapshot/my-repository/3/_restore?pretty'
@@ -1,13 +1,10 @@
 ---
 layout: default
-title: Tasks
-parent: REST API reference
-nav_order: 80
-redirect_from:
-  - /opensearch/tasksapi/
+title: Tasks API
+nav_order: 25
 ---

-# Tasks
+# Tasks API operation

 A task is any operation you run in a cluster. For example, searching your data collection of books for a title or author name is a task. When you run OpenSearch, a task is automatically created to monitor your cluster's health and performance. For more information about all of the tasks currently executing in your cluster, you can use the `tasks` API operation.

@@ -31,7 +31,7 @@ You can create users using OpenSearch Dashboards, `internal_users.yml`, or the R
 ### OpenSearch Dashboards

 1. Choose **Security**, **Internal Users**, and **Create internal user**.
-1. Provide a username and password. The security plugin automatically hashes the password and stores it in the `.opendistro_security` index.
+1. Provide a username and password. The security plugin automatically hashes the password and stores it in the `.opensearch_security` index.
 1. If desired, specify user attributes.

   Attributes are optional user properties that you can use for variable substitution in index permissions or document-level security.
@@ -8,11 +8,11 @@ redirect_from: /docs/security/configuration/security-admin/

 # Apply configuration changes using securityadmin.sh

-The security plugin stores its configuration---including users, roles, and permissions---in an index on the OpenSearch cluster (`.opendistro_security`). Storing these settings in an index lets you change settings without restarting the cluster and eliminates the need to edit configuration files on every single node.
+The security plugin stores its configuration---including users, roles, and permissions---in an index on the OpenSearch cluster (`.opensearch_security`). Storing these settings in an index lets you change settings without restarting the cluster and eliminates the need to edit configuration files on every single node.

-After changing any of the configuration files in `plugins/opensearch-security/securityconfig`, however, you must run `plugins/opensearch-security/tools/securityadmin.sh` to load these new settings into the index. You must also run this script at least once to initialize the `.opendistro_security` index and configure your authentication and authorization methods.
+After changing any of the configuration files in `plugins/opensearch-security/securityconfig`, however, you must run `plugins/opensearch-security/tools/securityadmin.sh` to load these new settings into the index. You must also run this script at least once to initialize the `.opensearch_security` index and configure your authentication and authorization methods.

-After the `.opendistro_security` index is initialized, you can use OpenSearch Dashboards to manage your users, roles, and permissions.
+After the `.opensearch_security` index is initialized, you can use OpenSearch Dashboards to manage your users, roles, and permissions.


 ## Configure the admin certificate
@@ -228,7 +228,7 @@ Name | Description
 `-esa` | Enable shard allocation and exit. This option is useful if you disabled shard allocation while performing a full cluster restart and need to recreate the security plugin index.
 `-w` | Displays information about the used admin certificate.
 `-rl` | By default, the security plugin caches authenticated users, along with their roles and permissions, for one hour. This option reloads the current security plugin configuration stored in your cluster, invalidating any cached users, roles, and permissions.
-`-i` | The security plugin index name. Default is `.opendistro_security`.
+`-i` | The security plugin index name. Default is `.opensearch_security`.
 `-er` | Set explicit number of replicas or auto-expand expression for the `opensearch_security` index.
 `-era` | Enable replica auto-expand.
 `-dra` | Disable replica auto-expand.
@@ -8,9 +8,9 @@ redirect_from: /docs/security/configuration/system-indices/

 # System indices

-By default, OpenSearch has a protected system index, `.opendistro_security`, which you create using [securityadmin.sh]({{site.url}}{{site.baseurl}}/security-plugin/configuration/security-admin/). Even if your user account has read permissions for all indices, you can't directly access the data in this system index.
+By default, OpenSearch has a protected system index, `.opensearch_security`, which you create using [securityadmin.sh]({{site.url}}{{site.baseurl}}/security-plugin/configuration/security-admin/). Even if your user account has read permissions for all indices, you can't directly access the data in this system index.

-You can add additional system indices in in `opensearch.yml`. In addition to automatically creating `.opendistro_security`, the demo configuration adds several indices for the various OpenSearch plugins that integrate with the security plugin:
+You can add additional system indices in in `opensearch.yml`. In addition to automatically creating `.opensearch_security`, the demo configuration adds several indices for the various OpenSearch plugins that integrate with the security plugin:

 ```yml
 plugins.security.system_indices.enabled: true
@@ -20,7 +20,7 @@ plugins.security.system_indices.indices: [".opendistro-alerting-config", ".opend
 To access these indices, you must authenticate with an [admin certificate]({{site.url}}{{site.baseurl}}/security-plugin/configuration/tls#configure-admin-certificates):

 ```bash
-curl -k --cert ./kirk.pem --key ./kirk-key.pem -XGET 'https://localhost:9200/.opendistro_security/_search'
+curl -k --cert ./kirk.pem --key ./kirk-key.pem -XGET 'https://localhost:9200/.opensearch_security/_search'
 ```

 The alternative is to remove indices from the `plugins.security.system_indices.indices` list on each node and restart OpenSearch.
@@ -8,7 +8,7 @@ redirect_from: /docs/security/configuration/yaml/

 # YAML files

-Before running `securityadmin.sh` to load the settings into the `.opendistro_security` index, configure the YAML files in `plugins/opensearch-security/securityconfig`. You might want to back up these files so that you can reuse them on other clusters.
+Before running `securityadmin.sh` to load the settings into the `.opensearch_security` index, configure the YAML files in `plugins/opensearch-security/securityconfig`. You might want to back up these files so that you can reuse them on other clusters.

 The best use of these YAML files is to configure [reserved and hidden resources]({{site.url}}{{site.baseurl}}/security-plugin/access-control/api#reserved-and-hidden-resources), such as the `admin` and `kibanaserver` users. You might find it easier to create other users, roles, mappings, action groups, and tenants using OpenSearch Dashboards or the REST API.

@@ -1,21 +0,0 @@
---
-layout: default
-title: About the process
-nav_order: 1
-redirect_from:
-  - /migrate/
-  - /upgrade-to/
---
-
-# About the process
-
-The process of upgrading from Elasticsearch OSS (including Open Distro for Elasticsearch) to OpenSearch varies depending on your current version of Elasticsearch OSS, install type, tolerance for downtime, and cost-sensitivity. Rather than concrete steps to cover every situation, we have general guidance for the process.
-
-Three approaches exist:
-
- Use a snapshot to [migrate your Elasticsearch OSS data]({{site.url}}{{site.baseurl}}/upgrade-to/snapshot-migrate/) to a new OpenSearch cluster.
- Perform a [rolling upgrade or cluster restart upgrade]({{site.url}}{{site.baseurl}}/upgrade-to/upgrade-to/) on your existing nodes.
- Replace existing Elasticsearch OSS nodes with new OpenSearch nodes. Node replacement is most popular when upgrading [Docker clusters]({{site.url}}{{site.baseurl}}/upgrade-to/docker-upgrade-to/).
-
-Regardless of your approach, to safeguard against data loss, we recommend that you take a [snapshot]({{site.url}}{{site.baseurl}}/opensearch/snapshot-restore/) of all indices prior to any migration.
-{: .tip }
Author	SHA1	Message	Date
Ashwin Kumar	c18cced55a	Update _clients/logstash/index.md Co-authored-by: Vijayan Balasubramanian <VijayanB@users.noreply.github.com>	2021-08-03 13:30:21 -07:00
Ashwin Kumar	31613067dd	Update _clients/logstash/index.md Co-authored-by: Vijayan Balasubramanian <VijayanB@users.noreply.github.com>	2021-08-02 17:34:06 -07:00
Ashwin Kumar	8d178c3d83	Update _clients/logstash/index.md Co-authored-by: Vijayan Balasubramanian <VijayanB@users.noreply.github.com>	2021-08-02 17:33:56 -07:00
Ashwin Kumar	cfb582dd26	Update _clients/logstash/index.md Co-authored-by: Vijayan Balasubramanian <VijayanB@users.noreply.github.com>	2021-08-02 17:33:45 -07:00
ashwinkumar12345	96e0c4dbcd	install fix	2021-08-02 13:00:04 -07:00
ashwinkumar12345	880a635b90	minor fix	2021-08-02 11:16:39 -07:00
ashwinkumar12345	9ab749a7df	added Logstash Docker install steps	2021-08-02 11:14:03 -07:00
ashwinkumar12345	3170c44a4f	added docker image	2021-07-09 11:26:35 -07:00
ashwinkumar12345	5c3572bed1	typo	2021-07-06 23:52:32 -07:00
ashwinkumar12345	96f08a51d7	incorporated feedback	2021-07-06 23:51:45 -07:00
ashwinkumar12345	70c9b6d9c8	minor changes	2021-07-06 11:53:10 -07:00
ashwinkumar12345	9648a850ad	more changes	2021-07-05 23:52:45 -07:00
ashwinkumar12345	e0004a2f52	minor changes	2021-06-20 12:30:09 -07:00
ashwinkumar12345	a1a5ed068b	added logstash info	2021-06-14 12:26:23 -07:00