Telemetry_Client.php

<?php
namespace ApplicationInsights;

/**
 * Main object used for interacting with the Application Insights service.
 */
class Telemetry_Client
{
    /**
     * The telemetry context this client will use
     * @var \ApplicationInsights\Telemetry_Context
     */
    private $_context;

    /**
     * The telemetry channel this client will use
     * @var \ApplicationInsights\Channel\Telemetry_Channel
     */
    private $_channel;

     /**
     * Initializes a new Telemetry_Client.
     * @param \ApplicationInsights\Telemetry_Context $context
     * @param \ApplicationInsights\Channel\Telemetry_Channel $channel
     */
    public function __construct(Telemetry_Context $context = NULL, Channel\Telemetry_Channel $channel = NULL)
    {
        $this->_context = ($context == NULL) ?  new Telemetry_Context() : $context;
        $this->_channel = ($channel == NULL) ?  new Channel\Telemetry_Channel() : $channel;
    }

    /**
     * Returns the Telemetry_Context this Telemetry_Client is using.
     * @return \ApplicationInsights\Telemetry_Context
     */
    public function getContext()
    {
        return $this->_context;
    }

    /**
     * Returns the Telemetry_Channel this Telemetry_Client is using.
     * @return \ApplicationInsights\Channel\Telemetry_Channel
     */
    public function getChannel()
    {
        return $this->_channel;
    }

    /**
     * Sends an Page_View_Data to the Application Insights service.
     * @param string $name The friendly name of the page view.
     * @param string $url The url of the page view.
     * @param int duration The duration in milliseconds of the page view.
     * @param array $properties An array of name to value pairs. Use the name as the index and any string as the value.
     * @param array $measurements An array of name to double pairs. Use the name as the index and any double as the value.
     */
    public function trackPageView($name, $url, $duration = 0, $properties = NULL, $measurements = NULL)
    {
        $data = new Channel\Contracts\Page_View_Data();
        $data->setName($name);
        $data->setUrl($url);
        $data->setDuration(Channel\Contracts\Utils::convertMillisecondsToTimeSpan($duration));
        if ($properties != NULL)
        {
            $data->setProperties($properties);
        }
        if ($measurements != NULL)
        {
            $data->setMeasurements($measurements);
        }

        $this->_channel->addToQueue($data, $this->_context);
    }

    /**
     * Sends an Metric_Data to the Application Insights service.
     * @param string $name Name of the metric.
     * @param double $value Value of the metric.
     * @param int $type The type of value being sent. Found: \ApplicationInsights\Channel\Contracts\Data_Point_Type::Value
     * @param int $count The number of samples.
     * @param double $min The minimum of the samples.
     * @param double $max The maximum of the samples.
     * @param double $stdDev The standard deviation of the samples.
     * @param array $properties An array of name to value pairs. Use the name as the index and any string as the value.
     */
    public function trackMetric($name, $value, $type = NULL, $count = NULL, $min = NULL, $max = NULL, $stdDev = NULL, $properties = NULL)
    {
        $dataPoint = new Channel\Contracts\Data_Point();
        $dataPoint->setName($name);
        $dataPoint->setValue($value);
        $dataPoint->setKind($type == NULL ? Channel\Contracts\Data_Point_Type::AGGREGATION : $type);
        $dataPoint->setCount($count);
        $dataPoint->setMin($min);
        $dataPoint->setMax($max);
        $dataPoint->setStdDev($stdDev);

        $data = new Channel\Contracts\Metric_Data();
        $data->setMetrics(array($dataPoint));
        if ($properties != NULL)
        {
            $data->setProperties($properties);
        }

        $this->_channel->addToQueue($data, $this->_context);
    }

    /**
     * Sends an Event_Data to the Application Insights service.
     * @param string $name
     * @param array $properties An array of name to value pairs. Use the name as the index and any string as the value.
     * @param array $measurements An array of name to double pairs. Use the name as the index and any double as the value.
     */
    public function trackEvent($name, $properties = NULL, $measurements = NULL)
    {
        $data = new Channel\Contracts\Event_Data();
        $data->setName($name);
        if ($properties != NULL)
        {
            $data->setProperties($properties);
        }
        if ($measurements != NULL)
        {
            $data->setMeasurements($measurements);
        }

        $this->_channel->addToQueue($data, $this->_context);
    }

    /**
     * Sends an Message_Data to the Application Insights service.
     * @param string $message The trace message.
     * @param string $severityLevel The severity level of the message. Found: \ApplicationInsights\Channel\Contracts\Message_Severity_Level::Value
     * @param array $properties An array of name to value pairs. Use the name as the index and any string as the value.
     */
    public function trackMessage($message, $severityLevel = NULL, $properties = NULL)
    {
        $data = new Channel\Contracts\Message_Data();
        $data->setMessage($message);
        $data->setSeverityLevel($severityLevel);

        if ($properties != NULL)
        {
            $data->setProperties($properties);
        }

        $this->_channel->addToQueue($data, $this->_context);
    }

    /**
     * Sends a Request_Data to the Application Insights service.
     * @param string $name A friendly name of the request.
     * @param string $url The url of the request.
     * @param int $startTime The timestamp at which the request started.
     * @param int $durationInMilliseconds The duration, in milliseconds, of the request.
     * @param int $httpResponseCode The response code of the request.
     * @param bool $isSuccessful Whether or not the request was successful.
     * @param array $properties An array of name to value pairs. Use the name as the index and any string as the value.
     * @param array $measurements An array of name to double pairs. Use the name as the index and any double as the value.
     */
    public function trackRequest($name, $url, $startTime, $durationInMilliseconds = 0, $httpResponseCode = 200, $isSuccessful = true, $properties = NULL, $measurements = NULL )
    {
        $this->endRequest($this->beginRequest($name, $url, $startTime), $durationInMilliseconds, $httpResponseCode, $isSuccessful, $properties, $measurements );
    }

