OpenSearch/rest-api-spec/test/cat.recovery/10_basic.yaml

---
"Test cat recovery output":

  - do:
      cat.recovery:
        v: false

  - match:
      $body: |
               /^$/

  - do:
      index:
        index:  index1
        type:   type1
        id:     1
        body:   { foo: bar }
        refresh: true
  - do:
       cluster.health:
         wait_for_status: yellow
  - do:
      cat.recovery:
        v: false

  - match:
      $body: |
              /^
              (
                index1      \s+
                \d          \s+                                 # shard
                \d+         \s+                                 # time
                (gateway|replica|snapshot|relocating)     \s+   # type
                (init|index|start|translog|finalize|done) \s+   # stage
                [-\w./]+    \s+                                 # source_host
                [-\w./]+    \s+                                 # target_host
                [-\w./]+    \s+                                 # repository
                [-\w./]+    \s+                                 # snapshot
                \d+         \s+                                 # files
                \d+\.\d+%   \s+                                 # files_percent
                \d+         \s+                                 # bytes
                \d+\.\d+%   \s+                                 # bytes_percent
                \d+         \s+                                 # total_files
                \d+         \s+                                 # total_bytes
                \d+         \s+                                 # translog
                -?\d+\.\d+% \s+                                 # translog_percent
                -?\d+       \s+                                 # total_translog
                \n
              )+
              $/
Recovery API Adds a new API endpoint at /_recovery as well as to the Java API. The recovery API allows one to see the recovery status of all shards in the cluster. It will report on percent complete, recovery type, and which files are copied. Closes #4637 2014-02-18 17:28:49 -05:00			`---`
			`"Test cat recovery output":`

			`- do:`
Default _cat APIs to verbose `?v=false` can be used if the headers are not desired. Resolves #8922 Fixes #8927 2014-12-12 08:51:20 -05:00			`cat.recovery:`
			`v: false`
Recovery API Adds a new API endpoint at /_recovery as well as to the Java API. The recovery API allows one to see the recovery status of all shards in the cluster. It will report on percent complete, recovery type, and which files are copied. Closes #4637 2014-02-18 17:28:49 -05:00
			`- match:`
[TEST] Replace folded blocks with literal blocks The regex tests are formatted with blocks for readability. Previously, they were formatted using folded style blocks (e.g. using `>`). Folded blocks convert newlines into spaces. This is problematic for our regex, since comments can only be terminated with a newline. Effectively, anything after a comment will be commented out, making many of the regex "silently pass". This commit replaces them with scalar-style blocks (e.g. using `\|`), which treats newlines as significant, and thus correctly terminates comments inside the regex. Also fixes a regex test (`cat.thread_pool/10_basic.yaml`) that started to fail after the block was fixed. The test was missing a `\s+` before the closing newline. 2014-05-02 18:27:40 -04:00			`$body: \|`
Recovery API Adds a new API endpoint at /_recovery as well as to the Java API. The recovery API allows one to see the recovery status of all shards in the cluster. It will report on percent complete, recovery type, and which files are copied. Closes #4637 2014-02-18 17:28:49 -05:00			`/^$/`

			`- do:`
			`index:`
			`index: index1`
			`type: type1`
			`id: 1`
			`body: { foo: bar }`
			`refresh: true`
			`- do:`
			`cluster.health:`
			`wait_for_status: yellow`
			`- do:`
Default _cat APIs to verbose `?v=false` can be used if the headers are not desired. Resolves #8922 Fixes #8927 2014-12-12 08:51:20 -05:00			`cat.recovery:`
			`v: false`
