feat: support env #127
feat: support env #127
Conversation
NguyenHoangSon96
force-pushed
the
feat/support-env-variables
branch
from
26a9f36 to
0cd20ae
Compare
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #127 +/- ##
==========================================
+ Coverage 61.92% 62.80% +0.88%
==========================================
Files 33 33
Lines 2135 2194 +59
==========================================
+ Hits 1322 1378 +56
- Misses 813 816 +3 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
I think config from environment variables was already supported (see method
|
Hi Jan |
|
Hi @jansimonb |
NguyenHoangSon96
requested review from
jansimonb
and removed request for
jansimonb
There was a problem hiding this comment.
As for the V2 values in InfluxDBClient.from_env_properties() these are relics of the original copy and paste from the V2 client libraries roughly two years ago. Perhaps we should mark it as @deprecated
e.g.
@deprecated("Use up to date Env Properties")
@classmethod
def from_env_properties(cls, debug=None, enable_gzip=False, **kwargs):
influxdb_client_3/__init__.py
Outdated
| INFLUX_GZIP_THRESHOLD = "INFLUX_GZIP_THRESHOLD" | ||
|
|
||
|
|
||
| def from_env(**kwargs: Any) -> 'InfluxDBClient3': |
There was a problem hiding this comment.
This could be a @classmethod on InfluxDBClient3 See https://github.com/influxdata/influxdb-client-python/blob/74013566a9df3e41dc1ef67cda0cbd0f6b83c733/influxdb_client/client/influxdb_client.py#L180
Also since most of these options are passed to write_options maybe it would be cleaner to have a class method there as well. e.g.
class WriteOptions(object):
...
@classmethod
def from_envars(cls, debug=None, enable_gzip=False, **kwargs):
url = os.getenv('INFLUX_HOST', "http://localhost:8086")
...
There was a problem hiding this comment.
In from_env_properties (what we want to deprecate) there are 13 environment variables supported. In the new from_env we support 7 env variables. Does that mean that we are loosing some functionality? E.g. is it still possible to use the new from_env method but also configure connection_pool_maxsize?
influxdb_client_3/__init__.py
Outdated
| """ | ||
| Create an instance of `InfluxDBClient3` using environment variables for configuration. | ||
|
|
||
| This function retrieves and validates the following required environment variables: | ||
| - `INFLUX_HOST`: The hostname or IP address of the InfluxDB server. | ||
| - `INFLUX_TOKEN`: The authentication token used for accessing the server. | ||
| - `INFLUX_DATABASE`: The default database for the client operations. | ||
| And optional environment variable: | ||
| - `INFLUX_ORG`: The organization associated with InfluxDB operations. | ||
| Defaults to "default" if not set. | ||
|
|
||
| If any of the required environment variables are not set, a ValueError will be | ||
| raised with details about the missing variables. | ||
|
|
||
| :param kwargs: Additional keyword arguments that will be passed to the | ||
| `InfluxDBClient3` constructor for customization. This allows for | ||
| configuring specific client behaviors like write_client_options, | ||
| flight_client_options, SSL settings, etc. | ||
| :return: An initialized `InfluxDBClient3` instance. | ||
| :raises ValueError: If any required environment variables are not set. | ||
| """ |
There was a problem hiding this comment.
please keep updated the documentation, not all environment variables are documented (INFLUX_GZIP_THRESHOLD, INFLUX_PRECISION, ...)
Closes Issue
Proposed Changes
Checklist