U
vilE @ s d Z ddlmZ ddlZddlZddlmZmZmZm Z m
Z
m Z ddl m
Z
ddlmZ ddlmZ ddlmZ dd lmZ dd
lmZ dd lmZmZ dd lm Z dd
l m Z ddl m Z m!Z!m"Z" e#dZ$G dd de
Z%dS )zpInfluxDBClient is client for API defined in https://github.com/influxdata/influxdb/blob/master/http/swagger.yml. )absolute_importN) HealthCheck
HealthServiceReady ReadyService PingServiceInvokableScriptsApi) _BaseClientAuthorizationsApi
BucketsApi DeleteApi LabelsApiOrganizationsApi)QueryApi QueryOptionsTasksApiUsersApi)WriteApi WriteOptions
PointSettingsz&influxdb_client.client.influxdb_clientc sT e Zd ZdZd6eeedd fdd
Zdd Zd
d Ze d7ed
ddZ
e d8ddZ e e
fedddZe feedddZedddZdd Zd d Zedd d Zedd d!Zedd"d#Z e dd$d%Z e dd&d'Z e!dd(d)Z"e#dd*d+Z$e%dd,d-Z&edd.d/Z'edd0d1Z(e)dd2d3Z*e+dd4d5Z, Z-S )9InfluxDBClientz)InfluxDBClient is client for InfluxDB v2.N' F)tokenorg default_tagsreturnc
sN t jf |||||||dd| ddlm} | | j| j| j| jd| _dS )a6
Initialize defaults.
:param url: InfluxDB server API url (ex. http://localhost:8086).
:param token: ``token`` to authenticate to the InfluxDB API
:param debug: enable verbose logging of http requests
:param timeout: HTTP client timeout setting for a request specified in milliseconds.
If one number provided, it will be total request timeout.
It can also be a pair (tuple) of (connection, read) timeouts.
:param enable_gzip: Enable Gzip compression for http requests. Currently, only the "Write" and "Query" endpoints
supports the Gzip compression.
:param org: organization name (used as a default in Query, Write and Delete API)
:key bool verify_ssl: Set this to false to skip verifying SSL certificate when calling API from https server.
:key str ssl_ca_cert: Set this to customize the certificate file to verify the peer.
:key str cert_file: Path to the certificate that will be used for mTLS authentication.
:key str cert_key_file: Path to the file contains private key for mTLS certificate.
:key str cert_key_password: String or function which returns password for decrypting the mTLS private key.
:key ssl.SSLContext ssl_context: Specify a custom Python SSL Context for the TLS/ mTLS handshake.
Be aware that only delivered certificate/ key files or an SSL Context are
possible.
:key str proxy: Set this to configure the http proxy to be used (ex. http://localhost:3128)
:key str proxy_headers: A dictionary containing headers that will be sent to the proxy. Could be used for proxy
authentication.
:key int connection_pool_maxsize: Number of connections to save that can be reused by urllib3.
Defaults to "multiprocessing.cpu_count() * 5".
:key urllib3.util.retry.Retry retries: Set the default retry strategy that is used for all HTTP requests
except batching writes. As a default there is no one retry strategy.
:key bool auth_basic: Set this to true to enable basic authentication when talking to a InfluxDB 1.8.x that
does not use auth-enabled but is protected by a reverse proxy with basic authentication.
(defaults to false, don't set to true when talking to InfluxDB 2)
:key str username: ``username`` to authenticate via username and password credentials to the InfluxDB 2.x
:key str password: ``password`` to authenticate via username and password credentials to the InfluxDB 2.x
:key list[str] profilers: list of enabled Flux profilers
urllib3)urlr debugtimeout enable_gzipr r! Zhttp_client_logger ) ApiClient)
configuration header_name header_valueretriesN) super__init__Z_sync.api_clientr) confZauth_header_nameZauth_header_valuer-
api_client)
selfr$ r r% r& r' r r! kwargsr) __class__ W/opt/alt/python38/lib/python3.8/site-packages/influxdb_client/client/influxdb_client.pyr/ s $
zInfluxDBClient.__init__c C s | S )u
Enter the runtime context related to this object.
It will bind this method’s return value to the target(s)
specified in the `as` clause of the statement.
return: self instance
r6 r2 r6 r6 r7 __enter__F s zInfluxDBClient.__enter__c C s | dS )zEExit the runtime context related to this object and close the client.N)close)r2 exc_type exc_value tracebackr6 r6 r7 __exit__Q s zInfluxDBClient.__exit__
config.ini) config_filec K s t jf |||d|S )a
Configure client via configuration file. The configuration has to be under 'influx' section.
:param config_file: Path to configuration file
:param debug: Enable verbose logging of http requests
:param enable_gzip: Enable Gzip compression for http requests. Currently, only the "Write" and "Query" endpoints
supports the Gzip compression.
:key config_name: Name of the configuration section of the configuration file
:key str proxy_headers: A dictionary containing headers that will be sent to the proxy. Could be used for proxy
authentication.
:key urllib3.util.retry.Retry retries: Set the default retry strategy that is used for all HTTP requests
except batching writes. As a default there is no one retry strategy.
:key ssl.SSLContext ssl_context: Specify a custom Python SSL Context for the TLS/ mTLS handshake.
Be aware that only delivered certificate/ key files or an SSL Context are
possible.
The supported formats:
- https://docs.python.org/3/library/configparser.html
- https://toml.io/en/
- https://www.json.org/json-en.html
Configuration options:
- url
- org
- token
- timeout,
- verify_ssl
- ssl_ca_cert
- cert_file
- cert_key_file
- cert_key_password
- connection_pool_maxsize
- auth_basic
- profilers
- proxy
config.ini example::
[influx2]
url=http://localhost:8086
org=my-org
token=my-token
timeout=6000
connection_pool_maxsize=25
auth_basic=false
profilers=query,operator
proxy=http:proxy.domain.org:8080
[tags]
id = 132-987-655
customer = California Miner
data_center = ${env.data_center}
config.toml example::
[influx2]
url = "http://localhost:8086"
token = "my-token"
org = "my-org"
timeout = 6000
connection_pool_maxsize = 25
auth_basic = false
profilers="query, operator"
proxy = "http://proxy.domain.org:8080"
[tags]
id = "132-987-655"
customer = "California Miner"
data_center = "${env.data_center}"
config.json example::
{
"url": "http://localhost:8086",
"token": "my-token",
"org": "my-org",
"active": true,
"timeout": 6000,
"connection_pool_maxsize": 55,
"auth_basic": false,
"profilers": "query, operator",
"tags": {
"id": "132-987-655",
"customer": "California Miner",
"data_center": "${env.data_center}"
}
}
)r@ r% r' )r Z_from_config_file)clsr@ r% r' r3 r6 r6 r7 from_config_fileU s \z InfluxDBClient.from_config_filec K s t jf ||d|S )a7
Configure client via environment properties.
:param debug: Enable verbose logging of http requests
:param enable_gzip: Enable Gzip compression for http requests. Currently, only the "Write" and "Query" endpoints
supports the Gzip compression.
:key str proxy: Set this to configure the http proxy to be used (ex. http://localhost:3128)
:key str proxy_headers: A dictionary containing headers that will be sent to the proxy. Could be used for proxy
authentication.
:key urllib3.util.retry.Retry retries: Set the default retry strategy that is used for all HTTP requests
except batching writes. As a default there is no one retry strategy.
:key ssl.SSLContext ssl_context: Specify a custom Python SSL Context for the TLS/ mTLS handshake.
Be aware that only delivered certificate/ key files or an SSL Context are
possible.
Supported environment properties:
- INFLUXDB_V2_URL
- INFLUXDB_V2_ORG
- INFLUXDB_V2_TOKEN
- INFLUXDB_V2_TIMEOUT
- INFLUXDB_V2_VERIFY_SSL
- INFLUXDB_V2_SSL_CA_CERT
- INFLUXDB_V2_CERT_FILE
- INFLUXDB_V2_CERT_KEY_FILE
- INFLUXDB_V2_CERT_KEY_PASSWORD
- INFLUXDB_V2_CONNECTION_POOL_MAXSIZE
- INFLUXDB_V2_AUTH_BASIC
- INFLUXDB_V2_PROFILERS
- INFLUXDB_V2_TAG
)r% r' )r Z_from_env_properties)rA r% r' r3 r6 r6 r7 from_env_properties s z"InfluxDBClient.from_env_properties)r" c K s t f | ||d|S )a
Create Write API instance.
Example:
.. code-block:: python
from influxdb_client import InfluxDBClient
from influxdb_client.client.write_api import SYNCHRONOUS
# Initialize SYNCHRONOUS instance of WriteApi
with InfluxDBClient(url="http://localhost:8086", token="my-token", org="my-org") as client:
write_api = client.write_api(write_options=SYNCHRONOUS)
If you would like to use a **background batching**, you have to configure client like this:
.. code-block:: python
from influxdb_client import InfluxDBClient
# Initialize background batching instance of WriteApi
with InfluxDBClient(url="http://localhost:8086", token="my-token", org="my-org") as client:
with client.write_api() as write_api:
pass
There is also possibility to use callbacks to notify about state of background batches:
.. code-block:: python
from influxdb_client import InfluxDBClient
from influxdb_client.client.exceptions import InfluxDBError
class BatchingCallback(object):
def success(self, conf: (str, str, str), data: str):
print(f"Written batch: {conf}, data: {data}")
def error(self, conf: (str, str, str), data: str, exception: InfluxDBError):
print(f"Cannot write batch: {conf}, data: {data} due: {exception}")
def retry(self, conf: (str, str, str), data: str, exception: InfluxDBError):
print(f"Retryable error occurs for batch: {conf}, data: {data} retry: {exception}")
with InfluxDBClient(url="http://localhost:8086", token="my-token", org="my-org") as client:
callback = BatchingCallback()
with client.write_api(success_callback=callback.success,
error_callback=callback.error,
retry_callback=callback.retry) as write_api:
pass
:param write_options: Write API configuration
:param point_settings: settings to store default tags
:key success_callback: The callable ``callback`` to run after having successfully written a batch.
The callable must accept two arguments:
- `Tuple`: ``(bucket, organization, precision)``
- `str`: written data
**[batching mode]**
:key error_callback: The callable ``callback`` to run after having unsuccessfully written a batch.
The callable must accept three arguments:
- `Tuple`: ``(bucket, organization, precision)``
- `str`: written data
- `Exception`: an occurred error
**[batching mode]**
:key retry_callback: The callable ``callback`` to run after retryable error occurred.
The callable must accept three arguments:
- `Tuple`: ``(bucket, organization, precision)``
- `str`: written data
- `Exception`: an retryable error
**[batching mode]**
:return: write api instance
)influxdb_client
write_optionspoint_settings)r )r2 rE rF r3 r6 r6 r7 write_api s QzInfluxDBClient.write_api)
query_optionsr" c C s
t | |S )z
Create an Query API instance.
:param query_options: optional query api configuration
:return: Query api instance
)r )r2 rH r6 r6 r7 query_api( s zInfluxDBClient.query_apic C s t | S )zj
Create an InvokableScripts API instance.
:return: InvokableScripts API instance
)r r8 r6 r6 r7 invokable_scripts_api1 s z$InfluxDBClient.invokable_scripts_apic C s | dS zShutdown the client.N)__del__r8 r6 r6 r7 r: 9 s zInfluxDBClient.closec C s | j r| j d| _ dS rK )r1 rL r8 r6 r6 r7 rL = s
zInfluxDBClient.__del__c C s t | S )zO
Create the Bucket API instance.
:return: buckets api
r r8 r6 r6 r7 buckets_apiC s zInfluxDBClient.buckets_apic C s t | S )z^
Create the Authorizations API instance.
:return: authorizations api
r
r8 r6 r6 r7 authorizations_apiK s z!InfluxDBClient.authorizations_apic C s t | S )zL
Create the Users API instance.
:return: users api
r r8 r6 r6 r7 users_apiS s zInfluxDBClient.users_apic C s t | S )z\
Create the Organizations API instance.
:return: organizations api
r r8 r6 r6 r7 organizations_api[ s z InfluxDBClient.organizations_apic C s t | S )zL
Create the Tasks API instance.
:return: tasks api
r r8 r6 r6 r7 tasks_apic s zInfluxDBClient.tasks_apic C s t | S )zN
Create the Labels API instance.
:return: labels api
r r8 r6 r6 r7
labels_apik s zInfluxDBClient.labels_apic
C sb t dt t| j}z| }|W S tk
r\ } ztdt|dd W Y S d}~X Y nX dS )zN
Get the health of an instance.
:return: HealthCheck
z1This method is deprecated. Call 'ping()' instead.ZinfluxdbZfail)namemessagestatusN) warningswarnDeprecationWarningr r1 Z
get_health Exceptionr str)r2 Zhealth_servicehealther6 r6 r7 r[ s s
zInfluxDBClient.healthc
C sR t | j}z| W dS tk
rL } ztd| W Y dS d}~X Y nX dS )zc
Return the status of InfluxDB instance.
:return: The status of InfluxDB.
Tz!Unexpected error during /ping: %sFN)r r1 Zget_pingrY loggerr% )r2 ping_serviceexr6 r6 r7 ping s
zInfluxDBClient.pingc C s t | j}|jdd}||S )zq
Return the version of the connected InfluxDB Server.
:return: The version of InfluxDB.
F)Z_return_http_data_only)r r1 Zget_ping_with_http_infoZresponse_header)r2 r^ responser6 r6 r7 version s
zInfluxDBClient.versionc C s t | j}| S )zw
Return the build type of the connected InfluxDB Server.
:return: The type of InfluxDB build.
)r r1 Z
build_type)r2 r^ r6 r6 r7 build s
zInfluxDBClient.buildc C s t | j}| S )zP
Get The readiness of the InfluxDB 2.0.
:return: Ready
)r r1 Z get_ready)r2 Z
ready_servicer6 r6 r7 ready s
zInfluxDBClient.readyc C s t | S )zS
Get the delete metrics API instance.
:return: delete api
r r8 r6 r6 r7
delete_api s zInfluxDBClient.delete_api)NNr FNN)r? NF)NF).__name__
__module__ __qualname____doc__rZ dictr/ r9 r> classmethodrB rC r r r rG r r rI r rJ r: rL r
rM r rN r rO r rP r rQ r rR r r[ boolr` rb rc r rd r re
__classcell__r6 r6 r4 r7 r s< + ] !S
r )&ri
__future__r loggingrV rD r r r r r r Z influxdb_client.client._baser Z)influxdb_client.client.authorizations_apir Z!influxdb_client.client.bucket_apir
Z!influxdb_client.client.delete_apir Z!influxdb_client.client.labels_apir Z(influxdb_client.client.organizations_apir Z influxdb_client.client.query_apir r Z influxdb_client.client.tasks_apir Z influxdb_client.client.users_apir Z influxdb_client.client.write_apir r r getLoggerr] r r6 r6 r6 r7 s