es_client
Documentation¶
You may wonder why this even exists, as at first glance it doesn’t seem to make
anything any easier than just using Elasticsearch
to
build a client connection. I needed to be able to reuse the more complex
schema validation bits I was employing, namely:
master_only
detectionElasticsearch version checking and validation, and the option to skip this.
Configuration value validation, including file paths for SSL certificates, meaning:
No unknown keys or unacceptable parameter values are accepted
Acceptable values and ranges are established (where known)–and easy to amend, if necessary.
But that’s just the tip of the iceberg. That’s only the Builder Class!
In addition to a Builder class, there’s an entire set of Helpers and a Tutorial to show you how to build your own command-line interface like this one:
Usage: run_script.py [OPTIONS] COMMAND [ARGS]...
CLI Example
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|json|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
test-connection Test connection to Elasticsearch
So, if you don’t need these, then this library probably isn’t what you’re looking for. If you do want features like these, then you’ve come to the right place.
Example Builder Class Usage¶
from es_client import Builder
config = {
'elasticsearch': {
'client': {
'hosts': 'https://10.0.0.123:9200',
'ca_certs': '/etc/elasticsearch/certs/ca.crt',
'request_timeout': 60,
},
'other_settings': {
'master_only': True,
'username': 'joe_user',
'password': 'password',
}
},
'logging': {
'loglevel': 'INFO',
'logfile': '/path/to/file.log',
'logformat': 'default',
'blacklist': ['elastic_transport', 'urllib3']
}
}
builder = Builder(configdict=config)
try:
builder.connect()
except:
# Do exception handling here...
client = builder.client
Additionally, you can read from a YAML configuration file:
---
elasticsearch:
client:
hosts: https://10.0.0.123:9200
ca_certs: /etc/elasticsearch/certs/ca.crt
request_timeout: 60
other_settings:
master_only: true
username: joe_user
password: password
logging:
loglevel: INFO
logfile: /path/to/file.log
logformat: default
blacklist: ['elastic_transport', 'urllib3']
from es_client import Builder
builder = Builder(configfile='/path/to/es_client.yml')
try:
builder.connect()
except:
# Do exception handling here...
client = builder.client
The same schema validations apply here as well.
License¶
Copyright (c) 2022-2024 Aaron Mildenstein
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
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.
Contents¶
- ES Client API reference
- ClientArgs Class
- OtherArgs Class
- Builder Class
Builder
Builder._check_api_key()
Builder._check_basic_auth()
Builder._check_cloud_id()
Builder._check_master()
Builder._check_ssl()
Builder._check_version()
Builder._find_master()
Builder._get_client()
Builder.client
Builder.client_args
Builder.config
Builder.connect()
Builder.is_master
Builder.master_only
Builder.other_args
Builder.test_connection()
Builder.update_config()
Builder.validate()
Builder.version_max
Builder.version_min
- Builder Attribute Errata
- Class Instantiation Flow
- Example Script
- Tutorial
- Tutorial 2: Advanced
- Environment Variables
- Default Values
- Helpers
- Exceptions
- Changelog
- 8.13.1 (10 April 2024)
- 8.13.0 (2 April 2024)
- 8.12.9 (26 March 2024)
- 8.12.8 (20 March 2024)
- 8.12.7 (20 March 2024)
- 8.12.6 (20 March 2024)
- 8.12.5 (4 February 2024)
- 8.12.4 (1 February 2024)
- 8.12.3 (31 January 2024)
- 8.12.2 (31 January 2024)
- 8.12.1 (31 January 2024)
- 8.12.0 (29 January 2024)
- 8.11.0 (15 November 2023)
- 8.10.3 (2 October 2023)
- 8.10.2 (2 October 2023)
- 8.10.1 (29 September 2023)
- 8.10.0 (25 September 2023)
- 8.9.0 (31 July 2023)
- 8.8.2.post1 (18 July 2023)
- 8.8.2 (12 July 2023)
- 8.7.0 (12 April 2023)
- 8.6.2.post1 (23 March 2023)
- 8.6.2 (19 February 2023)
- 8.6.1.post1 (30 January 2023)
- 8.6.1 (30 January 2023)
- 8.6.0.post6 (26 January 2023)
- 8.6.0.post5 (26 January 2023)
- 8.6.0.post4 (26 January 2023)
- 8.6.0.post3 (19 January 2023)
- 8.6.0.post2 (18 January 2023)
- 8.6.0.post1 (17 January 2023)
- 8.6.0+build.2 (17 January 2023)
- 8.6.0 (11 Janary 2023)
- 8.5.0 (11 January 2023)
- 8.1.0 (3 November 2022)
- 8.0.5 (28 October 2022)
- 8.0.4 (23 August 2022)
- 8.0.3 (23 August 2022)
- 8.0.2 (23 August 2022)
- 8.0.1 (23 August 2022)
- 8.0.0 (22 August 2022)
- 1.1.1 (19 April 2018)
- 1.1.0 (19 April 2018)
- 1.0.1 (12 April 2018)
- 1.0.0 (11 April 2018)