version 1.5

2024-01-11 14:04:25 +01:00
parent 0ee8291846
commit 4492763b78
756 changed files with 209957 additions and 2 deletions
@@ -0,0 +1,172 @@
+<?php
+
+namespace InfluxDB2;
+
+/**
+ * Write time series data into InfluxDB.
+ * @package InfluxDB2
+ */
+class WriteApi extends DefaultApi implements Writer
+{
+    public $writeOptions;
+    public $pointSettings;
+
+    /** @var Worker */
+    private $worker;
+    public $closed = false;
+
+    /**
+     * WriteApi constructor.
+     * @param $options
+     * @param array|null $writeOptions
+     * @param array|null $pointSettings
+     */
+    public function __construct($options, array $writeOptions = null, array $pointSettings = null)
+    {
+        parent::__construct($options);
+        $this->writeOptions = new WriteOptions($writeOptions) ?: new WriteOptions();
+        $this->pointSettings = new PointSettings($pointSettings) ?: new PointSettings();
+
+        if (array_key_exists('tags', $options)) {
+            foreach (array_keys($options['tags']) as $key) {
+                $this->pointSettings->addDefaultTag($key, $options['tags'][$key]);
+            }
+        }
+    }
+
+    /**
+     * Write data into specified bucket
+     *
+     * Example write data in array
+     *      $writeApi->write([
+     *          ['name' => 'cpu','tags' => ['host' => 'server_nl', 'region' => 'us'],
+     *              'fields' => ['internal' => 5, 'external' => 6],
+     *              'time' => 1422568543702900257],
+     *          ['name' => 'gpu', 'fields' => ['value' => 0.9999]]],
+     *      WritePrecision::NS,
+     *      'my-bucket',
+     *      'my-org'
+     *      )
+     *
+     * Example write data in line protocol
+     *      $writeApi->write('h2o,location=west value=33i 15')
+     *
+     * Example write data using Point structure
+     *      $point = new Point("h2o).
+     *
+     *
+     * @param string|Point|array $data DataPoints to write into InfluxDB. The data could be represent by
+     * array, Point, string
+     * @param string|null $precision The precision for the unix timestamps within the body line-protocol @see \InfluxDB2\Model\WritePrecision
+     * @param string|null $bucket specifies the destination bucket for writes
+     * @param string|null $org specifies the destination organization for writes
+     * @throws ApiException
+     */
+    public function write($data, string $precision = null, string $bucket = null, string $org = null)
+    {
+        $precisionParam = $this->getOption("precision", $precision);
+        $bucketParam = $this->getOption("bucket", $bucket);
+        $orgParam = $this->getOption("org", $org);
+
+        $this->check("precision", $precisionParam);
+        $this->check("bucket", $bucketParam);
+        $this->check("org", $orgParam);
+
+        $this->addDefaultTags($data);
+
+        $payload = WritePayloadSerializer::generatePayload($data, $precisionParam, $bucketParam, $orgParam, $this->writeOptions->writeType);
+
+        if ($payload == null) {
+            return;
+        }
+
+        if (WriteType::BATCHING == $this->writeOptions->writeType) {
+            $this->worker()->push($payload);
+        } else {
+            $this->writeRaw($payload, $precisionParam, $bucketParam, $orgParam);
+        }
+    }
+
+    private function addDefaultTags(&$data)
+    {
+        $defaultTags = $this->pointSettings->getDefaultTags();
+
+        if (is_array($data)) {
+            if (array_key_exists('name', $data)) {
+                foreach (array_keys($defaultTags) as $key) {
+                    $data['tags'][$key] = PointSettings::getValue($defaultTags[$key]);
+                }
+            } else {
+                foreach ($data as &$item) {
+                    $this->addDefaultTags($item);
+                }
+            }
+        } elseif ($data instanceof Point) {
+            foreach (array_keys($defaultTags) as $key) {
+                $data->addTag($key, PointSettings::getValue($defaultTags[$key]));
+            }
+        }
+    }
+
+    /**
+     * Writes data using line protocol.
+     *
+     * @param string $data payload data as string (in line protocol format)
+     * @param string|null $precision The precision for the unix timestamps within the body line-protocol
+     * @param string|null $bucket specifies the destination bucket for writes
+     * @param string|null $org specifies the destination organization for writes
+     * @throws ApiException
+     *
+     * @see \InfluxDB2\Model\WritePrecision
+     */
+    public function writeRaw(string $data, string $precision = null, string $bucket = null, string $org = null)
+    {
+        $precisionParam = $this->getOption("precision", $precision);
+        $bucketParam = $this->getOption("bucket", $bucket);
+        $orgParam = $this->getOption("org", $org);
+
+        $this->check("precision", $precisionParam);
+        $this->check("bucket", $bucketParam);
+        $this->check("org", $orgParam);
+
+        $queryParams = ["org" => $orgParam, "bucket" => $bucketParam, "precision" => $precisionParam];
+
+        $retry = new WriteRetry(
+            $this->writeOptions->maxRetries,
+            $this->writeOptions->retryInterval,
+            $this->writeOptions->maxRetryDelay,
+            $this->writeOptions->exponentialBase,
+            $this->writeOptions->maxRetryTime,
+            $this->writeOptions->jitterInterval,
+            $this->options
+        );
+
+        $retry->retry(function () use ($data, $queryParams) {
+            $this->post($data, "/api/v2/write", $queryParams);
+        });
+    }
+    public function close()
+    {
+        $this->closed = true;
+
+        if (isset($this->worker)) {
+            $this->worker()->flush();
+        }
+
+        unset($this->worker);
+    }
+
+    private function worker(): Worker
+    {
+        if (!isset($this->worker)) {
+            $this->worker = new Worker($this);
+        }
+
+        return $this->worker;
+    }
+
+    private function getOption(string $optionName, string $precision = null): string
+    {
+        return isset($precision) ? $precision : $this->options["$optionName"];
+    }
+}