def setUp(self) -> None:
# https://github.com/gabrielfalcao/HTTPretty/issues/368
import warnings
warnings.filterwarnings("ignore",
category=ResourceWarning,
message="unclosed.*")
warnings.filterwarnings("ignore",
category=PendingDeprecationWarning,
message="isAlive*")
httpretty.enable()
httpretty.reset()
conf = influxdb_client.configuration.Configuration()
conf.host = "http://localhost"
conf.debug = False
self.influxdb_client = influxdb_client.client.InfluxDBClient(
url=conf.host, token="my-token")
# self._api_client = influxdb_client.ApiClient(configuration=conf, header_name="Authorization",
# header_value="Token my-token")
write_options = WriteOptions(batch_size=2,
flush_interval=5_000,
retry_interval=3_000)
self._write_client = WriteApi(influxdb_client=self.influxdb_client,
write_options=write_options)
def test_default_tags(self):
self._write_client.__del__()
self.id_tag = "132-987-655"
self.customer_tag = "California Miner"
self._write_client = WriteApi(influxdb_client=self.influxdb_client,
write_options=WriteOptions(batch_size=1),
point_settings=PointSettings(**{"id": self.id_tag,
"customer": self.customer_tag}))
httpretty.register_uri(httpretty.POST, uri="http://localhost/api/v2/write", status=204)
_point1 = {"measurement": "h2o_feet", "tags": {"location": "coyote_creek"},
"time": "2009-11-10T22:00:00Z", "fields": {"water_level": 1.0}}
_point_list = [_point1]
self._write_client.write("my-bucket", "my-org", _point_list)
time.sleep(1)
requests = httpretty.httpretty.latest_requests
self.assertEqual(1, len(requests))
request = str(requests[0].body)
self.assertNotEqual(-1, request.find('customer=California\\\\ Miner'))
self.assertNotEqual(-1, request.find('id=132-987-655'))
def write_thread(apiclient: WriteApi, measurement: str, tag_pair: tuple
or list, field_key: str) -> None:
line_data = "{},{}={} {}={}".format(measurement, *tag_pair, field_key,
uniform(1, 100))
apiclient.write(BUCKET, ORG, line_data)
print("data was sent : {}".format(line_data))
Timer(1.0, write_thread, args=args).start()
def test_jitter_interval(self):
self._write_client.__del__()
self._write_client = WriteApi(influxdb_client=self.influxdb_client,
write_options=WriteOptions(batch_size=2, flush_interval=5_000,
jitter_interval=3_000))
httpretty.register_uri(httpretty.POST, uri="http://localhost/api/v2/write", status=204)
self._write_client.write("my-bucket", "my-org",
["h2o_feet,location=coyote_creek level\\ water_level=1.0 1",
"h2o_feet,location=coyote_creek level\\ water_level=2.0 2"])
time.sleep(3)
self.assertEqual(1, len(httpretty.httpretty.latest_requests))
self._write_client.write("my-bucket", "my-org", "h2o_feet,location=coyote_creek level\\ water_level=3.0 3")
time.sleep(2)
self.assertEqual(1, len(httpretty.httpretty.latest_requests))
time.sleep(6)
self.assertEqual(2, len(httpretty.httpretty.latest_requests))
self.assertEqual("h2o_feet,location=coyote_creek level\\ water_level=3.0 3",
httpretty.httpretty.latest_requests[1].parsed_body)
def write_api(
self, write_options=WriteOptions(), point_settings=PointSettings()
) -> WriteApi:
"""
Create a Write API instance.
:param point_settings:
:param write_options: write api configuration
:return: write api instance
"""
#WriteApi 객체를 생성해서 리턴하는것임. 인자로 받는 write_options와 point_settings 모두 클래스네. 원형을 하나만 찾아보자!
"""
class WriteOptions(object):
def __init__(self, write_type: WriteType = WriteType.batching,
batch_size=1_000, flush_interval=1_000,
jitter_interval=0,
retry_interval=5_000,
max_retries=3,
max_retry_delay=180_000,
exponential_base=5,
write_scheduler=ThreadPoolScheduler(max_workers=1)) -> None:
self.write_type = write_type
self.batch_size = batch_size
self.flush_interval = flush_interval
self.jitter_interval = jitter_interval
self.retry_interval = retry_interval
self.max_retries = max_retries
self.max_retry_delay = max_retry_delay
self.exponential_base = exponential_base
self.write_scheduler = write_scheduler
"""
# 보면 위 객체는 그냥 값들만 담고있음. 그니까 어떻게보면 javascript식 객체생성을 하는 느낌이네.
return WriteApi(influxdb_client=self,
write_options=write_options,
point_settings=point_settings)
def write_api(self, write_options=WriteOptions()) -> WriteApi:
"""
Creates a Write API instance
:param write_options: write api configuration
:return: write api instance
"""
return WriteApi(influxdb_client=self, write_options=write_options)
def write_api(self, write_options=WriteOptions(), point_settings=PointSettings()) -> WriteApi:
"""
Create a Write API instance.
:param point_settings:
:param write_options: write api configuration
:return: write api instance
"""
return WriteApi(influxdb_client=self, write_options=write_options, point_settings=point_settings)
def test_to_low_flush_interval(self):
self._write_client.__del__()
self._write_client = WriteApi(influxdb_client=self.influxdb_client,
write_options=WriteOptions(
batch_size=8,
flush_interval=1,
jitter_interval=1000))
httpretty.register_uri(httpretty.POST,
uri="http://localhost/api/v2/write",
status=204)
for i in range(50):
val_one = float(i)
val_two = float(i) + 0.5
point_one = Point("OneMillis").tag("sensor", "sensor1").field(
"PSI", val_one).time(time=i)
point_two = Point("OneMillis").tag("sensor", "sensor2").field(
"PSI", val_two).time(time=i)
self._write_client.write("my-bucket", "my-org",
[point_one, point_two])
time.sleep(0.1)
self._write_client.__del__()
_requests = httpretty.httpretty.latest_requests
for _request in _requests:
body = _request.parsed_body
self.assertTrue(body,
msg="Parsed body should be not empty " +
str(_request))
httpretty.reset()
class BatchingWriteTest(BaseTest):
def setUp(self) -> None:
# https://github.com/gabrielfalcao/HTTPretty/issues/368
import warnings
warnings.filterwarnings("ignore", category=ResourceWarning, message="unclosed.*")
warnings.filterwarnings("ignore", category=PendingDeprecationWarning, message="isAlive*")
httpretty.enable()
httpretty.reset()
conf = influxdb_client.configuration.Configuration()
conf.host = "http://localhost"
conf.debug = False
self.influxdb_client = InfluxDBClient(url=conf.host, token="my-token")
write_options = WriteOptions(batch_size=2, flush_interval=5_000, retry_interval=3_000)
self._write_client = WriteApi(influxdb_client=self.influxdb_client, write_options=write_options)
def tearDown(self) -> None:
self._write_client.__del__()
httpretty.disable()
def test_batch_size(self):
httpretty.register_uri(httpretty.POST, uri="http://localhost/api/v2/write", status=204)
httpretty.register_uri(httpretty.POST, uri="http://localhost/api/v2/write", status=204)
self._write_client.write("my-bucket", "my-org",
["h2o_feet,location=coyote_creek level\\ water_level=1.0 1",
"h2o_feet,location=coyote_creek level\\ water_level=2.0 2",
"h2o_feet,location=coyote_creek level\\ water_level=3.0 3",
"h2o_feet,location=coyote_creek level\\ water_level=4.0 4"])
time.sleep(1)
_requests = httpretty.httpretty.latest_requests
self.assertEqual(2, len(_requests))
_request1 = "h2o_feet,location=coyote_creek level\\ water_level=1.0 1\n" \
"h2o_feet,location=coyote_creek level\\ water_level=2.0 2"
_request2 = "h2o_feet,location=coyote_creek level\\ water_level=3.0 3\n" \
"h2o_feet,location=coyote_creek level\\ water_level=4.0 4"
self.assertEqual(_request1, _requests[0].parsed_body)
self.assertEqual(_request2, _requests[1].parsed_body)
pass
def test_subscribe_wait(self):
httpretty.register_uri(httpretty.POST, uri="http://localhost/api/v2/write", status=204)
self._write_client.write("my-bucket", "my-org", "h2o_feet,location=coyote_creek level\\ water_level=1.0 1")
self._write_client.write("my-bucket", "my-org", "h2o_feet,location=coyote_creek level\\ water_level=2.0 2")
time.sleep(1)
_requests = httpretty.httpretty.latest_requests
self.assertEqual(1, len(_requests))
_request = "h2o_feet,location=coyote_creek level\\ water_level=1.0 1\n" \
"h2o_feet,location=coyote_creek level\\ water_level=2.0 2"
self.assertEqual(_request, _requests[0].parsed_body)
def test_batch_size_group_by(self):
httpretty.register_uri(httpretty.POST, uri="http://localhost/api/v2/write", status=204)
self._write_client.write("my-bucket", "my-org",
"h2o_feet,location=coyote_creek level\\ water_level=1.0 1")
self._write_client.write("my-bucket", "my-org",
"h2o_feet,location=coyote_creek level\\ water_level=2.0 2",
write_precision=WritePrecision.S)
self._write_client.write("my-bucket", "my-org-a",
"h2o_feet,location=coyote_creek level\\ water_level=3.0 3")
self._write_client.write("my-bucket", "my-org-a",
"h2o_feet,location=coyote_creek level\\ water_level=4.0 4")
self._write_client.write("my-bucket2", "my-org-a",
"h2o_feet,location=coyote_creek level\\ water_level=5.0 5")
self._write_client.write("my-bucket", "my-org-a",
"h2o_feet,location=coyote_creek level\\ water_level=6.0 6")
time.sleep(1)
_requests = httpretty.httpretty.latest_requests
self.assertEqual(5, len(_requests))
self.assertEqual("h2o_feet,location=coyote_creek level\\ water_level=1.0 1", _requests[0].parsed_body)
self.assertEqual("ns", _requests[0].querystring["precision"][0])
self.assertEqual("my-bucket", _requests[0].querystring["bucket"][0])
self.assertEqual("h2o_feet,location=coyote_creek level\\ water_level=2.0 2", _requests[1].parsed_body)
self.assertEqual("s", _requests[1].querystring["precision"][0])
self.assertEqual("my-bucket", _requests[1].querystring["bucket"][0])
self.assertEqual("h2o_feet,location=coyote_creek level\\ water_level=3.0 3\n"
"h2o_feet,location=coyote_creek level\\ water_level=4.0 4", _requests[2].parsed_body)
self.assertEqual("ns", _requests[2].querystring["precision"][0])
self.assertEqual("my-bucket", _requests[2].querystring["bucket"][0])
self.assertEqual("h2o_feet,location=coyote_creek level\\ water_level=5.0 5", _requests[3].parsed_body)
self.assertEqual("ns", _requests[3].querystring["precision"][0])
self.assertEqual("my-bucket2", _requests[3].querystring["bucket"][0])
self.assertEqual("h2o_feet,location=coyote_creek level\\ water_level=6.0 6", _requests[4].parsed_body)
self.assertEqual("ns", _requests[4].querystring["precision"][0])
self.assertEqual("my-bucket", _requests[4].querystring["bucket"][0])
pass
def test_flush_interval(self):
httpretty.register_uri(httpretty.POST, uri="http://localhost/api/v2/write", status=204)
self._write_client.write("my-bucket", "my-org",
["h2o_feet,location=coyote_creek level\\ water_level=1.0 1",
"h2o_feet,location=coyote_creek level\\ water_level=2.0 2"])
time.sleep(1)
self.assertEqual(1, len(httpretty.httpretty.latest_requests))
self._write_client.write("my-bucket", "my-org", "h2o_feet,location=coyote_creek level\\ water_level=3.0 3")
time.sleep(2)
self.assertEqual(1, len(httpretty.httpretty.latest_requests))
time.sleep(3)
self.assertEqual(2, len(httpretty.httpretty.latest_requests))
self.assertEqual("h2o_feet,location=coyote_creek level\\ water_level=3.0 3",
httpretty.httpretty.latest_requests[1].parsed_body)
def test_jitter_interval(self):
self._write_client.__del__()
self._write_client = WriteApi(influxdb_client=self.influxdb_client,
write_options=WriteOptions(batch_size=2, flush_interval=5_000,
jitter_interval=3_000))
httpretty.register_uri(httpretty.POST, uri="http://localhost/api/v2/write", status=204)
self._write_client.write("my-bucket", "my-org",
["h2o_feet,location=coyote_creek level\\ water_level=1.0 1",
"h2o_feet,location=coyote_creek level\\ water_level=2.0 2"])
time.sleep(3)
self.assertEqual(1, len(httpretty.httpretty.latest_requests))
self._write_client.write("my-bucket", "my-org", "h2o_feet,location=coyote_creek level\\ water_level=3.0 3")
time.sleep(2)
self.assertEqual(1, len(httpretty.httpretty.latest_requests))
time.sleep(6)
self.assertEqual(2, len(httpretty.httpretty.latest_requests))
self.assertEqual("h2o_feet,location=coyote_creek level\\ water_level=3.0 3",
httpretty.httpretty.latest_requests[1].parsed_body)
def test_retry_interval(self):
httpretty.register_uri(httpretty.POST, uri="http://localhost/api/v2/write", status=204)
httpretty.register_uri(httpretty.POST, uri="http://localhost/api/v2/write", status=429)
httpretty.register_uri(httpretty.POST, uri="http://localhost/api/v2/write", status=503)
self._write_client.write("my-bucket", "my-org",
["h2o_feet,location=coyote_creek level\\ water_level=1.0 1",
"h2o_feet,location=coyote_creek level\\ water_level=2.0 2"])
time.sleep(1)
self.assertEqual(1, len(httpretty.httpretty.latest_requests))
time.sleep(3)
self.assertEqual(2, len(httpretty.httpretty.latest_requests))
time.sleep(3)
self.assertEqual(3, len(httpretty.httpretty.latest_requests))
self.assertEqual("h2o_feet,location=coyote_creek level\\ water_level=1.0 1\n"
"h2o_feet,location=coyote_creek level\\ water_level=2.0 2",
httpretty.httpretty.latest_requests[0].parsed_body)
self.assertEqual("h2o_feet,location=coyote_creek level\\ water_level=1.0 1\n"
"h2o_feet,location=coyote_creek level\\ water_level=2.0 2",
httpretty.httpretty.latest_requests[1].parsed_body)
self.assertEqual("h2o_feet,location=coyote_creek level\\ water_level=1.0 1\n"
"h2o_feet,location=coyote_creek level\\ water_level=2.0 2",
httpretty.httpretty.latest_requests[2].parsed_body)
pass
def test_recover_from_error(self):
httpretty.register_uri(httpretty.POST, uri="http://localhost/api/v2/write", status=204)
httpretty.register_uri(httpretty.POST, uri="http://localhost/api/v2/write", status=400)
self._write_client.write("my-bucket", "my-org",
["h2o_feet,location=coyote_creek",
"h2o_feet,location=coyote_creek"])
self._write_client.write("my-bucket", "my-org",
["h2o_feet,location=coyote_creek level\\ water_level=1.0 1",
"h2o_feet,location=coyote_creek level\\ water_level=2.0 2"])
time.sleep(1)
_requests = httpretty.httpretty.latest_requests
self.assertEqual(2, len(_requests))
pass
def test_record_types(self):
httpretty.register_uri(httpretty.POST, uri="http://localhost/api/v2/write", status=204)
# Record item
_record = "h2o_feet,location=coyote_creek level\\ water_level=1.0 1"
self._write_client.write("my-bucket", "my-org", _record)
# Point item
_point = Point("h2o_feet").tag("location", "coyote_creek").field("level water_level", 2.0).time(2)
self._write_client.write("my-bucket", "my-org", _point)
# Record list
self._write_client.write("my-bucket", "my-org",
["h2o_feet,location=coyote_creek level\\ water_level=3.0 3",
"h2o_feet,location=coyote_creek level\\ water_level=4.0 4"])
# Point list
_point1 = Point("h2o_feet").tag("location", "coyote_creek").field("level water_level", 5.0).time(5)
_point2 = Point("h2o_feet").tag("location", "coyote_creek").field("level water_level", 6.0).time(6)
self._write_client.write("my-bucket", "my-org", [_point1, _point2])
# Observable
_recordObs = "h2o_feet,location=coyote_creek level\\ water_level=7.0 7"
_pointObs = Point("h2o_feet").tag("location", "coyote_creek").field("level water_level", 8.0).time(8)
self._write_client.write("my-bucket", "my-org", rx.of(_recordObs, _pointObs))
_data = rx \
.range(9, 13) \
.pipe(ops.map(lambda i: "h2o_feet,location=coyote_creek level\\ water_level={0}.0 {0}".format(i)))
self._write_client.write("my-bucket", "my-org", _data)
# Dictionary item
_dict = {"measurement": "h2o_feet", "tags": {"location": "coyote_creek"},
"time": 13, "fields": {"level water_level": 13.0}}
self._write_client.write("my-bucket", "my-org", _dict)
# Dictionary list
_dict1 = {"measurement": "h2o_feet", "tags": {"location": "coyote_creek"},
"time": 14, "fields": {"level water_level": 14.0}}
_dict2 = {"measurement": "h2o_feet", "tags": {"location": "coyote_creek"},
"time": 15, "fields": {"level water_level": 15.0}}
self._write_client.write("my-bucket", "my-org", [_dict1, _dict2])
# Bytes item
_bytes = "h2o_feet,location=coyote_creek level\\ water_level=16.0 16".encode("utf-8")
self._write_client.write("my-bucket", "my-org", _bytes)
# Bytes list
_bytes1 = "h2o_feet,location=coyote_creek level\\ water_level=17.0 17".encode("utf-8")
_bytes2 = "h2o_feet,location=coyote_creek level\\ water_level=18.0 18".encode("utf-8")
self._write_client.write("my-bucket", "my-org", [_bytes1, _bytes2])
time.sleep(1)
_requests = httpretty.httpretty.latest_requests
self.assertEqual(9, len(_requests))
self.assertEqual("h2o_feet,location=coyote_creek level\\ water_level=1.0 1\n"
"h2o_feet,location=coyote_creek level\\ water_level=2.0 2", _requests[0].parsed_body)
self.assertEqual("h2o_feet,location=coyote_creek level\\ water_level=3.0 3\n"
"h2o_feet,location=coyote_creek level\\ water_level=4.0 4", _requests[1].parsed_body)
self.assertEqual("h2o_feet,location=coyote_creek level\\ water_level=5.0 5\n"
"h2o_feet,location=coyote_creek level\\ water_level=6.0 6", _requests[2].parsed_body)
self.assertEqual("h2o_feet,location=coyote_creek level\\ water_level=7.0 7\n"
"h2o_feet,location=coyote_creek level\\ water_level=8.0 8", _requests[3].parsed_body)
self.assertEqual("h2o_feet,location=coyote_creek level\\ water_level=9.0 9\n"
"h2o_feet,location=coyote_creek level\\ water_level=10.0 10", _requests[4].parsed_body)
self.assertEqual("h2o_feet,location=coyote_creek level\\ water_level=11.0 11\n"
"h2o_feet,location=coyote_creek level\\ water_level=12.0 12", _requests[5].parsed_body)
self.assertEqual("h2o_feet,location=coyote_creek level\\ water_level=13.0 13\n"
"h2o_feet,location=coyote_creek level\\ water_level=14.0 14", _requests[6].parsed_body)
self.assertEqual("h2o_feet,location=coyote_creek level\\ water_level=15.0 15\n"
"h2o_feet,location=coyote_creek level\\ water_level=16.0 16", _requests[7].parsed_body)
self.assertEqual("h2o_feet,location=coyote_creek level\\ water_level=17.0 17\n"
"h2o_feet,location=coyote_creek level\\ water_level=18.0 18", _requests[8].parsed_body)
pass
def test_write_result(self):
httpretty.register_uri(httpretty.POST, uri="http://localhost/api/v2/write", status=204)
_record = "h2o_feet,location=coyote_creek level\\ water_level=1.0 1"
_result = self._write_client.write("my-bucket", "my-org", _record)
self.assertEqual(None, _result)
def test_del(self):
httpretty.register_uri(httpretty.POST, uri="http://localhost/api/v2/write", status=204)
_record = "h2o_feet,location=coyote_creek level\\ water_level=1.0 1"
_result = self._write_client.write("my-bucket", "my-org", _record)
self._write_client.__del__()
_requests = httpretty.httpretty.latest_requests
self.assertEqual(1, len(_requests))
self.assertEqual("h2o_feet,location=coyote_creek level\\ water_level=1.0 1", _requests[0].parsed_body)
class BatchingWriteTest(BaseTest):
def setUp(self) -> None:
# https://github.com/gabrielfalcao/HTTPretty/issues/368
import warnings
warnings.filterwarnings("ignore",
category=ResourceWarning,
message="unclosed.*")
warnings.filterwarnings("ignore",
category=PendingDeprecationWarning,
message="isAlive*")
httpretty.enable()
httpretty.reset()
conf = influxdb_client.configuration.Configuration()
conf.host = "http://localhost"
conf.debug = False
self.influxdb_client = InfluxDBClient(url=conf.host, token="my-token")
self.write_options = WriteOptions(batch_size=2,
flush_interval=5_000,
retry_interval=3_000)
self._write_client = WriteApi(influxdb_client=self.influxdb_client,
write_options=self.write_options)
def tearDown(self) -> None:
self._write_client.__del__()
httpretty.disable()
def test_batch_size(self):
httpretty.register_uri(httpretty.POST,
uri="http://localhost/api/v2/write",
status=204)
httpretty.register_uri(httpretty.POST,
uri="http://localhost/api/v2/write",
status=204)
self._write_client.write("my-bucket", "my-org", [
"h2o_feet,location=coyote_creek level\\ water_level=1.0 1",
"h2o_feet,location=coyote_creek level\\ water_level=2.0 2",
"h2o_feet,location=coyote_creek level\\ water_level=3.0 3",
"h2o_feet,location=coyote_creek level\\ water_level=4.0 4"
])
time.sleep(1)
_requests = httpretty.httpretty.latest_requests
self.assertEqual(2, len(_requests))
_request1 = "h2o_feet,location=coyote_creek level\\ water_level=1.0 1\n" \
"h2o_feet,location=coyote_creek level\\ water_level=2.0 2"
_request2 = "h2o_feet,location=coyote_creek level\\ water_level=3.0 3\n" \
"h2o_feet,location=coyote_creek level\\ water_level=4.0 4"
self.assertEqual(_request1, _requests[0].parsed_body)
self.assertEqual(_request2, _requests[1].parsed_body)
pass
def test_subscribe_wait(self):
httpretty.register_uri(httpretty.POST,
uri="http://localhost/api/v2/write",
status=204)
self._write_client.write(
"my-bucket", "my-org",
"h2o_feet,location=coyote_creek level\\ water_level=1.0 1")
self._write_client.write(
"my-bucket", "my-org",
"h2o_feet,location=coyote_creek level\\ water_level=2.0 2")
time.sleep(1)
_requests = httpretty.httpretty.latest_requests
self.assertEqual(1, len(_requests))
_request = "h2o_feet,location=coyote_creek level\\ water_level=1.0 1\n" \
"h2o_feet,location=coyote_creek level\\ water_level=2.0 2"
self.assertEqual(_request, _requests[0].parsed_body)
def test_batch_size_group_by(self):
httpretty.register_uri(httpretty.POST,
uri="http://localhost/api/v2/write",
status=204)
self._write_client.write(
"my-bucket", "my-org",
"h2o_feet,location=coyote_creek level\\ water_level=1.0 1")
self._write_client.write(
"my-bucket",
"my-org",
"h2o_feet,location=coyote_creek level\\ water_level=2.0 2",
write_precision=WritePrecision.S)
self._write_client.write(
"my-bucket", "my-org-a",
"h2o_feet,location=coyote_creek level\\ water_level=3.0 3")
self._write_client.write(
"my-bucket", "my-org-a",
"h2o_feet,location=coyote_creek level\\ water_level=4.0 4")
self._write_client.write(
"my-bucket2", "my-org-a",
"h2o_feet,location=coyote_creek level\\ water_level=5.0 5")
self._write_client.write(
"my-bucket", "my-org-a",
"h2o_feet,location=coyote_creek level\\ water_level=6.0 6")
time.sleep(1)
_requests = httpretty.httpretty.latest_requests
self.assertEqual(5, len(_requests))
self.assertEqual(
"h2o_feet,location=coyote_creek level\\ water_level=1.0 1",
_requests[0].parsed_body)
self.assertEqual("ns", _requests[0].querystring["precision"][0])
self.assertEqual("my-bucket", _requests[0].querystring["bucket"][0])
self.assertEqual(
"h2o_feet,location=coyote_creek level\\ water_level=2.0 2",
_requests[1].parsed_body)
self.assertEqual("s", _requests[1].querystring["precision"][0])
self.assertEqual("my-bucket", _requests[1].querystring["bucket"][0])
self.assertEqual(
"h2o_feet,location=coyote_creek level\\ water_level=3.0 3\n"
"h2o_feet,location=coyote_creek level\\ water_level=4.0 4",
_requests[2].parsed_body)
self.assertEqual("ns", _requests[2].querystring["precision"][0])
self.assertEqual("my-bucket", _requests[2].querystring["bucket"][0])
self.assertEqual(
"h2o_feet,location=coyote_creek level\\ water_level=5.0 5",
_requests[3].parsed_body)
self.assertEqual("ns", _requests[3].querystring["precision"][0])
self.assertEqual("my-bucket2", _requests[3].querystring["bucket"][0])
self.assertEqual(
"h2o_feet,location=coyote_creek level\\ water_level=6.0 6",
_requests[4].parsed_body)
self.assertEqual("ns", _requests[4].querystring["precision"][0])
self.assertEqual("my-bucket", _requests[4].querystring["bucket"][0])
pass
def test_flush_interval(self):
httpretty.register_uri(httpretty.POST,
uri="http://localhost/api/v2/write",
status=204)
self._write_client.write("my-bucket", "my-org", [
"h2o_feet,location=coyote_creek level\\ water_level=1.0 1",
"h2o_feet,location=coyote_creek level\\ water_level=2.0 2"
])
time.sleep(1)
self.assertEqual(1, len(httpretty.httpretty.latest_requests))
self._write_client.write(
"my-bucket", "my-org",
"h2o_feet,location=coyote_creek level\\ water_level=3.0 3")
time.sleep(2)
self.assertEqual(1, len(httpretty.httpretty.latest_requests))
time.sleep(3)
self.assertEqual(2, len(httpretty.httpretty.latest_requests))
self.assertEqual(
"h2o_feet,location=coyote_creek level\\ water_level=3.0 3",
httpretty.httpretty.latest_requests[1].parsed_body)
def test_jitter_interval(self):
self._write_client.__del__()
self._write_client = WriteApi(influxdb_client=self.influxdb_client,
write_options=WriteOptions(
batch_size=2,
flush_interval=5_000,
jitter_interval=3_000))
httpretty.register_uri(httpretty.POST,
uri="http://localhost/api/v2/write",
status=204)
self._write_client.write("my-bucket", "my-org", [
"h2o_feet,location=coyote_creek level\\ water_level=1.0 1",
"h2o_feet,location=coyote_creek level\\ water_level=2.0 2"
])
time.sleep(3)
self.assertEqual(1, len(httpretty.httpretty.latest_requests))
self._write_client.write(
"my-bucket", "my-org",
"h2o_feet,location=coyote_creek level\\ water_level=3.0 3")
time.sleep(2)
self.assertEqual(1, len(httpretty.httpretty.latest_requests))
time.sleep(6)
self.assertEqual(2, len(httpretty.httpretty.latest_requests))
self.assertEqual(
"h2o_feet,location=coyote_creek level\\ water_level=3.0 3",
httpretty.httpretty.latest_requests[1].parsed_body)
def test_retry_interval(self):
httpretty.register_uri(httpretty.POST,
uri="http://localhost/api/v2/write",
status=204)
httpretty.register_uri(httpretty.POST,
uri="http://localhost/api/v2/write",
status=429)
httpretty.register_uri(httpretty.POST,
uri="http://localhost/api/v2/write",
status=503)
self._write_client.write("my-bucket", "my-org", [
"h2o_feet,location=coyote_creek level\\ water_level=1.0 1",
"h2o_feet,location=coyote_creek level\\ water_level=2.0 2"
])
time.sleep(1)
self.assertEqual(1, len(httpretty.httpretty.latest_requests))
time.sleep(3)
self.assertEqual(2, len(httpretty.httpretty.latest_requests))
time.sleep(3)
self.assertEqual(3, len(httpretty.httpretty.latest_requests))
self.assertEqual(
"h2o_feet,location=coyote_creek level\\ water_level=1.0 1\n"
"h2o_feet,location=coyote_creek level\\ water_level=2.0 2",
httpretty.httpretty.latest_requests[0].parsed_body)
self.assertEqual(
"h2o_feet,location=coyote_creek level\\ water_level=1.0 1\n"
"h2o_feet,location=coyote_creek level\\ water_level=2.0 2",
httpretty.httpretty.latest_requests[1].parsed_body)
self.assertEqual(
"h2o_feet,location=coyote_creek level\\ water_level=1.0 1\n"
"h2o_feet,location=coyote_creek level\\ water_level=2.0 2",
httpretty.httpretty.latest_requests[2].parsed_body)
pass
def test_recover_from_error(self):
httpretty.register_uri(httpretty.POST,
uri="http://localhost/api/v2/write",
status=204)
httpretty.register_uri(httpretty.POST,
uri="http://localhost/api/v2/write",
status=400)
self._write_client.write("my-bucket", "my-org", [
"h2o_feet,location=coyote_creek", "h2o_feet,location=coyote_creek"
])
self._write_client.write("my-bucket", "my-org", [
"h2o_feet,location=coyote_creek level\\ water_level=1.0 1",
"h2o_feet,location=coyote_creek level\\ water_level=2.0 2"
])
time.sleep(1)
_requests = httpretty.httpretty.latest_requests
self.assertEqual(2, len(_requests))
pass
def test_record_types(self):
httpretty.register_uri(httpretty.POST,
uri="http://localhost/api/v2/write",
status=204)
# Record item
_record = "h2o_feet,location=coyote_creek level\\ water_level=1.0 1"
self._write_client.write("my-bucket", "my-org", _record)
# Point item
_point = Point("h2o_feet").tag("location", "coyote_creek").field(
"level water_level", 2.0).time(2)
self._write_client.write("my-bucket", "my-org", _point)
# Record list
self._write_client.write("my-bucket", "my-org", [
"h2o_feet,location=coyote_creek level\\ water_level=3.0 3",
"h2o_feet,location=coyote_creek level\\ water_level=4.0 4"
])
# Point list
_point1 = Point("h2o_feet").tag("location", "coyote_creek").field(
"level water_level", 5.0).time(5)
_point2 = Point("h2o_feet").tag("location", "coyote_creek").field(
"level water_level", 6.0).time(6)
self._write_client.write("my-bucket", "my-org", [_point1, _point2])
# Observable
_recordObs = "h2o_feet,location=coyote_creek level\\ water_level=7.0 7"
_pointObs = Point("h2o_feet").tag("location", "coyote_creek").field(
"level water_level", 8.0).time(8)
self._write_client.write("my-bucket", "my-org",
rx.of(_recordObs, _pointObs))
_data = rx \
.range(9, 13) \
.pipe(ops.map(lambda i: "h2o_feet,location=coyote_creek level\\ water_level={0}.0 {0}".format(i)))
self._write_client.write("my-bucket", "my-org", _data)
# Dictionary item
_dict = {
"measurement": "h2o_feet",
"tags": {
"location": "coyote_creek"
},
"time": 13,
"fields": {
"level water_level": 13.0
}
}
self._write_client.write("my-bucket", "my-org", _dict)
# Dictionary list
_dict1 = {
"measurement": "h2o_feet",
"tags": {
"location": "coyote_creek"
},
"time": 14,
"fields": {
"level water_level": 14.0
}
}
_dict2 = {
"measurement": "h2o_feet",
"tags": {
"location": "coyote_creek"
},
"time": 15,
"fields": {
"level water_level": 15.0
}
}
self._write_client.write("my-bucket", "my-org", [_dict1, _dict2])
# Bytes item
_bytes = "h2o_feet,location=coyote_creek level\\ water_level=16.0 16".encode(
"utf-8")
self._write_client.write("my-bucket", "my-org", _bytes)
# Bytes list
_bytes1 = "h2o_feet,location=coyote_creek level\\ water_level=17.0 17".encode(
"utf-8")
_bytes2 = "h2o_feet,location=coyote_creek level\\ water_level=18.0 18".encode(
"utf-8")
self._write_client.write("my-bucket", "my-org", [_bytes1, _bytes2])
time.sleep(1)
_requests = httpretty.httpretty.latest_requests
self.assertEqual(9, len(_requests))
self.assertEqual(
"h2o_feet,location=coyote_creek level\\ water_level=1.0 1\n"
"h2o_feet,location=coyote_creek level\\ water_level=2.0 2",
_requests[0].parsed_body)
self.assertEqual(
"h2o_feet,location=coyote_creek level\\ water_level=3.0 3\n"
"h2o_feet,location=coyote_creek level\\ water_level=4.0 4",
_requests[1].parsed_body)
self.assertEqual(
"h2o_feet,location=coyote_creek level\\ water_level=5.0 5\n"
"h2o_feet,location=coyote_creek level\\ water_level=6.0 6",
_requests[2].parsed_body)
self.assertEqual(
"h2o_feet,location=coyote_creek level\\ water_level=7.0 7\n"
"h2o_feet,location=coyote_creek level\\ water_level=8.0 8",
_requests[3].parsed_body)
self.assertEqual(
"h2o_feet,location=coyote_creek level\\ water_level=9.0 9\n"
"h2o_feet,location=coyote_creek level\\ water_level=10.0 10",
_requests[4].parsed_body)
self.assertEqual(
"h2o_feet,location=coyote_creek level\\ water_level=11.0 11\n"
"h2o_feet,location=coyote_creek level\\ water_level=12.0 12",
_requests[5].parsed_body)
self.assertEqual(
"h2o_feet,location=coyote_creek level\\ water_level=13.0 13\n"
"h2o_feet,location=coyote_creek level\\ water_level=14.0 14",
_requests[6].parsed_body)
self.assertEqual(
"h2o_feet,location=coyote_creek level\\ water_level=15.0 15\n"
"h2o_feet,location=coyote_creek level\\ water_level=16.0 16",
_requests[7].parsed_body)
self.assertEqual(
"h2o_feet,location=coyote_creek level\\ water_level=17.0 17\n"
"h2o_feet,location=coyote_creek level\\ water_level=18.0 18",
_requests[8].parsed_body)
pass
def test_write_result(self):
httpretty.register_uri(httpretty.POST,
uri="http://localhost/api/v2/write",
status=204)
_record = "h2o_feet,location=coyote_creek level\\ water_level=1.0 1"
_result = self._write_client.write("my-bucket", "my-org", _record)
self.assertEqual(None, _result)
def test_del(self):
httpretty.register_uri(httpretty.POST,
uri="http://localhost/api/v2/write",
status=204)
_record = "h2o_feet,location=coyote_creek level\\ water_level=1.0 1"
_result = self._write_client.write("my-bucket", "my-org", _record)
self._write_client.__del__()
_requests = httpretty.httpretty.latest_requests
self.assertEqual(1, len(_requests))
self.assertEqual(
"h2o_feet,location=coyote_creek level\\ water_level=1.0 1",
_requests[0].parsed_body)
def test_default_tags(self):
self._write_client.__del__()
self.id_tag = "132-987-655"
self.customer_tag = "California Miner"
self._write_client = WriteApi(
influxdb_client=self.influxdb_client,
write_options=WriteOptions(batch_size=1),
point_settings=PointSettings(**{
"id": self.id_tag,
"customer": self.customer_tag
}))
httpretty.register_uri(httpretty.POST,
uri="http://localhost/api/v2/write",
status=204)
_point1 = {
"measurement": "h2o_feet",
"tags": {
"location": "coyote_creek"
},
"time": "2009-11-10T22:00:00Z",
"fields": {
"water_level": 1.0
}
}
_point_list = [_point1]
self._write_client.write("my-bucket", "my-org", _point_list)
time.sleep(1)
requests = httpretty.httpretty.latest_requests
self.assertEqual(1, len(requests))
request = str(requests[0].body)
self.assertNotEqual(-1, request.find('customer=California\\\\ Miner'))
self.assertNotEqual(-1, request.find('id=132-987-655'))
def test_user_agent_header(self):
httpretty.register_uri(httpretty.POST,
uri="http://localhost/api/v2/write",
status=204)
self._write_client.write("my-bucket", "my-org", [
"h2o_feet,location=coyote_creek level\\ water_level=1.0 1",
"h2o_feet,location=coyote_creek level\\ water_level=2.0 2"
])
time.sleep(1)
requests = httpretty.httpretty.latest_requests
self.assertEqual(1, len(requests))
self.assertEqual(
f'influxdb-client-python/{influxdb_client.__version__}',
requests[0].headers['User-Agent'])
def test_to_low_flush_interval(self):
self._write_client.__del__()
self._write_client = WriteApi(influxdb_client=self.influxdb_client,
write_options=WriteOptions(
batch_size=8,
flush_interval=1,
jitter_interval=1000))
httpretty.register_uri(httpretty.POST,
uri="http://localhost/api/v2/write",
status=204)
for i in range(50):
val_one = float(i)
val_two = float(i) + 0.5
point_one = Point("OneMillis").tag("sensor", "sensor1").field(
"PSI", val_one).time(time=i)
point_two = Point("OneMillis").tag("sensor", "sensor2").field(
"PSI", val_two).time(time=i)
self._write_client.write("my-bucket", "my-org",
[point_one, point_two])
time.sleep(0.1)
self._write_client.__del__()
_requests = httpretty.httpretty.latest_requests
for _request in _requests:
body = _request.parsed_body
self.assertTrue(body,
msg="Parsed body should be not empty " +
str(_request))
httpretty.reset()
def test_batching_data_frame(self):
from influxdb_client.extras import pd
httpretty.register_uri(httpretty.POST,
uri="http://localhost/api/v2/write",
status=204)
httpretty.register_uri(httpretty.POST,
uri="http://localhost/api/v2/write",
status=204)
data_frame = pd.DataFrame(data=[["coyote_creek", 1.0],
["coyote_creek", 2.0],
["coyote_creek", 3.0],
["coyote_creek", 4.0]],
index=[1, 2, 3, 4],
columns=["location", "level water_level"])
self._write_client.write("my-bucket",
"my-org",
record=data_frame,
data_frame_measurement_name='h2o_feet',
data_frame_tag_columns=['location'])
time.sleep(1)
_requests = httpretty.httpretty.latest_requests
self.assertEqual(2, len(_requests))
_request1 = "h2o_feet,location=coyote_creek level\\ water_level=1.0 1\n" \
"h2o_feet,location=coyote_creek level\\ water_level=2.0 2"
_request2 = "h2o_feet,location=coyote_creek level\\ water_level=3.0 3\n" \
"h2o_feet,location=coyote_creek level\\ water_level=4.0 4"
self.assertEqual(_request1, _requests[0].parsed_body)
self.assertEqual(_request2, _requests[1].parsed_body)
def write_thread(rg: RandomGenrator, write_api: WriteApi, bucket, org) -> None:
while True:
write_api.write(bucket, org, rg.get_random_point())
print("data was sent!")
sleep(1)
def write_api(self,
write_options=WriteOptions(),
point_settings=PointSettings(),
**kwargs) -> WriteApi:
"""
Create a 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 successfully writen 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 unsuccessfully writen 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
"""
return WriteApi(influxdb_client=self,
write_options=write_options,
point_settings=point_settings,
**kwargs)
