stacksight/stacksight-php-sdk

php support for stacksight

stacksight

This repository will centralize the docs for the stacksight project. Checkout the wiki for an overview

stacksight-php-sdk's Issues

Empty README file

We can't allow for an api library to go out without proper documentation
please invest the time and document the library and it's use case for each platform
image you are a developer who want's to use it, and fill in the blanks

Creating a socket even when STACKSIGHT_INCLUDE_LOGS is not enabled

@igor-lemon
In Drupal module there is a creation of a socket in SSClientBase even when STACKSIGHT_INCLUDE_LOGS is not enabled. the creation of the socket takes about ~250ms.

i suggest to create the socket only logs enabled.

please fix comments indentations

https://github.com/stacksight/stacksight-php-sdk/blob/master/SSEventsMessageMapping.php#L7-L24

Index env based on changes to the api...

We need to add a few flags for it to index correctly...
https://github.com/oritpersik/stack-sight/commits/master

change russian documentation to english

https://github.com/stacksight/stacksight-php-sdk/blob/master/SSUtilities.php#L16

folder structure

please create a folder for each platform inside the platform dir
and move the bootstrap files:
bootstrap-drupal.php and bootstrap-wp.php
inside each folder

Public methods should assume the worst about their variables

public function publishEvent($data) {}
public function sendUpdates($data) {}
public function sendHealth($data) {}

these methods get $data with potentially harmful content, they mutate it and finally send it to the SSHttpRequest class method which encode the data to json and pass it to the remote server:
https://github.com/stacksight/stacksight-php-sdk/blob/master/SSHttpRequest.php#L12
https://github.com/stacksight/stacksight-php-sdk/blob/master/SSHttpRequest.php#L50
https://github.com/stacksight/stacksight-php-sdk/blob/master/SSHttpRequest.php#L71

This could be made more secure as someone could try to exploit this json passed to the server.

make generic code more elegent

I tend to be a smart ass and change generic lines like these:
https://github.com/stacksight/stacksight-php-sdk/blob/master/SSEventsMessageMapping.php#L45-L54

               switch ($event['action']) {
                    case 'created':
                        $design['color'] = $color_created;
                        break;
                    case 'updated':
                        $design['color'] = $color_updated;
                        break;
                    case 'deleted':
                        $design['color'] = $color_deleted;
                        break;
                }

to be this:

$design['color'] = ${'color_' . $event['action']};

and if you really want to be protective about your allowed actions you could do this:

if (in_array($event['action'], arary('created', 'updated', 'deleted')) {
  $design['color'] = ${'color_' . $event['action']};
}

Support both mysql and mysqli

Many new wordpress installation are configured with mysqli support only, which creates an issue using this plugin.

So please add conditional mysqli support in bootstrap-wp.php.

Wordpress itself and plugins support both. e.g. MainWP uses this: class-mainwp-child-db.php