Merge pull request #10 from trakerr-com/develop

v1.1.0
Expose the properties those use so people can populate them on their own.

Author: RMSD

README.md

@@ -101,6 +101,8 @@ $contextDeploymentStage = "development")
 ```
 The TrakerrClient class however has a lot of exposed properties. The benefit to setting these immediately after after you create the TrakerrClient is that AppEvent will default it's values against the TrakerClient that created it. This way if there is a value that all your AppEvents uses, and the constructor default value currently doesn't suit you; it may be easier to change it in TrakerrClient as it will become the default value for all AppEvents created after. A lot of these are populated by default value by the constructor, but you can populate them with whatever string data you want. The following table provides an in depth look at each of those.
 
+If you're populating an app event directly, you'll want to take a look at the [AppEvent properties](generated/SwaggerClient-php/docs/Model/AppEvent.md) as they contain properties unique to each AppEvent which do not have defaults you may set in the client.
+
 Name | Type | Description | Notes
 ------------ | ------------- | -------------  | -------------
 **apiKey** | **string**  | API Key for your application. |
@@ -112,10 +114,11 @@ Name | Type | Description | Notes
 **contextEnvHostname** | **string** | Provide the current hostname. | Defaults Value: `gethostname()`.
 **contextAppOS** | **string** | Provide an operating system name. | Defaults Value: `php_uname("s")`.
 **contextAppOSVersion** | **string** | Provide an operating system version. | Default Value: `php_uname("v")`.
-**contextAppOSBrowser** | **string** | An optional string browser name the application is running on. | Defaults to `Null`
-**contextAppOSBrowserVersion** | **string** | An optional string browser version the application is running on. | Defaults to `Null`
-**contextDataCenter** | **string** | Data center the application is running on or connected to. | Defaults to `Null`
-**contextDataCenterRegion** | **string** | Data center region. | Defaults to `Null`
+**contextAppOSBrowser** | **string** | An optional string browser name the application is running on. | Defaults to `NULL`
+**contextAppOSBrowserVersion** | **string** | An optional string browser version the application is running on. | Defaults to `NULL`
+**contextDataCenter** | **string** | Data center the application is running on or connected to. | Defaults to `NULL`
+**contextDataCenterRegion** | **string** | Data center region. | Defaults to `NULL`
+**context_tags** | **string[]** | Any tags that describe the the module that this handler is for. | Defaults to `NULL`
 
 
 ## Documentation For Models

generated/SwaggerClient-php/README.md

@@ -4,7 +4,7 @@ Get your application events and errors to Trakerr via the *Trakerr API*.
 This PHP package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 1.0.0
-- Build date: 2017-03-13T16:52:09.648-07:00
+- Build date: 2017-05-05T15:16:45.124-07:00
 - Build package: class io.swagger.codegen.languages.PhpClientCodegen
 
 ## Requirements

generated/SwaggerClient-php/docs/Model/AppEvent.md

@@ -5,7 +5,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **api_key** | **string** | API key generated for the application | 
 **log_level** | **string** | (optional) Logging level, one of 'debug','info','warning','error', 'fatal', defaults to 'error' | [optional] 
-**classification** | **string** | (optional) one of 'error' or a custom string for non-errors, defaults to 'error' | 
+**classification** | **string** | (optional) one of 'issue' or a custom string for non-issues, defaults to 'issue' | 
 **event_type** | **string** | type of the event or error (eg. NullPointerException) | 
 **event_message** | **string** | message containing details of the event or error | 
 **event_time** | **int** | (optional) event time in ms since epoch | [optional] 
@@ -24,6 +24,14 @@ Name | Type | Description | Notes
 **context_app_os_version** | **string** | (optional) OS version the application is running on | [optional] 
 **context_data_center** | **string** | (optional) Data center the application is running on or connected to | [optional] 
 **context_data_center_region** | **string** | (optional) Data center region | [optional] 
+**context_tags** | **string[]** |  | [optional] 
+**context_url** | **string** | (optional) The full URL when running in a browser when the event was generated. | [optional] 
+**context_operation_time_millis** | **int** | (optional) duration that this event took to occur in millis. Example - database call time in millis. | [optional] 
+**context_cpu_percentage** | **int** | (optional) CPU utilization as a percent when event occured | [optional] 
+**context_memory_percentage** | **int** | (optional) Memory utilization as a percent when event occured | [optional] 
+**context_cross_app_correlation_id** | **string** | (optional) Cross application correlation ID | [optional] 
+**context_device** | **string** | (optional) Device information | [optional] 
+**context_app_sku** | **string** | (optional) Application SKU | [optional] 
 **custom_properties** | [**\trakerr\client\model\CustomData**](CustomData.md) |  | [optional] 
 **custom_segments** | [**\trakerr\client\model\CustomData**](CustomData.md) |  | [optional] 
 

generated/SwaggerClient-php/lib/model/AppEvent.php

@@ -87,6 +87,14 @@ class AppEvent implements ArrayAccess
         'context_app_os_version' => 'string',
         'context_data_center' => 'string',
         'context_data_center_region' => 'string',
+        'context_tags' => 'string[]',
+        'context_url' => 'string',
+        'context_operation_time_millis' => 'int',
+        'context_cpu_percentage' => 'int',
+        'context_memory_percentage' => 'int',
+        'context_cross_app_correlation_id' => 'string',
+        'context_device' => 'string',
+        'context_app_sku' => 'string',
         'custom_properties' => '\trakerr\client\model\CustomData',
         'custom_segments' => '\trakerr\client\model\CustomData'
     );
@@ -122,6 +130,14 @@ public static function swaggerTypes()
         'context_app_os_version' => 'contextAppOSVersion',
         'context_data_center' => 'contextDataCenter',
         'context_data_center_region' => 'contextDataCenterRegion',
+        'context_tags' => 'contextTags',
+        'context_url' => 'contextURL',
+        'context_operation_time_millis' => 'contextOperationTimeMillis',
+        'context_cpu_percentage' => 'contextCpuPercentage',
+        'context_memory_percentage' => 'contextMemoryPercentage',
+        'context_cross_app_correlation_id' => 'contextCrossAppCorrelationId',
+        'context_device' => 'contextDevice',
+        'context_app_sku' => 'contextAppSku',
         'custom_properties' => 'customProperties',
         'custom_segments' => 'customSegments'
     );
@@ -157,6 +173,14 @@ public static function attributeMap()
         'context_app_os_version' => 'setContextAppOsVersion',
         'context_data_center' => 'setContextDataCenter',
         'context_data_center_region' => 'setContextDataCenterRegion',
+        'context_tags' => 'setContextTags',
+        'context_url' => 'setContextUrl',
+        'context_operation_time_millis' => 'setContextOperationTimeMillis',
+        'context_cpu_percentage' => 'setContextCpuPercentage',
+        'context_memory_percentage' => 'setContextMemoryPercentage',
+        'context_cross_app_correlation_id' => 'setContextCrossAppCorrelationId',
+        'context_device' => 'setContextDevice',
+        'context_app_sku' => 'setContextAppSku',
         'custom_properties' => 'setCustomProperties',
         'custom_segments' => 'setCustomSegments'
     );
@@ -192,6 +216,14 @@ public static function setters()
         'context_app_os_version' => 'getContextAppOsVersion',
         'context_data_center' => 'getContextDataCenter',
         'context_data_center_region' => 'getContextDataCenterRegion',
+        'context_tags' => 'getContextTags',
+        'context_url' => 'getContextUrl',
+        'context_operation_time_millis' => 'getContextOperationTimeMillis',
+        'context_cpu_percentage' => 'getContextCpuPercentage',
+        'context_memory_percentage' => 'getContextMemoryPercentage',
+        'context_cross_app_correlation_id' => 'getContextCrossAppCorrelationId',
+        'context_device' => 'getContextDevice',
+        'context_app_sku' => 'getContextAppSku',
         'custom_properties' => 'getCustomProperties',
         'custom_segments' => 'getCustomSegments'
     );
@@ -258,6 +290,14 @@ public function __construct(array $data = null)
         $this->container['context_app_os_version'] = isset($data['context_app_os_version']) ? $data['context_app_os_version'] : null;
         $this->container['context_data_center'] = isset($data['context_data_center']) ? $data['context_data_center'] : null;
         $this->container['context_data_center_region'] = isset($data['context_data_center_region']) ? $data['context_data_center_region'] : null;
+        $this->container['context_tags'] = isset($data['context_tags']) ? $data['context_tags'] : null;
+        $this->container['context_url'] = isset($data['context_url']) ? $data['context_url'] : null;
+        $this->container['context_operation_time_millis'] = isset($data['context_operation_time_millis']) ? $data['context_operation_time_millis'] : null;
+        $this->container['context_cpu_percentage'] = isset($data['context_cpu_percentage']) ? $data['context_cpu_percentage'] : null;
+        $this->container['context_memory_percentage'] = isset($data['context_memory_percentage']) ? $data['context_memory_percentage'] : null;
+        $this->container['context_cross_app_correlation_id'] = isset($data['context_cross_app_correlation_id']) ? $data['context_cross_app_correlation_id'] : null;
+        $this->container['context_device'] = isset($data['context_device']) ? $data['context_device'] : null;
+        $this->container['context_app_sku'] = isset($data['context_app_sku']) ? $data['context_app_sku'] : null;
         $this->container['custom_properties'] = isset($data['custom_properties']) ? $data['custom_properties'] : null;
         $this->container['custom_segments'] = isset($data['custom_segments']) ? $data['custom_segments'] : null;
     }
@@ -375,7 +415,7 @@ public function getClassification()
 
     /**
      * Sets classification
-     * @param string $classification (optional) one of 'error' or a custom string for non-errors, defaults to 'error'
+     * @param string $classification (optional) one of 'issue' or a custom string for non-issues, defaults to 'issue'
      * @return $this
      */
     public function setClassification($classification)
@@ -763,6 +803,174 @@ public function setContextDataCenterRegion($context_data_center_region)
         return $this;
     }
 
+    /**
+     * Gets context_tags
+     * @return string[]
+     */
+    public function getContextTags()
+    {
+        return $this->container['context_tags'];
+    }
+
+    /**
+     * Sets context_tags
+     * @param string[] $context_tags
+     * @return $this
+     */
+    public function setContextTags($context_tags)
+    {
+        $this->container['context_tags'] = $context_tags;
+
+        return $this;
+    }
+
+    /**
+     * Gets context_url
+     * @return string
+     */
+    public function getContextUrl()
+    {
+        return $this->container['context_url'];
+    }
+
+    /**
+     * Sets context_url
+     * @param string $context_url (optional) The full URL when running in a browser when the event was generated.
+     * @return $this
+     */
+    public function setContextUrl($context_url)
+    {
+        $this->container['context_url'] = $context_url;
+
+        return $this;
+    }
+
+    /**
+     * Gets context_operation_time_millis
+     * @return int
+     */
+    public function getContextOperationTimeMillis()
+    {
+        return $this->container['context_operation_time_millis'];
+    }
+
+    /**
+     * Sets context_operation_time_millis
+     * @param int $context_operation_time_millis (optional) duration that this event took to occur in millis. Example - database call time in millis.
+     * @return $this
+     */
+    public function setContextOperationTimeMillis($context_operation_time_millis)
+    {
+        $this->container['context_operation_time_millis'] = $context_operation_time_millis;
+
+        return $this;
+    }
+
+    /**
+     * Gets context_cpu_percentage
+     * @return int
+     */
+    public function getContextCpuPercentage()
+    {
+        return $this->container['context_cpu_percentage'];
+    }
+
+    /**
+     * Sets context_cpu_percentage
+     * @param int $context_cpu_percentage (optional) CPU utilization as a percent when event occured
+     * @return $this
+     */
+    public function setContextCpuPercentage($context_cpu_percentage)
+    {
+        $this->container['context_cpu_percentage'] = $context_cpu_percentage;
+
+        return $this;
+    }
+
+    /**
+     * Gets context_memory_percentage
+     * @return int
+     */
+    public function getContextMemoryPercentage()
+    {
+        return $this->container['context_memory_percentage'];
+    }
+
+    /**
+     * Sets context_memory_percentage
+     * @param int $context_memory_percentage (optional) Memory utilization as a percent when event occured
+     * @return $this
+     */
+    public function setContextMemoryPercentage($context_memory_percentage)
+    {
+        $this->container['context_memory_percentage'] = $context_memory_percentage;
+
+        return $this;
+    }
+
+    /**
+     * Gets context_cross_app_correlation_id
+     * @return string
+     */
+    public function getContextCrossAppCorrelationId()
+    {
+        return $this->container['context_cross_app_correlation_id'];
+    }
+
+    /**
+     * Sets context_cross_app_correlation_id
+     * @param string $context_cross_app_correlation_id (optional) Cross application correlation ID
+     * @return $this
+     */
+    public function setContextCrossAppCorrelationId($context_cross_app_correlation_id)
+    {
+        $this->container['context_cross_app_correlation_id'] = $context_cross_app_correlation_id;
+
+        return $this;
+    }
+
+    /**
+     * Gets context_device
+     * @return string
+     */
+    public function getContextDevice()
+    {
+        return $this->container['context_device'];
+    }
+
+    /**
+     * Sets context_device
+     * @param string $context_device (optional) Device information
+     * @return $this
+     */
+    public function setContextDevice($context_device)
+    {
+        $this->container['context_device'] = $context_device;
+
+        return $this;
+    }
+
+    /**
+     * Gets context_app_sku
+     * @return string
+     */
+    public function getContextAppSku()
+    {
+        return $this->container['context_app_sku'];
+    }
+
+    /**
+     * Sets context_app_sku
+     * @param string $context_app_sku (optional) Application SKU
+     * @return $this
+     */
+    public function setContextAppSku($context_app_sku)
+    {
+        $this->container['context_app_sku'] = $context_app_sku;
+
+        return $this;
+    }
+
     /**
      * Gets custom_properties
      * @return \trakerr\client\model\CustomData

lib/TrakerrClient.php

@@ -63,6 +63,7 @@ class TrakerrClient
     private $contextDataCenter;
     private $contextDataCenterRegion;
     private $errorHelper;
+    private $contextTags;
 
     /**
      * TrakerrClient constructor.
@@ -71,7 +72,7 @@ class TrakerrClient
      * @param string $contextAppVersion (optional) application version, defaults to 1.0
      * @param string $contextEnvName (optional) environment name like "development", "staging", "production" or a custom string
      */
-    public function __construct($apiKey, $contextAppVersion = "1.0", $contextDeploymentStage = "development")
+    public function __construct($apiKey, $contextAppVersion = "1.0", $contextDeploymentStage = "development", $contextTags = NULL)
     {
         $this->apiKey = $apiKey;
         $this->contextAppVersion = is_null($contextAppVersion) ? "1.0" : $contextAppVersion;
@@ -86,6 +87,7 @@ public function __construct($apiKey, $contextAppVersion = "1.0", $contextDeploym
         $this->contextAppBrowserVersion = NULL;
         $this->contextDataCenter = NULL;
         $this->contextDataCenterRegion = NULL;
+        $this->contextTags = $contextTags;
 
         $apiClient = new ApiClient();
         $this->eventsApi = new EventsApi($apiClient);
@@ -201,7 +203,7 @@ private function fillDefaults(AppEvent $appEvent)
         }
 
         if (is_null($appEvent->getEventTime())) {
-            $appEvent->setEventTime($this->millitime());
+            $appEvent->setEventTime(intval($this->millitime()));
         }
         return $appEvent;
     }
@@ -386,4 +388,17 @@ public function getContextDataCenterRegion()
     {
         return $this->contextDataCenterRegion;
     }
+
+    public function setContextTags($contexttags)
+    {
+        if (!is_array($contextdatacenterregion)) {
+            throw new \InvalidArgumentException('Function only accepts an array of strings');
+        }
+        $this->contextTags = $contexttags;
+    }
+
+    public function getContextTags()
+    {
+        return $this->contextTags;
+    }
 }

testapp.php

@@ -38,6 +38,12 @@
     $customStringData->setCustomData1("Some custom data");
     $customProperties->setStringData($customStringData);
     $appEvent2->setCustomProperties($customProperties);
+    $appEvent2->setContextOperationTimeMillis(1000);
+    $appEvent2->setContextCpuPercentage(60);
+    $appEvent2->setContextMemoryPercentage(80);
+    $appEvent2->setContextDevice("pc");
+    $appEvent2->setContextAppSku("mobile");
+    $appEvent2->setContextTags(["client, frontend"]);
 
     $trakerrClient->sendEvent($appEvent2);
 }