https://github.com/imiphp/imi-influxdb

Last synced: 9 months ago
JSON representation
Host: GitHub
URL: https://github.com/imiphp/imi-influxdb
Owner: imiphp
License: other
Created: 2022-10-26T08:00:53.000Z (over 3 years ago)
Default Branch: 2.1
Last Pushed: 2022-10-28T06:59:23.000Z (over 3 years ago)
Last Synced: 2024-05-23T01:31:15.241Z (about 2 years ago)
Language: PHP
Size: 28.3 KB
Stars: 2
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project

README

          # imi-influxdb

[![Latest Version](https://img.shields.io/packagist/v/imiphp/imi-influxdb.svg)](https://packagist.org/packages/imiphp/imi-influxdb)

[![Php Version](https://img.shields.io/badge/php-%3E=7.4-brightgreen.svg)](https://secure.php.net/)

[![Swoole Version](https://img.shields.io/badge/swoole-%3E=4.8.0-brightgreen.svg)](https://github.com/swoole/swoole-src)

[![imi License](https://img.shields.io/badge/license-MulanPSL%202.0-brightgreen.svg)](https://github.com/imiphp/imi-influxdb/blob/2.1/LICENSE)

## 介绍

此项目是 imi 框架的 InfluxDB 组件。

自动引入 `yurunsoft/influxdb-orm`，可以直接使用该 ORM 功能。

**支持的功能：**

* InfluxDB 连接管理

* [influxdb-orm](https://github.com/Yurunsoft/influxdb-orm)

* 服务指标监控

> 正在开发中，随时可能修改，请勿用于生产环境！

## 安装

`composer require imiphp/imi-influxdb:~2.1.0`

## 使用说明

### InfluxDB 连接管理

#### 配置连接

`config.php`：

```php

[

    'influxDB'  => [

        'clients'   => [

            // default 是连接名称，可以随意更改

            'default'   => [

                'host'              => '127.0.0.1', // 主机名

                'port'              => 8086, // 端口

                'username'          => '', // 用户名

                'password'          => '', // 密码

                'defaultDatabase'   => '', // 默认数据库名

                'ssl'               => false, // 是否启用 SSL

                'verifySSL'         => false, // 是否验证 SSL 证书

                'timeout'           => 0, // 超时时间

                'connectTimeout'    => 0, // 连接超时时间

                'path'              =>'/', // 请求路径前缀

                'createDatabase'    => true, // 当数据库不存在时，自动创建数据库

            ],

        ],

        'default'   => 'default', // 默认连接名

    ],

]

```

#### 获取客户端对象

```php

use Imi\InfluxDB\InfluxDB;

$client = InfluxDB::getClient(); // 获取默认客户端

$client = InfluxDB::getClient('default'); // 获取指定名称客户端

```

#### 获取数据库对象

```php

use Imi\InfluxDB\InfluxDB;

$db = InfluxDB::getDatabase(); // 获取默认数据库名的对象

$db = InfluxDB::getDatabase('dbname'); // 获取指定数据库名的对象

$db = InfluxDB::getDatabase(null, 'default'); // 指定客户端名称

```

#### 使用数据库对象

```php

$db = InfluxDB::getDatabase();

$db->query(); // SQL 查询

$db->writePoints(); // 写入数据

```

> 详细用法请参考：

#### InfluxDB ORM

详细用法请参考：

#### SQL 查询

#### 写入

### 服务指标监控

仅支持 Swoole、Workerman。

支持 TDengine InfluxDB 协议写入。

#### 安装所需组件

`composer require imiphp/imi-meter:~2.1.0`

#### 配置

**配置监控指标：**

`@app.beans`：

```php

[

    'MeterRegistry' => [

        'driver'  => \Imi\InfluxDB\Meter\InfluxDBMeterRegistry::class,

        'options' => [

            'database'   => null, // 使用的数据库名，可以设为null使用连接中配置的数据库名

            'clientName' => null, // 连接客户端名称，可以设为null使用默认客户端名称

            'batch'      => 1000, // 单次推送的记录数量

            'interval'   => 0, // 推送时间周期，单位：秒，默认为0不启用推送，如希望监控生效，请设置一个合理的数值。

            // 所有标签如设为空字符串或 null 则忽略该标签

            'resultTag' => 'result', // 标签名-结果

            'exceptionTag' => 'exception', // 标签名-异常类名

            'instanceTag' => 'instance', // 标签名-实例

            'workerTag' => 'worker', // 标签名-WorkerId

            'instance' => 'imi', // 当前实例名称，每个实例要设置不同

        ],

    ],

]

```

**TDengine InfluxDB 所需修改的配置：**

```php

// 连接配置一定要设置这几项

[

    'port'              => 6041,

    'path'              => '/influxdb/v1/',

    'createDatabase'    => false,

    'username'          => 'root',

    'password'          => 'taosdata',

]

```

#### 使用

##### 注解

###### @Counted

类名：`\Imi\Meter\Annotation\Counted`

计数统计，适合只累加，不减少的统计数据类型。

例如：访问次数统计。

| 参数名 | 类型 | 默认值  | 描述 |

| ------ | ------ | ------ | ------ |

| name | `string` | `imi.counted` | 指标名称 |

| recordFailuresOnly | `false` | `bool` | 是否只在抛出异常时记录 |

| tags | `array` | `[]` | 标签，键值数组 |

| description | `string` |  | 描述 |

| options | `array` | `[]` | 额外参数，每个驱动不同 |

###### @Gauged

类名：`\Imi\Meter\Annotation\Gauged`

适合数字有上下波动的统计。

例如：CPU 占用率统计。

| 参数名 | 类型 | 默认值  | 描述 |

| ------ | ------ | ------ | ------ |

| name | `string` | `imi.counted` | 指标名称 |

| recordFailuresOnly | `false` | `bool` | 是否只在抛出异常时记录 |

| tags | `array` | `[]` | 标签，键值数组 |

| description | `string` |  | 描述 |

| value | `string\|float` | `{returnValue}` | 写入的值；`{returnValue}` 表示方法返回值；`{returnValue.xxx}` 表示方法返回值的属性值；`{params.0}` 表示方法参数值；`{params.0.xxx}` 表示方法参数值的属性值；也可以是固定的 `float` 值 |

| operation | `int` | `\Imi\Meter\Enum\GaugeOperation::SET` | 操作类型。设置`GaugeOperation::SET`；增加`GaugeOperation::INCREMENT`；减少`GaugeOperation::DECREMENT` |

| options | `array` | `[]` | 额外参数，每个驱动不同 |

###### @Timed

类名：`\Imi\Meter\Annotation\Timed`

耗时统计。

例如：方法执行耗时

| 参数名 | 类型 | 默认值  | 描述 |

| ------ | ------ | ------ | ------ |

| name | `string` | `imi.counted` | 指标名称 |

| tags | `array` | `[]` | 标签，键值数组 |

| description | `string` |  | 描述 |

| baseTimeUnit | `int` | `\Imi\Meter\Enum\TimeUnit::NANO_SECOND` | 基础时间单位，默认纳秒，可以使用 `\Imi\Meter\Enum\TimeUnit::XXX` 常量设置。 |

| options | `array` | `[]` | 额外参数，每个驱动不同 |

###### @Histogram

类名：`\Imi\Meter\Annotation\Histogram`

柱状图，一般人用不懂，如无特殊需求可以无视。

| 参数名 | 类型 | 默认值  | 描述 |

| ------ | ------ | ------ | ------ |

| name | `string` | `imi.counted` | 指标名称 |

| tags | `array` | `[]` | 标签，键值数组 |

| description | `string` |  | 描述 |

| buckets | `array` | `[]` | 桶，例如：`[100, 500, 1000]` |

| baseTimeUnit | `int` | `\Imi\Meter\Enum\TimeUnit::NANO_SECOND` | 基础时间单位，默认纳秒，可以使用 `\Imi\Meter\Enum\TimeUnit::XXX` 常量设置。 |

| value | `string\|float` | `{returnValue}` | 写入的值；`{returnValue}` 表示方法返回值；`{returnValue.xxx}` 表示方法返回值的属性值；`{params.0}` 表示方法参数值；`{params.0.xxx}` 表示方法参数值的属性值；也可以是固定的 `float` 值 |

| options | `array` | `[]` | 额外参数，每个驱动不同 |

###### @Summary

类名：`\Imi\Meter\Annotation\Summary`

采样点分位图，一般人用不懂，如无特殊需求可以无视。

| 参数名 | 类型 | 默认值  | 描述 |

| ------ | ------ | ------ | ------ |

| name | `string` | `imi.counted` | 指标名称 |

| tags | `array` | `[]` | 标签，键值数组 |

| description | `string` |  | 描述 |

| percentile | `array` | `[]` | 百分位数，例如：`[0.01, 0.5, 0.99]` |

| baseTimeUnit | `int` | `\Imi\Meter\Enum\TimeUnit::NANO_SECOND` | 基础时间单位，默认纳秒，可以使用 `\Imi\Meter\Enum\TimeUnit::XXX` 常量设置。 |

| value | `string\|float` | `{returnValue}` | 写入的值；`{returnValue}` 表示方法返回值；`{returnValue.xxx}` 表示方法返回值的属性值；`{params.0}` 表示方法参数值；`{params.0.xxx}` 表示方法参数值的属性值；也可以是固定的 `float` 值 |

| options | `array` | `[]` | 额外参数，每个驱动不同 |

**代码示例：**

```php

use Imi\Meter\Annotation\Gauged;

use Imi\Meter\Annotation\Histogram;

use Imi\Meter\Annotation\Summary;

use Imi\Meter\Annotation\Timed;

use Imi\Meter\Enum\TimeUnit;

/**

 * @Gauged(name="test_memory_usage", description="memory usage", tags={"workerId"="{returnValue.workerId}"}, value="{returnValue.memory}")

 */

public function recordMemoryUsage(): array

{

    return [

        'workerId' => Worker::getWorkerId(),

        'memory'   => memory_get_usage(),

    ];

}

/**

 * @Timed(name="test_timed", description="memory usage", baseTimeUnit=TimeUnit::MILLI_SECONDS)

 */

public function testTimed(): int

{

    $ms = mt_rand(10, 1000);

    usleep($ms * 1000);

    return $ms;

}

/**

 * @Timed(name="test_timed_histogram", description="memory usage", baseTimeUnit=TimeUnit::MILLI_SECONDS, options={"histogram"=true})

 */

public function testTimedHistogram(): int

{

    $ms = mt_rand(10, 1000);

    usleep($ms * 1000);

    return $ms;

}

/**

 * @Histogram(name="test_histogram", baseTimeUnit=TimeUnit::MILLI_SECONDS)

 */

public function testHistogram(): int

{

    return mt_rand(10, 1000);

}

/**

 * @Summary(name="test_summary", baseTimeUnit=TimeUnit::MILLI_SECONDS)

 */

public function testSummary(): int

{

    return mt_rand(10, 1000);

}

```

##### 手动操作

```php

use \Imi\Meter\Facade\MeterRegistry;

use \Imi\Meter\Enum\TimeUnit;

$description = '我是描述';

$tags = ['result' => 'success'];

// counter

MeterRegistry::getDriverInstance()->counter('testCounterManual', $tags, $description)->increment();

// gauge

MeterRegistry::getDriverInstance()->gauge('testGaugeManual', $tags, $description)->record(114514);

// timer

$timer = MeterRegistry::getDriverInstance()->timer('testTimedManual', $tags, $description, TimeUnit::MILLI_SECONDS);

$timerSample = $timer->start();

usleep(mt_rand(10, 1000) * 1000);

$timerSample->stop($timer);

// timer Histogram

$timer = MeterRegistry::getDriverInstance()->timer('testTimedHistogramManual', $tags, $description, TimeUnit::MILLI_SECONDS, [

    'histogram' => true,

]);

$timerSample = $timer->start();

usleep(mt_rand(10, 1000) * 1000); // 你的耗时代码

$timerSample->stop($timer);

// Histogram

$value = 114514;

MeterRegistry::getDriverInstance()->histogram('testHistogramManual', $tags, $description)->record($value);

// Summary

$value = 114514;

MeterRegistry::getDriverInstance()->summary('testHistogramManual', $tags, $description)->record($value);

```

## 免费技术支持

QQ群：17916227 [![点击加群](https://pub.idqqimg.com/wpa/images/group.png "点击加群")](https://jq.qq.com/?_wv=1027&k=5wXf4Zq)，如有问题会有人解答和修复。

## 运行环境

* [PHP](https://php.net/) >= 7.4

* [Composer](https://getcomposer.org/) >= 2.0

* [Swoole](https://www.swoole.com/) >= 4.8.0

* [imi](https://www.imiphp.com/) >= 2.1

## 版权信息

`imi-influxdb` 遵循 MulanPSL-2.0 开源协议发布，并提供免费使用。

## 捐赠



开源不求盈利，多少都是心意，生活不易，随缘随缘……
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/imiphp/imi-influxdb

Awesome Lists containing this project

README
