gamma/api-logger-bundle

提供REST API请求记录和性能分析工具

安装次数: 46,547

依赖项: 0

建议者: 0

安全: 0

星标: 0

关注者: 2

分支: 3

开放问题: 0

类型:symfony-bundle

1.0.6 2021-12-22 12:59 UTC

This package is not auto-updated.

Last update: 2024-09-26 02:41:13 UTC


README

Build Status

##关于

SmartGamma Symfony2 REST API Logger bundle 是我们用于创建 SmartGamma Symfony2 REST API 的工具。它允许详细记录API的入站调用(可以分离日志),跟踪持续时间、请求和响应体。作为附加功能,它允许对API进行性能分析,并跟踪慢速API调用。

##安装

  1. 使用Composer
composer require gamma/api-logger-bundle

现在,Composer将自动下载所有必需的文件,并为您安装它们。剩下的就是更新您的AppKernel.php文件,并注册新包

<?php

// in AppKernel::registerBundles()
$bundles = array(
    // ...
    new Gamma\ApiLoggerBundle\GammaApiLoggerBundle(),
    // ...
);

##配置

默认情况下,该包已启用,慢速API调用限制为1000毫秒。要更改这些设置,请向您的parameters.yml添加

// parameters.yml
   gamma_logger_enabled: true
   gamma_logger_slow_time_limit: 1000

或添加到config.yml

// config_dev.yml
parameters:
   gamma_logger_enabled: true
   gamma_logger_slow_time_limit: 500
// config_prod.yml
parameters:
   gamma_logger_enabled: false

##用法

一旦启用该包,它将开始记录所有URI前缀为"/api/"的请求,如下所示示例

logging

所有API调用将以"info"级别记录。超过"gamma_logger_slow_time_limit"值的API调用将以"error"级别记录

记录到单独的日志文件

要使API调用记录在单独的文件中,您可以使用以下monolog配置

// config.yml
monolog:
    handlers:
        main:
            type:         fingers_crossed
            action_level: error
            handler:      nested
            channels:     ["!api", "!api_slow"]
        api:
            type: stream
            path: %kernel.logs_dir%/%kernel.environment%.api.watch.log
            #level: info
            channels: ["api"]
        api_slow:
            type: stream
            path: %kernel.logs_dir%/%kernel.environment%.api.slow.log
            level: info
            channels: ["api_slow"]

##待办事项

  1. 将硬编码的前缀"/api/"设置为可配置的