es-fieldusage

目录

• es-fieldusage
  • 安装
  • 描述
    • 顶级帮助输出
    • 命令: stdout 帮助输出
    • 命令 file 帮助输出
    • 命令 show-indices 帮助输出
  • Docker使用
    • Docker构建
    • Docker运行
  • 许可证

安装

pip install es-fieldusage

描述

确定给定索引中哪些字段正在被使用，使用量是多少。

顶级帮助输出

$ es-fieldusage --help

Usage: es-fieldusage [OPTIONS] COMMAND [ARGS]...

  Elasticsearch Index Field Usage Reporting Tool

  Sum all field query/request access for one or more indices using the Elastic Field Usage API (https://ela.st/usagestats)

  Generate a report at the command-line with the stdout command for all indices in INDEX_PATTERN:

  $ es-fieldusage stdout INDEX_PATTERN

  To avoid errors, be sure to encapsulate wildcards in single-quotes:

  $ es-fieldusage stdout 'index-*'

Options:
  --config PATH                   Path to configuration file.
  --hosts TEXT                    Elasticsearch URL to connect to.
  --cloud_id TEXT                 Elastic Cloud instance id
  --api_token TEXT                The base64 encoded API Key token
  --id TEXT                       API Key "id" value
  --api_key TEXT                  API Key "api_key" value
  --username TEXT                 Elasticsearch username
  --password TEXT                 Elasticsearch password
  --request_timeout FLOAT         Request timeout in seconds
  --verify_certs / --no-verify_certs
                                  Verify SSL/TLS certificate(s)
  --ca_certs TEXT                 Path to CA certificate file or directory
  --client_cert TEXT              Path to client certificate file
  --client_key TEXT               Path to client key file
  --loglevel [DEBUG|INFO|WARNING|ERROR|CRITICAL]
                                  Log level
  --logfile TEXT                  Log file
  --logformat [default|ecs]       Log output format
  --blacklist TEXT                Named entities will not be logged
  -v, --version                   Show the version and exit.
  -h, --help                      Show this message and exit.

Commands:
  show-all-options  Show all configuration options
  stdout            Output field usage information to the console

  Learn more at https://github.com/untergeek/es-fieldusage

命令: stdout 帮助输出

$ es-fieldusage stdout --help
Usage: es-fieldusage stdout [OPTIONS] SEARCH_PATTERN

  Display field usage information on the console for SEARCH_PATTERN

  $ es-fieldusage stdout [OPTIONS] SEARCH_PATTERN

Options:
  --show-report / --hide-report   Show a summary report  [default: show-report]
  --show-headers / --hide-headers
                                  Show block headers for un|accessed fields  [default: show-headers]
  --show-accessed / --hide-accessed
                                  Show accessed fields  [default: hide-accessed]
  --show-unaccessed / --hide-unaccessed
                                  Show unaccessed fields  [default: hide-unaccessed]
  --show-counts / --hide-counts   Show field access counts  [default: hide-counts]
  --delimiter TEXT                Value delimiter if access counts are shown  [default: ,]
  -h, --help                      Show this message and exit.

  Learn more at https://github.com/untergeek/es-fieldusage

命令 file 帮助输出

$ es-fieldusage file --help
Usage: es-fieldusage file [OPTIONS] SEARCH_PATTERN

  Write field usage information to file for SEARCH_PATTERN

  $ es-fieldusage file [OPTIONS] SEARCH_PATTERN

Options:
  --show-report / --hide-report   Show a summary report  [default: show-report]
  --show-headers / --hide-headers
                                  Show block headers for un|accessed fields  [default: show-headers]
  --show-accessed / --hide-accessed
                                  Show accessed fields  [default: hide-accessed]
  --show-unaccessed / --hide-unaccessed
                                  Show unaccessed fields  [default: hide-unaccessed]
  --show-counts / --hide-counts   Show field access counts  [default: hide-counts]
  --per_index                     Create one file per index found
  --delimiter TEXT                Value delimiter if access counts are shown  [default: ,]
  -h, --help                      Show this message and exit.

  Learn more at https://github.com/untergeek/es-fieldusage

命令 show-indices 帮助输出

$ es-fieldusage show-indices --help
Usage: es-fieldusage show-indices SEARCH_PATTERN

  Show indices on the console matching SEARCH_PATTERN

  $ es-fieldusage show_indices SEARCH_PATTERN

  This is included as a way to ensure you are seeing the indices you expect before using the file or stdout commands.

Options:
  -h, --help  Show this message and exit.

  Learn more at https://github.com/untergeek/es-fieldusage

Docker使用

Docker构建

从包含Dockerfile的路径中

$ ./docker build . -t reponame/es-fieldusage:x.y.z

例如：

docker build . -t untergeek/es-fieldusage:1.0.0

如果您已设置适当的buildx镜像，也可以为x86_64和arm64构建

docker buildx build --platform linux/amd64,linux/arm64 -t untergeek/es-fieldusage:1.0.0 --push .

Docker运行

示例

docker run -t --rm --name es-fieldusage -v /path/to/configfile/:/.esfieldusage -v $(pwd)/:/fileoutput untergeek/es-fieldusage:1.0.0 --config /.esfieldusage/config.yml show-indices 'index-*'

说明

• -t标志表示您正在与终端应用程序交互
• --rm在运行后删除创建的Docker镜像。省略此选项会导致创建很多仅运行一次的镜像。使用--name将防止此类冲突，如果省略--rm，则会提醒您已存在具有相同名称的镜像。
• --name是要创建的镜像的名称。这是可选的。
• -v 用于设置卷。 /path/to/configfile/ 是本地文件路径，您可以在其中找到 YAML 配置文件（如果选择使用的话）。卷映射中的 :/.esfieldusage 部分是 Docker 镜像中该配置文件预期的目录。第二个卷映射是 $(pwd):/fileoutput。 /fileoutput 是 Docker 镜像上的专用文件路径，用于写入 文件 命令的输出。通过使用 $(pwd)，它会映射您的当前工作目录，因此文件将出现在那里。否则，您可以将另一个路径映射到这里。
• untergeek/es-fieldusage:1.0.0 是要运行的 仓库/镜像:版本。
• --config /.esfieldusage/config.yml，如前所述，如果您打算使用 YAML 配置文件，则需要将其路径映射为卷，然后以此方式访问。文件名应与您实际拥有的文件名匹配，不一定非要是 config.yml。
• show-indices 'index-*' 此处之后的所有内容都可以作为 es-fieldusage 的常规选项和命令使用。

许可证

es-fieldusage 是在 Apache 2.0 许可证下分发的。