4apps/api-stats-php

用于Api统计门户的PHP库

dev-main 2022-04-22 11:25 UTC

This package is auto-updated.

Last update: 2024-09-22 05:14:54 UTC


README

安装/使用

通过composer安装: composer require 4apps/api-stats-php

使用示例(适用于php 8.1+)

use 4Apps\ApiStats;

$mongoDbConfig = [
    'string' => 'mongodb://mongodb:27017',
    'dbname' => 'apiStatistics'
];
$apiStats = ApiStats($mongoDbConfig);

// Create event
$eventId = $apiStats->logApiStatistics($scope, $service, $contextName, $methodName, $endpointUrl);

// Failed
$apiStats->updateApiStatistics($eventId, failed: true);

// Retry
$seconds = 60; // Retry timeout
$apiStats->updateApiStatistics($eventId, retry: true, retrySeconds: $seconds);

// Success
$apiStats->updateApiStatistics($eventId);

// Custom timestamp
$apiStats->updateApiStatistics($eventId, timestamp: time());

开发

要修改库,请执行以下操作

  1. python3 -m pip install -r requirements.txt
  2. fab docker.install
  3. docker compose exec develop bash
  4. 仓库包含vscode容器扩展的配置文件。

测试

要运行phpunit测试,请启动开发docker机器并运行phpunit:./vendor/bin/phpunit