0.0.5

Author: alden-kang-personal

README.md

@@ -18,9 +18,27 @@ $ escli index settings my-index-000001 number_of_replicas 2
 ## Release Note 
 Release Note is [Here](RELEASENOTE.md)
 
+>**WARNING**
+>If you used escli 0.0.4, you have to change your config file. configuration field `elasticsearch_url` is changed `url`.
+
+[AS-IS]
+```bash
+- profile: localhost
+  elasticsearch_url: http://localhost:9200
+  aws_region: ap-northeast-2
+```
+
+[TO-BE]
+```bash
+- profile: localhost
+  url: http://localhost:9200
+  aws_region: ap-northeast-2
+```
+
 ## Installation
 ### Required
 - [elasticsearch](https://elastic.co) version 6.0 or higher
+- [opensearch](https://opensearch.org) version 1.0 or higher
 
 ### Install escli binary 
 
@@ -41,20 +59,54 @@ $ sudo install escli /usr/bin
 configuration of escli is stored at `~/.escli/config.yaml` file.
 for the first time, there is no configuration so you have to initialize configuration with `escli profiles add`
 ```bash
-$ escli profiles add
-? Your Profile Name :  log-es
-? Your ElasticSearch URL :  http://elasticsearch.domain.com:9200
-? Your AWS Default Region (If you don't use AWS, type blank) :  ap-northeast-2
-- profile: log-es
-  elasticsearch_url: http://elasticsearch.domain.com:9200
-  aws_region: ap-northeast-2
-
-? Are you sure to add profile to configuration file?  y
-Adding profile to configuration file is successfully in /Users/benx/.escli/config.yaml
+? Your Profile Name :  localhost
+? Your ElasticSearch or OpenSearch URL :  https://localhost:9200
+? Select your product (elasticsearch or opensearch) :  elasticsearch
+? Your AWS Default Region (If you don't use AWS, type blank) :
+? Your HTTP Username (If you don't use http basic authentication, type blank) :  elastic
+? Your HTTP Password (If you don't use http basic authentication, type blank) :  ********************
+? Your certificateFingerPrint (If you don't use certificate finger print, type blank) :  67c2d588a7a6a50e773d0cc91f83cab7a6c11a19e199f3f075b9b6d873a5992a
+- profile: localhost
+  url: https://localhost:9200
+  product: elasticsearch
+  http_username: elastic
+  http_password: qZzEp0Hc112zYx=Z+xQb
+  certificate_finger_print: 67c2d588a7a6a50e773d0cc91f83cab7a6c11a19e199f3f075b9b6d873a5992a
+
+? Are you sure to add profile to configuration file?  yes
+Adding profile to configuration file is successfully in /Users/alden/.escli/config.yaml
 ```
 
 ## How to use
 
+### configuration
+| field | description                                                                             |
+| ------|-----------------------------------------------------------------------------------------|
+| profile | name of profile                                                                         |
+| url | url of target system                                                                    |
+| product | product of target system. elasticsearch or opensearch         (default : elasticsearch) |
+| aws_region | aws region that you use                                                                 |
+| http_username | http username of target system. It is needed if you use basic http authentication.      |
+| http_password | http password of target system.                                                         |
+| certificate_fingerprint | certificate fingerprint of target system                                                |
+#### configuration example
+```bash
+- profile: dev-access-log
+  url: https://dev-access-log.ap-northeast-2.es.amazonaws.com
+  product: opensearch
+- profile: prod-access-log
+  url: https://prod-access-log.ap-northeast-2.es.amazonaws.com
+  product: opensearch
+  http_username: elastic
+  http_password: abcdefg
+- profile: localhost
+  url: https://localhost:9200
+  product: elasticsearch
+  http_username: elastic
+  http_password: qZzEp0Hc112zYx=Z+xQb
+  certificate_finger_print: 67c2d588a7a6a50e773d0cc91f83cab7a6c11a19e199f3f075b9b6d873a5992a
+```
+
 ### common options
 * `--profile` : you can specify profile from configuration file. if you don't specify `--profile` option, escli use first profile of configuration file.
 * `--config` : you can specify configuration file. if you don't specify `--config` option, escli use `~/.escli/config.yaml` configuration file.
@@ -73,26 +125,32 @@ you can add one more elasticsearch clusters to your configuration file by `profi
 
 ```bash
 $ escli profiles add
-? Your Profile Name :  service-es
-? Your ElasticSearch URL :  http://search.domain.com:9200
-? Your AWS Default Region (If you don't use AWS, type blank) :  
-- profile: service-es
-  elasticsearch_url: http://search.domain.com:9200
-  aws_region: ""
-
-? Are you sure to add profile to configuration file?  y
-Adding profile to configuration file is successfully in /Users/benx/.escli/config.yaml
+? Your Profile Name :  localhost
+? Your ElasticSearch or OpenSearch URL :  https://localhost:9200
+? Select your product (elasticsearch or opensearch) :  elasticsearch
+? Your AWS Default Region (If you don't use AWS, type blank) :
+? Your HTTP Username (If you don't use http basic authentication, type blank) :  elastic
+? Your HTTP Password (If you don't use http basic authentication, type blank) :  ********************
+? Your certificateFingerPrint (If you don't use certificate finger print, type blank) :  67c2d588a7a6a50e773d0cc91f83cab7a6c11a19e199f3f075b9b6d873a5992a
+- profile: localhost
+  url: https://localhost:9200
+  product: elasticsearch
+  http_username: elastic
+  http_password: qZzEp0Hc112zYx=Z+xQb
+  certificate_finger_print: 67c2d588a7a6a50e773d0cc91f83cab7a6c11a19e199f3f075b9b6d873a5992a
+
+? Are you sure to add profile to configuration file?  yes
+Adding profile to configuration file is successfully in /Users/alden/.escli/config.yaml
 ```
 
 ```bash
 $ escli profiles list
-Profile           : log-es
-ElasticSearch URL : http://elasticsearch.domain.com:9200
-AWS Region        : ap-northeast-2
-
-Profile           : service-es
-ElasticSearch URL : http://search.domain.com:9200
-AWS Region        : 
+Profile                  : localhost
+URL                      : https://localhost:9200
+Product                  : elasticsearch
+HTTP Username            : elastic
+HTTP Password            : ************
+Certificate Finger Print : 67c2d588a7a6a50e773d0cc91f83cab7a6c11a19e199f3f075b9b6d873a5992a
 ```
 
 ```bash
@@ -146,6 +204,8 @@ application-log-2021.01.06                   green   open    100     1
 
 ### `snapshot` command
 
+`snapshot` command doesn't support OpenSearch.
+
 #### command list
 | command     | description                                               |
 | ----------- | --------------------------------------------------------- |
@@ -190,9 +250,13 @@ elasticsearch-snapshot-standard/indices/z8bqmUmAQxy8tuwSsmFEKg/0/__-urzTmmuR8K6s
 ### `index` command
 
 #### command list
-| command | description |
-| ------- | ---------------- |
+| command        | description |
+|----------------| ---------------- |
 | index settings | get or set index settings |
+| index delete   | delete index |
+| index create   | create index |
+| index stats    | show statistics of index |
+
 
 #### examples
 
@@ -236,6 +300,18 @@ $ escli index settings send-mail-result-prod-2021-01-12 number_of_replicas 2
 }
 ```
 
+```bash
+$ escli index stats access_log-2023.02.13 1 --profile=localhost
+time      	index               	        total shards	   successful shards	       failed shards	       indexing rate	indexing latency (ms)	          query rate	  query latency (ms)	          fetch rate	  fetch latency (ms)
+16:08:13  	access_log-2023.02.13	                  12	                  12	                   0	                3182	                0.13	                   0	                0.00	                   0	                0.00
+16:08:14  	access_log-2023.02.13	                  12	                  12	                   0	                2348	                0.09	                   0	                0.00	                   0	                0.00
+16:08:15  	access_log-2023.02.13	                  12	                  12	                   0	                2466	                0.12	                   0	                0.00	                   0	                0.00
+16:08:16  	access_log-2023.02.13	                  12	                  12	                   0	                   0	                0.00	                   0	                0.00	                   0	                0.00
+16:08:17  	access_log-2023.02.13	                  12	                  12	                   0	                6046	                0.14	                   0	                0.00	                   0	                0.00
+16:08:18  	access_log-2023.02.13	                  12	                  12	                   0	                5056	                0.17	                   0	                0.00	                   0	                0.00
+16:08:19  	access_log-2023.02.13	                  12	                  12	                   0	                1286	                0.10	                   0	                0.00	                   0	                0.00
+```
+
 ### `cluster` command
 
 #### command list
@@ -273,6 +349,19 @@ check number of master nodes...................[3]
 check maximum disk used percent of nodes.......[36]
 ```
 
+### `stats` command
+
+#### examples
+
+```bash
+$ escli stats 1 --profile=localhost
+time      	        total shards	   successful shards	       failed shards	       indexing rate	indexing latency (ms)	          query rate	  query latency (ms)	          fetch rate	  fetch latency (ms)
+16:10:32  	                 204	                 204	                   0	               10591	                0.47	                   0	                0.00	                   0	                0.00
+16:10:33  	                 204	                 204	                   0	                1099	                8.16	                   0	                0.00	                   0	                0.00
+16:10:34  	                 204	                 204	                   0	                3267	                0.13	                   0	                0.00	                   0	                0.00
+16:10:35  	                 204	                 204	                   0	                1869	                0.13	                   0	                0.00	                   0	                0.00
+```
+
 ## Autocompletion
 * zsh
 ```bash

RELEASENOTE.md

@@ -1,5 +1,11 @@
 # Release Note
 
+## 0.0.5 (2023/02/13)
+- `escli` supports OpenSearch.
+- `index stats` command shows statistics of index.
+- `stats` command shows statistics of cluster.
+- `index create` command create index.
+
 ## 0.0.4 (2021/03/30)
 - autocomplete is included.
 - `profiles list` command shows all profiles of escli.

cmd/cmd/builder/builder.go

@@ -53,10 +53,6 @@ func (b builder) WithDescription(description string) Builder {
 	return b
 }
 
-func (b builder) WithUsageTemplate(s string) {
-	b.cmd.SetUsageTemplate("abc")
-}
-
 func (b builder) ExactArgs(argCount int, action func(context.Context, io.Writer, []string) error) *cobra.Command {
 	b.cmd.Args = cobra.ExactArgs(argCount)
 	b.cmd.RunE = func(cmd *cobra.Command, args []string) error {

cmd/cmd/builder/example.go

@@ -44,6 +44,10 @@ var ExampleList = []Example{
 		Description: "  escli snapshot archive application-log snapshot-2020.01.01",
 		DefinedOn:   []string{"snapshot archive [repositoryID] [snapshotID]"},
 	},
+	{
+		Description: "  escli index stats logs-2020.01.01 1",
+		DefinedOn:   []string{"index stats [index name] [interval]"},
+	},
 }
 
 func SetCommandExample(cmd *cobra.Command) {

cmd/cmd/cat.go

@@ -42,6 +42,7 @@ func NewCatCommand() *cobra.Command {
 
 	builder.SetCommandFlags(catIndicesCommand)
 	builder.SetCommandFlags(catShardsCommand)
+	builder.SetCommandFlags(catNodesCommand)
 
 	return cmd
 }

cmd/cmd/cmd.go

@@ -37,7 +37,7 @@ func NewRootCommand(out, stderr io.Writer) *cobra.Command {
 		Short:         "manage elasticsearch cluster",
 		Long:          "manage elasticsearch cluster",
 		SilenceErrors: true,
-		SilenceUsage:  true,
+		SilenceUsage:  false,
 	}
 
 	rootCmd.AddCommand(NewSnapshotCommand())
@@ -50,6 +50,7 @@ func NewRootCommand(out, stderr io.Writer) *cobra.Command {
 	rootCmd.AddCommand(NewUpdateCommand())
 	rootCmd.AddCommand(NewCompletionCommand())
 	rootCmd.AddCommand(NewProfilesCommand())
+	rootCmd.AddCommand(NewStatsCommand())
 
 	rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file")
 	rootCmd.PersistentFlags().StringVar(&profile, "profile", "", "profile")

cmd/cmd/index.go

@@ -32,12 +32,18 @@ func NewIndexCommand() *cobra.Command {
 
 	indexSettingsCommand := index.NewIndexSettingsCommand()
 	indexDeleteCommand := index.NewIndexDeleteCommand()
+	indexStatsCommand := index.NewIndexStatsCommand()
+	indexCreateCommand := index.NewIndexCreateCommand()
 
 	cmd.AddCommand(indexSettingsCommand)
 	cmd.AddCommand(indexDeleteCommand)
+	cmd.AddCommand(indexStatsCommand)
+	cmd.AddCommand(indexCreateCommand)
 
 	builder.SetCommandFlags(indexSettingsCommand)
 	builder.SetCommandFlags(indexDeleteCommand)
+	builder.SetCommandFlags(indexCreateCommand)
+	builder.SetCommandExample(indexStatsCommand)
 
 	return cmd
 }

cmd/cmd/index/create.go

@@ -0,0 +1,39 @@
+/*
+copyright 2020 the Escli authors
+
+licensed under the apache license, version 2.0 (the "license");
+you may not use this file except in compliance with the license.
+you may obtain a copy of the license at
+
+    http://www.apache.org/licenses/license-2.0
+
+unless required by applicable law or agreed to in writing, software
+distributed under the license is distributed on an "as is" basis,
+without warranties or conditions of any kind, either express or implied.
+see the license for the specific language governing permissions and
+limitations under the license.
+*/
+
+package index
+
+import (
+	"context"
+	"io"
+
+	"github.com/spf13/cobra"
+
+	"github.com/DevopsArtFactory/escli/cmd/cmd/builder"
+	"github.com/DevopsArtFactory/escli/internal/executor"
+)
+
+func NewIndexCreateCommand() *cobra.Command {
+	return builder.NewCmd("create").
+		WithDescription("create index").
+		ExactArgs(1, funcIndexCreate)
+}
+
+func funcIndexCreate(ctx context.Context, out io.Writer, args []string) error {
+	return executor.RunExecutor(ctx, func(executor executor.Executor) error {
+		return executor.Runner.CreateIndex(out, args)
+	})
+}

cmd/cmd/index/stats.go

@@ -0,0 +1,39 @@
+/*
+copyright 2020 the Escli authors
+
+licensed under the apache license, version 2.0 (the "license");
+you may not use this file except in compliance with the license.
+you may obtain a copy of the license at
+
+    http://www.apache.org/licenses/license-2.0
+
+unless required by applicable law or agreed to in writing, software
+distributed under the license is distributed on an "as is" basis,
+without warranties or conditions of any kind, either express or implied.
+see the license for the specific language governing permissions and
+limitations under the license.
+*/
+
+package index
+
+import (
+	"context"
+	"io"
+
+	"github.com/spf13/cobra"
+
+	"github.com/DevopsArtFactory/escli/cmd/cmd/builder"
+	"github.com/DevopsArtFactory/escli/internal/executor"
+)
+
+func NewIndexStatsCommand() *cobra.Command {
+	return builder.NewCmd("stats [index name] [interval]").
+		WithDescription("show stats of index").
+		ExactArgs(2, funcIndexStats)
+}
+
+func funcIndexStats(ctx context.Context, out io.Writer, args []string) error {
+	return executor.RunExecutor(ctx, func(executor executor.Executor) error {
+		return executor.Runner.StatsIndex(out, args)
+	})
+}