    /**
     * Begin a Request_Data to the Application Insights service. This request is not sent until an @see endRequest call is made, passing this request.
     *
     * @param string $name A friendly name of the request.
     * @param string $url The url of the request.
     * @param int $startTime The timestamp at which the request started.
     * @return \ApplicationInsights\Channel\Contracts\Request_Data an initialized Request_Data, which can be sent by using @see endRequest
     */
    public function beginRequest($name, $url, $startTime )
    {
        $data = new Channel\Contracts\Request_Data();
        $guid = \ApplicationInsights\Channel\Contracts\Utils::returnGuid();
        $data->setId($guid);
        $data->setName($name);
        $data->setUrl($url);
        $data->setTime($startTime);

        return $data;
    }

    /**
     * Sends a Request_Data created by @see beginRequest to the Application Insights service.
     * @param int $durationInMilliseconds The duration, in milliseconds, of the request.
     * @param int $httpResponseCode The response code of the request.
     * @param bool $isSuccessful Whether or not the request was successful.
     * @param array $properties An array of name to value pairs. Use the name as the index and any string as the value.
     * @param array $measurements An array of name to double pairs. Use the name as the index and any double as the value.
     */
    public function endRequest( Channel\Contracts\Request_Data $request, $durationInMilliseconds = 0, $httpResponseCode = 200, $isSuccessful = true, $properties = NULL, $measurements = NULL  )
    {
        $request->setResponseCode($httpResponseCode);
        $request->setSuccess($isSuccessful);

        $request->setDuration(Channel\Contracts\Utils::convertMillisecondsToTimeSpan($durationInMilliseconds));

        if ($properties != NULL)
        {
            $request->setProperties($properties);
        }

        if ($measurements != NULL)
        {
            $request->setMeasurements($measurements);
        }

        $this->_channel->addToQueue($request, $this->_context);
    }

    /**
     * Sends an Exception_Data to the Application Insights service.
     * @param \Exception|\Throwable $ex The exception/throwable to send
     * @param array $properties An array of name to value pairs. Use the name as the index and any string as the value.
     * @param array $measurements An array of name to double pairs. Use the name as the index and any double as the value.
     */
    public function trackException($ex, $properties = NULL, $measurements = NULL)
    {
        $details = new Channel\Contracts\Exception_Details();
        $details->setId(1);
        $details->setOuterId(0);
        $details->setTypeName(get_class($ex));
        $details->setMessage($ex->getMessage().' in '.$ex->getFile().' on line '.$ex->getLine());
        $details->setHasFullStack(true);

        $stackFrames = array();

        // First stack frame is in the root exception
        $frameCounter = 0;
        foreach ($ex->getTrace() as $currentFrame)
        {
        	$stackFrame = new Channel\Contracts\Stack_Frame();
            if (array_key_exists('class', $currentFrame) == true)
            {
                $stackFrame->setAssembly($currentFrame['class']);
            }
            if (array_key_exists('file', $currentFrame) == true)
            {
                $stackFrame->setFileName($currentFrame['file']);
            }
            if (array_key_exists('line', $currentFrame) == true)
            {
                $stackFrame->setLine($currentFrame['line']);
            }
            if (array_key_exists('function', $currentFrame) == true)
            {
                $stackFrame->setMethod($currentFrame['function']);
            }

            // Make it a string to force serialization of zero
            $stackFrame->setLevel(''.$frameCounter);

            array_unshift($stackFrames, $stackFrame);
            $frameCounter++;
        }

        $details->setParsedStack($stackFrames);

        $data = new Channel\Contracts\Exception_Data();
        $data->setExceptions(array($details));

        if ($properties != NULL)
        {
            $data->setProperties($properties);
        }

        if ($measurements != NULL)
        {
            $data->setMeasurements($measurements);
        }

        $this->_channel->addToQueue($data, $this->_context);
    }

    /**
     * Sends an Dependency_Data to the Application Insights service.
     * @param string $name Name of the dependency.
     * @param string $type The Dependency type of value being sent.
     * @param string $commandName Command/Method of the dependency.
     * @param int $startTime The timestamp at which the request started.
     * @param int $durationInMilliseconds The duration, in milliseconds, of the request.
     * @param bool $isSuccessful Whether or not the request was successful.
     * @param int $resultCode The result code of the request.
     * @param array $properties An array of name to value pairs. Use the name as the index and any string as the value.
     */
    public function trackDependency(
        $name,
        $type = "",
        $commandName = NULL,
        $startTime = NULL,
        $durationInMilliseconds = 0,
        $isSuccessful = true,
        $resultCode = NULL,
        $properties = NULL)
    {
        $data = new Channel\Contracts\Dependency_Data();
        $data->setName($name);
        $data->setType($type);
        $data->setData($commandName);
        $data->setDuration(Channel\Contracts\Utils::convertMillisecondsToTimeSpan($durationInMilliseconds));
        $data->setSuccess($isSuccessful);
        $data->setResultCode($resultCode);

        if ($properties != NULL)
        {
            $data->setProperties($properties);
        }

        $this->_channel->addToQueue($data, $this->_context, $startTime);
    }

    /**
     * Flushes the underlying Telemetry_Channel queue.
     * @param array $options - Guzzle client option overrides
     * @param bool  $sendAsync - Send the request asynchronously
     * @return \GuzzleHttp\Promise\PromiseInterface|\Psr\Http\Message\ResponseInterface|null|WP_Error
     */
    public function flush($options = array(), $sendAsync = false)
    {
        $response = $this->_channel->send($options, $sendAsync);
        $this->_channel->setQueue([]);
        return $response;
    }
}