README

此项目扩展了Application Insights API接口，以支持PHP。Application Insights是一种服务，允许开发者保持其应用程序的可用性、性能和成功。此PHP模块将允许您将各种类型的遥测（事件、跟踪、异常等）发送到Application Insights服务，在那里您可以在Azure Portal中可视化它们。

状态

尽管我们过去曾为此SDK做出过贡献，但此SDK目前既不受微软维护也不受支持。请注意，Azure Monitor仅在使用受支持的SDK时提供支持。我们正在不断评估扩大对我们支持其他语言的机会，请关注我们的GitHub公告页面以获取最新的SDK新闻。

需求

支持PHP版本 >=5.4.2。

为了在Microsoft Visual Studio中打开项目，您需要PHP Tools for Visual Studio。但这不是必需的。

安装

我们在Packagist上发布了一个包。为了使用它，首先，您需要获取Composer。

一旦您的项目配置了Composer，只需将我们包的引用添加到您要使用的版本中到composer.json文件。

require: "microsoft/application-insights": "*"

或者您可以使用composer命令自动将包添加到composer.json文件中。

composer require microsoft/application-insights

确保您添加了require语句以拉入库

require_once 'vendor/autoload.php';

用法

安装后，您可以向Application Insights发送遥测。以下是一些示例。

注意：在您发送数据之前，您将需要一个仪器密钥。有关更多信息，请参阅获取Application Insights仪器密钥部分。

初始化客户端并设置仪器密钥和其他可选配置

$telemetryClient = new \ApplicationInsights\Telemetry_Client();
$context = $telemetryClient->getContext();

// Necessary
$context->setInstrumentationKey('YOUR INSTRUMENTATION KEY');

// Optional
$context->getSessionContext()->setId(session_id());
$context->getUserContext()->setId('YOUR USER ID');
$context->getApplicationContext()->setVer('YOUR VERSION');
$context->getLocationContext()->setIp('YOUR IP');

// Start tracking
$telemetryClient->trackEvent('name of your event');
$telemetryClient->flush();

设置操作上下文

为了正确报告Application Insights，您需要设置操作上下文，参考请求

$telemetryClient->getContext()->getOperationContext()->setId('XX');
$telemetryClient->getContext()->getOperationContext()->setName('GET Index');

发送带有事件名称的简单事件遥测项

$telemetryClient->trackEvent('name of your event');
$telemetryClient->flush();

发送带有自定义属性和度量的事件遥测项

$telemetryClient->trackEvent('name of your event', ['MyCustomProperty' => 42, 'MyCustomProperty2' => 'test'], ['duration', 42]);
$telemetryClient->flush();

在发送到服务之前发送多个遥测项也是支持的；API将批处理一切，直到您调用flush()

$telemetryClient->trackEvent('name of your event');
$telemetryClient->trackEvent('name of your second event');
$telemetryClient->flush();

发送带有页面名称和URL的简单页面视图遥测项

$telemetryClient->trackPageView('myPageView', 'http://www.foo.com');
$telemetryClient->flush();

发送带有持续时间、自定义属性和度量的页面视图遥测项

$telemetryClient->trackPageView('myPageView', 'http://www.foo.com', 256, ['InlineProperty' => 'test_value'], ['duration' => 42.0]);
$telemetryClient->flush();

发送带有度量名称和值的简单度量遥测项

$telemetryClient->trackMetric('myMetric', 42.0);
$telemetryClient->flush();

发送带有点类型、计数、最小值、最大值、标准差和度量的度量遥测项

$telemetryClient->trackMetric('myMetric', 42.0, \ApplicationInsights\Channel\Contracts\Data_Point_Type::Aggregation, 5, 0, 1, 0.2, ['InlineProperty' => 'test_value']);
$telemetryClient->flush();

发送带有消息的简单消息遥测项

$telemetryClient->trackMessage('myMessage', \ApplicationInsights\Channel\Contracts\Message_Severity_Level::INFORMATION, ['InlineProperty' => 'test_value']);
$telemetryClient->flush();

发送带有请求名称、URL和开始时间的简单请求遥测项

$telemetryClient->trackRequest('myRequest', 'http://foo.bar', time());
$telemetryClient->flush();

发送带有持续时间、HTTP状态代码、请求是否成功、自定义属性和度量的请求遥测项

$telemetryClient->trackRequest('myRequest', 'http://foo.bar', time(), 3754, 200, true, ['InlineProperty' => 'test_value'], ['duration_inner' => 42.0]);
$telemetryClient->flush();

发送带有自定义属性和指标的异常遥测

try
{
    // Do something to throw an exception
}
catch (\Exception $ex)
{
    $telemetryClient->trackException($ex, ['InlineProperty' => 'test_value'], ['duration_inner' => 42.0]);
    $telemetryClient->flush();
}

将客户端设置为在发送之前压缩数据

$telemetryClient->getChannel()->setSendGzipped(true);

注册异常处理器

class Handle_Exceptions
{
    private $_telemetryClient;

    public function __construct()
    {
        $this->_telemetryClient = new \ApplicationInsights\Telemetry_Client();
        $this->_telemetryClient->getContext()->setInstrumentationKey('YOUR INSTRUMENTATION KEY');

        set_exception_handler(array($this, 'exceptionHandler'));
    }

    function exceptionHandler(\Exception $exception)
    {
        if ($exception != NULL)
        {
            $this->_telemetryClient->trackException($exception);
            $this->_telemetryClient->flush();
        }
    }
}

发送成功的SQL依赖遥测项

$telemetryClient->trackDependency('Query table', "SQL", 'SELECT * FROM table;', time(), 122, true);
$telemetryClient->flush();

发送失败的HTTP依赖遥测项

$telemetryClient->trackDependency('method', "HTTP", "http://example.com/api/method", time(), 324, false, 503);
$telemetryClient->flush();

发送任何其他类型的依赖遥测项

$telemetryClient->trackDependency('Name of operation', "service", 'Arguments', time(), 23, true);
$telemetryClient->flush();

更改操作ID（用于将操作关联起来）

$telemetryClient->trackMetric('interestingMetric', 10);
$telemetryClient->getContext()->getOperationContext()->setId(\ApplicationInsights\Channel\Contracts\Utils::returnGuid())
$telemetryClient->trackMetric('differentOperationMetric', 11);
$telemetryClient->flush();

行为准则

本项目采用了微软开源行为准则。更多信息请参阅行为准则常见问题解答，或联系opencode@microsoft.com提出任何额外的问题或评论。