# es-fieldusage
[](https://pypi.org/project/es-fieldusage)
[](https://pypi.org/project/es-fieldusage)
-----
**Table of Contents**
- [Installation](#installation)
- [Description](#description)
- [License](#license)
## Installation
```console
pip install es-fieldusage
```
## Description
Determine which fields are being used, how much, for a given index.
### Top-level help output
```
$ 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) [default: verify_certs]
--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
-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/elastic-grab-bag/es_fieldusage
```
### Command `stdout` help output
```
$ 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/elastic-grab-bag/es_fieldusage
```
### Command `file` help output
```
$ 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/elastic-grab-bag/es_fieldusage
```
## License
`es-fieldusage` is distributed under the terms of the [Apache 2.0](http://www.apache.org/licenses/LICENSE-2.0) license.
Raw data
{
"_id": null,
"home_page": "",
"name": "es-fieldusage",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "elasticsearch,field,index,stats,usage",
"author": "",
"author_email": "Elastic <info@elastic.co>",
"download_url": "https://files.pythonhosted.org/packages/67/f6/617cac22ecd004435b66849230f1ceb85e4751364496a92a7e1ea3142e70/es_fieldusage-0.2.7.tar.gz",
"platform": null,
"description": "# es-fieldusage\n\n[](https://pypi.org/project/es-fieldusage)\n[](https://pypi.org/project/es-fieldusage)\n\n-----\n\n**Table of Contents**\n\n- [Installation](#installation)\n- [Description](#description)\n- [License](#license)\n\n## Installation\n\n```console\npip install es-fieldusage\n```\n\n## Description\n\nDetermine which fields are being used, how much, for a given index.\n\n### Top-level help output\n```\n$ es-fieldusage --help\n\nUsage: es-fieldusage [OPTIONS] COMMAND [ARGS]...\n\n Elasticsearch Index Field Usage Reporting Tool\n\n Sum all field query/request access for one or more indices using the Elastic Field Usage API (https://ela.st/usagestats)\n\n Generate a report at the command-line with the stdout command for all indices in INDEX_PATTERN:\n\n $ es-fieldusage stdout INDEX_PATTERN\n\n To avoid errors, be sure to encapsulate wildcards in single-quotes:\n\n $ es-fieldusage stdout 'index-*'\n\nOptions:\n --config PATH Path to configuration file.\n --hosts TEXT Elasticsearch URL to connect to.\n --cloud_id TEXT Elastic Cloud instance id\n --api_token TEXT The base64 encoded API Key token\n --id TEXT API Key \"id\" value\n --api_key TEXT API Key \"api_key\" value\n --username TEXT Elasticsearch username\n --password TEXT Elasticsearch password\n --request_timeout FLOAT Request timeout in seconds\n --verify_certs / --no-verify_certs\n Verify SSL/TLS certificate(s) [default: verify_certs]\n --ca_certs TEXT Path to CA certificate file or directory\n --client_cert TEXT Path to client certificate file\n --client_key TEXT Path to client key file\n --loglevel [DEBUG|INFO|WARNING|ERROR|CRITICAL]\n Log level\n --logfile TEXT Log file\n --logformat [default|ecs] Log output format\n -v, --version Show the version and exit.\n -h, --help Show this message and exit.\n\nCommands:\n show-all-options Show all configuration options\n stdout Output field usage information to the console\n\n Learn more at https://github.com/untergeek/elastic-grab-bag/es_fieldusage\n```\n\n### Command `stdout` help output\n\n```\n$ es-fieldusage stdout --help\nUsage: es-fieldusage stdout [OPTIONS] SEARCH_PATTERN\n\n Display field usage information on the console for SEARCH_PATTERN\n\n $ es-fieldusage stdout [OPTIONS] SEARCH_PATTERN\n\nOptions:\n --show-report / --hide-report Show a summary report [default: show-report]\n --show-headers / --hide-headers\n Show block headers for un|accessed fields [default: show-headers]\n --show-accessed / --hide-accessed\n Show accessed fields [default: hide-accessed]\n --show-unaccessed / --hide-unaccessed\n Show unaccessed fields [default: hide-unaccessed]\n --show-counts / --hide-counts Show field access counts [default: hide-counts]\n --delimiter TEXT Value delimiter if access counts are shown [default: :]\n -h, --help Show this message and exit.\n\n Learn more at https://github.com/untergeek/elastic-grab-bag/es_fieldusage\n ```\n\n### Command `file` help output\n\n```\n$ es-fieldusage file --help\nUsage: es-fieldusage file [OPTIONS] SEARCH_PATTERN\n\n Write field usage information to file for SEARCH_PATTERN\n\n $ es-fieldusage file [OPTIONS] SEARCH_PATTERN\n\nOptions:\n --show-report / --hide-report Show a summary report [default: show-report]\n --show-headers / --hide-headers\n Show block headers for un|accessed fields [default: show-headers]\n --show-accessed / --hide-accessed\n Show accessed fields [default: hide-accessed]\n --show-unaccessed / --hide-unaccessed\n Show unaccessed fields [default: hide-unaccessed]\n --show-counts / --hide-counts Show field access counts [default: hide-counts]\n --per_index Create one file per index found\n --delimiter TEXT Value delimiter if access counts are shown [default: ,]\n -h, --help Show this message and exit.\n\n Learn more at https://github.com/untergeek/elastic-grab-bag/es_fieldusage\n```\n\n## License\n\n`es-fieldusage` is distributed under the terms of the [Apache 2.0](http://www.apache.org/licenses/LICENSE-2.0) license.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Helping you determine field usage by index",
"version": "0.2.7",
"project_urls": {
"Documentation": "https://github.com/untergeek/elastic-grab-bag/es-fieldusage#readme",
"Issues": "https://github.com/untergeek/elastic-grab-bag/issues",
"Source": "https://github.com/untergeek/elastic-grab-bag/es-fieldusage"
},
"split_keywords": [
"elasticsearch",
"field",
"index",
"stats",
"usage"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7b7968910effd5d1ba7ca79bea78395a611f928226690be8d23fd918763bdf10",
"md5": "0abc75e5ffca18e27b9e3adb128b6e8e",
"sha256": "a4c0bddeed7e674a02651ce65957dca0a26cae4f421466492e035a8488081549"
},
"downloads": -1,
"filename": "es_fieldusage-0.2.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0abc75e5ffca18e27b9e3adb128b6e8e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 17571,
"upload_time": "2023-10-04T01:43:34",
"upload_time_iso_8601": "2023-10-04T01:43:34.650900Z",
"url": "https://files.pythonhosted.org/packages/7b/79/68910effd5d1ba7ca79bea78395a611f928226690be8d23fd918763bdf10/es_fieldusage-0.2.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "67f6617cac22ecd004435b66849230f1ceb85e4751364496a92a7e1ea3142e70",
"md5": "5ca37122001aa0d32a800ac1ef359da7",
"sha256": "a9aeff6c8c7a0f83611b4618aabfd5dd82cc6c60d3d3872b79354912d55a5713"
},
"downloads": -1,
"filename": "es_fieldusage-0.2.7.tar.gz",
"has_sig": false,
"md5_digest": "5ca37122001aa0d32a800ac1ef359da7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 15964,
"upload_time": "2023-10-04T01:43:36",
"upload_time_iso_8601": "2023-10-04T01:43:36.381747Z",
"url": "https://files.pythonhosted.org/packages/67/f6/617cac22ecd004435b66849230f1ceb85e4751364496a92a7e1ea3142e70/es_fieldusage-0.2.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-04 01:43:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "untergeek",
"github_project": "elastic-grab-bag",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "es-fieldusage"
}
JSON