[TEST] Fixed pathological regex in cat.recovery Fixes #6070 2014-05-08 08:15:47 -04:00
Recovery API Adds a new API endpoint at /_recovery as well as to the Java API. The recovery API allows one to see the recovery status of all shards in the cluster. It will report on percent complete, recovery type, and which files are copied. Closes #4637 2014-02-18 17:28:49 -05:00			`- match:`
[TEST] Replace folded blocks with literal blocks The regex tests are formatted with blocks for readability. Previously, they were formatted using folded style blocks (e.g. using `>`). Folded blocks convert newlines into spaces. This is problematic for our regex, since comments can only be terminated with a newline. Effectively, anything after a comment will be commented out, making many of the regex "silently pass". This commit replaces them with scalar-style blocks (e.g. using `\|`), which treats newlines as significant, and thus correctly terminates comments inside the regex. Also fixes a regex test (`cat.thread_pool/10_basic.yaml`) that started to fail after the block was fixed. The test was missing a `\s+` before the closing newline. 2014-05-02 18:27:40 -04:00			`$body: \|`
[TEST] Fixed pathological regex in cat.recovery Fixes #6070 2014-05-08 08:15:47 -04:00			`/^`
Test: Python doesn't support atomic groups in regexes. Removing from cat.recovery 2014-05-29 10:57:09 -04:00			`(`
[TEST] Changed the possessive matching syntax in cat.recovery regex to use an independent subexpression. Possessive modifiers not supported on older Perl 2014-05-13 05:02:05 -04:00			`index1 \s+`
[TEST] Fixed pathological regex in cat.recovery Fixes #6070 2014-05-08 08:15:47 -04:00			`\d \s+ # shard`
			`\d+ \s+ # time`
			`(gateway\|replica\|snapshot\|relocating) \s+ # type`
			`(init\|index\|start\|translog\|finalize\|done) \s+ # stage`
			`[-\w./]+ \s+ # source_host`
			`[-\w./]+ \s+ # target_host`
			`[-\w./]+ \s+ # repository`
			`[-\w./]+ \s+ # snapshot`
			`\d+ \s+ # files`
Test: Python doesn't support atomic groups in regexes. Removing from cat.recovery 2014-05-29 10:57:09 -04:00			`\d+\.\d+% \s+ # files_percent`
[TEST] Fixed pathological regex in cat.recovery Fixes #6070 2014-05-08 08:15:47 -04:00			`\d+ \s+ # bytes`
Test: Python doesn't support atomic groups in regexes. Removing from cat.recovery 2014-05-29 10:57:09 -04:00			`\d+\.\d+% \s+ # bytes_percent`
Recovery: RecoveryState clean up To support the `_recovery` API, the recovery process keeps track of current progress in a class called RecoveryState. This class currently have some issues, mostly around concurrency (see #6644 ). This PR cleans it up as well as other issues around it: - Make the Index subsection API cleaner: - remove redundant information - all calculation is done based on the underlying file map - clearer definition of what is what: total files, vs reused files (local files that match the source) vs recovered files (copied over). % based progress is reported based on recovered files only. - cleaned up json response to match other API (sadly this breaks the structure). We now properly report human values for dates and other units. - Add more robust unit testing - Detail flag was passed along as state (it's now a ToXContent param) - State lookup during reporting is now always done via the IndexShard , no more fall backs to many other classes. - Cleanup APIs around time and move the little computations to the state class as opposed to doing them out of the API I also improved error messages out of the REST testing infra for things I run into. Closes #6644 Closes #9811 2015-02-10 02:54:03 -05:00			`\d+ \s+ # total_files`
			`\d+ \s+ # total_bytes`
Recovery: add total operations to the `_recovery` API This commit adds the current total number of translog operations to the recovery reporting API. We also expose the recovered / total percentage: ``` "translog": { "recovered": 536, "total": 986, "percent": "54.3%", "total_time": "2ms", "total_time_in_millis": 2 }, ``` Closes #9368 Closes #10042 2015-03-07 10:50:32 -05:00			`\d+ \s+ # translog`
			`-?\d+\.\d+% \s+ # translog_percent`
			`-?\d+ \s+ # total_translog`
[TEST] Fixed pathological regex in cat.recovery Fixes #6070 2014-05-08 08:15:47 -04:00			`\n`
[TEST] Changed the possessive matching syntax in cat.recovery regex to use an independent subexpression. Possessive modifiers not supported on older Perl 2014-05-13 05:02:05 -04:00			`)+`
[TEST] Fixed pathological regex in cat.recovery Fixes #6070 2014-05-08 08:15:47 -04:00			`$/`