halloverden/symfony-application-insights-bundle

启用 Azure Application Insights 监控

0.1.5 2022-06-22 10:24 UTC

This package is auto-updated.

Last update: 2024-09-22 15:21:16 UTC


README

Application Insights Bundle 提供工具将您的 Symfony 应用程序中发生的异常注册到 Microsoft 的 Azure Application Insights。它使用 Microsoft 开发的 Azure Application Insights 包

安装

请确保已全局安装 Composer,如 Composer 文档中的 安装章节 所述。

使用 Symfony Flex 的应用程序

打开命令行,进入您的项目目录,然后执行

$ composer require halloverden/symfony-application-insights-bundle

不使用 Symfony Flex 的应用程序

步骤 1:下载 Bundle

打开命令行,进入您的项目目录,然后执行以下命令以下载此 Bundle 的最新稳定版本

$ composer require halloverden/symfony-application-insights-bundle

步骤 2:启用 Bundle

然后,通过将其添加到 config/bundles.php 文件中注册的 Bundle 列表来启用 Bundle。

// config/bundles.php

return [
    // ...
    HalloVerden\ApplicationInsightsBundle\HalloVerdenApplicationInsightsBundle::class => ['all' => true],
];

使用方法

您必须将这些值注册到您的 .env 文件中

###> symfony-application-insights-bundle ###
TRACKING_ENABLED=true # SET TO TRUE TO ENABLE THE BUNDLE 
MICROSOFT_APP_INSIGHTS_INTRUMENTATION_KEY='cfa65c5d-61ac-4336-b47a-8491578d35f3' # INTRUMENTATION KEY REQUIRED TO SEND INFO TO AZURE APPLICATION INSIGHTS
EXCEPTION_TRACKING_ENABLED=true # SET TO TRUE TO ENABLE EXCEPTION TRACKING 
EXCEPTION_TRACKING_IGNORE='["Symfony\\Component\\HttpKernel\\Exception\\NotFoundHttpException"]' # LIST OF EXCEPTION TO BE IGNORED BY THE TRACKERS
###< symfony-application-insights-bundle ### 

TRACKING_ENABLEDEXCEPTION_TRACKING_ENABLED 都设置为 true 时,Bundle 提供的 Exception Subscriber 将监听异常(忽略 EXCEPTION_TRACKING_IGNORE 参数中提供的异常),并将它们注册到遥测队列中。Terminate Subscriber 将等待操作完成,然后清空队列并将异常发送到 Azure Application Insights。无需额外的代码。

目前,此 Bundle 仅支持异常跟踪。

贡献

欢迎 Pull requests。对于重大更改,请先提出一个问题来讨论您想要更改的内容。

请确保根据需要更新测试。

许可

MIT