mirror/librenms-librenms
1
0
Fork 0
mirror of https://github.com/librenms/librenms.git synced 2024-10-07 16:52:45 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Few tweaks on CS

Browse Source
This commit is contained in:
Andrey
2015-07-20 11:19:39 -03:00
parent a790aa4961
commit e36ab876d5
10 changed files with 186 additions and 212 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/InfluxDB/Client.php
+37 -52
View File
@@ -1,17 +1,14 @@
<?php
/**
* @author Stephen "TheCodeAssassin" Hoogendijk
*/
namespace InfluxDB;
use InfluxDB\Client\Exception as ClientException;
/**
* Class Client
*
* @package InfluxDB
* @author Stephen "TheCodeAssassin" Hoogendijk
*/
class Client
{
@@ -94,21 +91,17 @@ class Client
$ssl = false,
$verifySSL = true,
$timeout = 0
)
{
$this->host = $host;
$this->port = (int) $port;
$this->username = $username;
$this->password = $password;
$this->timeout = $timeout;
) {
$this->host = (string) $host;
$this->port = (int) $port;
$this->username = (string) $username;
$this->password = (string) $password;
$this->timeout = (int) $timeout;
$this->verifySSL = (bool) $verifySSL;
if ($ssl) {
$this->scheme = 'https';
$this->options += array(
'verify' => $verifySSL
);
$this->options += array('verify' => $verifySSL);
}
// the the base URI
@@ -119,7 +112,8 @@ class Client
/**
* For testing
* @param \Guzzle\Http\Client $client
*
* @param \Guzzle\Http\Client $client
* @return $this
*/
public function setHttpClient(\Guzzle\Http\Client $client)
@@ -132,8 +126,7 @@ class Client
/**
* Use the given database
*
* @param string $name
*
* @param string $name
* @return Database
*/
public function selectDB($name)
@@ -144,21 +137,19 @@ class Client
/**
* Query influxDB
*
* @param string $database
* @param string $query
* @param array $params
*
* @param string $database
* @param string $query
* @param array $params
* @return ResultSet
* @throws Exception
*/
public function query($database, $query, $params = array())
{
if ($database) {
$params['db'] = $database;
}
$params = '?'.http_build_query(array_merge(array('q' => $query), $params));
$params = '?' . http_build_query(array_merge(array('q' => $query), $params));
$options = array_merge($this->options, array('exceptions' => false, 'timeout' => $this->getTimeout()));
@@ -168,7 +159,6 @@ class Client
$raw = (string) $response->send()->getBody();
return new ResultSet($raw);
} catch (\Exception $e) {
throw new Exception(sprintf('Query has failed, exception: %s', $e->getMessage()));
}
@@ -177,28 +167,27 @@ class Client
/**
* Write points to the database
*
* @param string $database
* @param string $data
* @param string $precision The timestamp precision
*
* @param string $database
* @param string $data
* @param string $precision The timestamp precision
* @return bool
* @throws Exception
*
* @internal Internal method, do not use directly
* @throws Exception
*/
public function write($database, $data, $precision)
{
try {
$result = $this->httpClient->post($this->getBaseURI()
. '/write?db=' . $database
. '&precision=' . $precision
, null, $data,
$result = $this->httpClient->post(
$this->getBaseURI() .
'/write?db=' . $database .
'&precision=' . $precision,
null,
$data,
array('timeout' => $this->getTimeout())
)->send();
return $result->getStatusCode() == 204;
return $result->getStatusCode() === 204;
} catch (\Exception $e) {
throw new Exception(sprintf('Writing has failed, exception: %s', $e->getMessage()));
}
@@ -218,7 +207,6 @@ class Client
* List all the users
*
* @return array
*
* @throws Exception
*/
public function listUsers()
@@ -230,37 +218,33 @@ class Client
/**
* Build the client from a dsn
*
* Example: https+influxdb://username:pass@localhost:8086/databasename', timeout=5
*
* @param string $dsn
*
* @param int $timeout
* @param bool $verifySSL
*
* @param string $dsn
* @param int $timeout
* @param bool $verifySSL
* @return Client|Database
*
* @throws ClientException
*/
public static function fromDSN($dsn, $timeout = 0, $verifySSL = false)
{
$connParams = parse_url($dsn);
$schemeInfo = explode('+', $connParams['scheme']);
$dbName = null;
$modifier = null;
$scheme = $schemeInfo[0];
$dbName = null;
$modifier = null;
$scheme = $schemeInfo[0];
if (isset($schemeInfo[1])) {
$modifier = $schemeInfo[0];
$scheme = $schemeInfo[1];
$scheme = $schemeInfo[1];
}
if ($scheme != 'influxdb') {
throw new ClientException(sprintf('%s is not a valid scheme', $scheme));
}
$ssl = ($modifier && $modifier == 'https' ? true : false);
$dbName = ($connParams['path'] ? substr($connParams['path'], 1) : null);
$ssl = $modifier === 'https' ? true : false;
$dbName = $connParams['path'] ? substr($connParams['path'], 1) : null;
$client = new self(
$connParams['host'],
@@ -274,6 +258,7 @@ class Client
return ($dbName ? $client->selectDB($dbName) : $client);
}
/**
* @return mixed
*/
@@ -305,4 +290,4 @@ class Client
return $names;
}
}
}
src/InfluxDB/Client/Exception.php
+1 -2
View File
@@ -9,5 +9,4 @@ namespace InfluxDB\Client;
*/
class Exception extends \InfluxDB\Exception
{
}
}
src/InfluxDB/Database.php
+16 -36
View File
@@ -1,13 +1,10 @@
<?php
/**
* @author Stephen "TheCodeAssassin" Hoogendijk
*/
namespace InfluxDB;
use InfluxDB\Database\Exception as DatabaseException;
use InfluxDB\Database\RetentionPolicy;
use InfluxDB\Query\Builder as QueryBuilder;
use InfluxDB\Database\Exception as DatabaseException;
/**
* Class Database
@@ -15,10 +12,10 @@ use InfluxDB\Database\Exception as DatabaseException;
* @todo admin functionality
*
* @package InfluxDB
* @author Stephen "TheCodeAssassin" Hoogendijk
*/
class Database
{
/**
* The name of the Database
*
@@ -31,7 +28,6 @@ class Database
*/
protected $client;
/**
* Precision constants
*/
@@ -47,23 +43,19 @@ class Database
*
* @param string $name
* @param Client $client
*
* @throws DatabaseException
*/
public function __construct($name, Client $client)
{
$this->client = $client;
if (!$name) {
if (empty($name)) {
throw new \InvalidArgumentException('No database name provided');
}
$this->name = $name;
$this->name = $name;
$this->client = $client;
}
/**
* @return string db name
* @return string
*/
public function getName()
{
@@ -73,11 +65,9 @@ class Database
/**
* Query influxDB
*
* @param string $query
* @param array $params
*
* @param string $query
* @param array $params
* @return ResultSet
*
* @throws Exception
*/
public function query($query, $params = array())
@@ -88,10 +78,8 @@ class Database
/**
* Create this database
*
* @param RetentionPolicy $retentionPolicy
*
* @param RetentionPolicy $retentionPolicy
* @return ResultSet
*
* @throws DatabaseException
* @throws Exception
*/
@@ -103,7 +91,6 @@ class Database
if ($retentionPolicy) {
$this->createRetentionPolicy($retentionPolicy);
}
} catch (\Exception $e) {
throw new DatabaseException(
sprintf('Failed to created database %s, exception: %s', $this->name, $e->getMessage())
@@ -112,8 +99,7 @@ class Database
}
/**
* @param RetentionPolicy $retentionPolicy
*
* @param RetentionPolicy $retentionPolicy
* @return ResultSet
*/
public function createRetentionPolicy(RetentionPolicy $retentionPolicy)
@@ -124,9 +110,8 @@ class Database
/**
* Writes points into InfluxDB
*
* @param Point[] $points Array of points
* @param string $precision The timestamp precision (defaults to nanoseconds)
*
* @param Point[] $points Array of points
* @param string $precision The timestamp precision (defaults to nanoseconds)
* @return bool
* @throws Exception
*/
@@ -135,8 +120,7 @@ class Database
$payload = array();
foreach ($points as $point) {
if (!$point instanceof Point) {
if (! $point instanceof Point) {
throw new \InvalidArgumentException('An array of Point[] should be passed');
}
@@ -166,7 +150,6 @@ class Database
/**
* @return array
*
* @throws Exception
*/
public function listRetentionPolicies()
@@ -174,7 +157,6 @@ class Database
return $this->query(sprintf('SHOW RETENTION POLICIES %s', $this->name))->getPoints();
}
/**
* Drop this database
*/
@@ -202,9 +184,8 @@ class Database
}
/**
* @param $method
* @param RetentionPolicy $retentionPolicy
*
* @param string $method
* @param RetentionPolicy $retentionPolicy
* @return string
*/
protected function getRetentionPolicyQuery($method, RetentionPolicy $retentionPolicy)
@@ -229,5 +210,4 @@ class Database
return $query;
}
}
}
src/InfluxDB/Database/Exception.php
+4 -6
View File
@@ -1,12 +1,10 @@
<?php
/**
* @author Stephen "TheCodeAssassin" Hoogendijk
*/
namespace InfluxDB\Database;
/**
* @author Stephen "TheCodeAssassin" Hoogendijk
*/
class Exception extends \InfluxDB\Exception
{
}
}
src/InfluxDB/Database/RetentionPolicy.php
+8 -9
View File
@@ -1,7 +1,4 @@
<?php
/**
* @author Stephen "TheCodeAssassin" Hoogendijk
*/
namespace InfluxDB\Database;
@@ -9,6 +6,7 @@ namespace InfluxDB\Database;
* Class RetentionPolicy
*
* @package InfluxDB\Database
* @author Stephen "TheCodeAssassin" Hoogendijk
*/
class RetentionPolicy
{
@@ -16,20 +14,22 @@ class RetentionPolicy
* @var string
*/
public $name;
/**
* @var string
*/
public $duration;
/**
* @var int
*/
public $replication;
/**
* @var bool
*/
public $default;
/**
* @param string $name
* @param string $duration
@@ -40,10 +40,9 @@ class RetentionPolicy
*/
public function __construct($name, $duration = '1d', $replication = 1, $default = false)
{
$this->name = $name;
$this->duration = $duration;
$this->name = $name;
$this->duration = $duration;
$this->replication = $replication;
$this->default = (bool) $default;
$this->default = (bool) $default;
}
}
}
src/InfluxDB/Exception.php
+4 -6
View File
@@ -1,12 +1,10 @@
<?php
/**
* @author Stephen "TheCodeAssassin" Hoogendijk
*/
namespace InfluxDB;
/**
* @author Stephen "TheCodeAssassin" Hoogendijk
*/
class Exception extends \Exception
{
}
}
src/InfluxDB/Point.php
+45 -23
View File
@@ -11,42 +11,51 @@ use InfluxDB\Database\Exception as DatabaseException;
*/
class Point
{
/**
* @var string
*/
private $measurement;
/**
* @var array
*/
private $tags = array();
/**
* @var array
*/
private $fields = array();
/**
* @var string
*/
private $timestamp = null;
private $timestamp;
/**
* The timestamp is optional.
* If you do not specify a timestamp the server’s local timestamp will be used
*
* @param string $measurement Name of the measurement
* @param float $value Value of the measurement
* @param array $tags Array of tags
* @param array $additionalFields Array of optional fields
* @param int $timestamp Optional timestamp
* The timestamp is optional. If you do not specify a timestamp the server’s
* local timestamp will be used
*
* @param string $measurement
* @param float $value
* @param array $tags
* @param array $additionalFields
* @param null $timestamp
* @throws DatabaseException
*/
public function __construct($measurement, $value, array $tags = array(), array $additionalFields = array(), $timestamp = null)
{
public function __construct(
$measurement,
$value,
array $tags = array(),
array $additionalFields = array(),
$timestamp = null
) {
if (empty($measurement)) {
throw new DatabaseException('Invalid measurement name provided');
}
$this->measurement = (string) $measurement;
$this->tags = $tags;
$this->fields = $additionalFields;
$this->tags = $tags;
$this->fields = $additionalFields;
$this->fields += array('value' => (float) $value);
@@ -72,7 +81,7 @@ class Point
$string .= ',' . $this->arrayToString($this->tags);
}
$string .= ' ' .$this->arrayToString($this->fields);
$string .= ' ' . $this->arrayToString($this->fields);
if ($this->timestamp) {
$string .= ' '.$this->timestamp;
@@ -81,26 +90,39 @@ class Point
return $string;
}
/**
* @param array $arr
* @return string
*/
private function arrayToString(array $arr)
{
$strParts = array();
foreach ($arr as $key => $value) {
$strParts[] = "{$key}={$value}";
$strParts[] = sprintf('%s=%s', $key, $value);
}
return implode(",", $strParts);
return implode(',', $strParts);
}
/**
* @param $timestamp
*
* @param int $timestamp
* @return bool
*/
private function isValidTimeStamp($timestamp)
{
return ((int) $timestamp === $timestamp)
&& ($timestamp <= PHP_INT_MAX)
&& ($timestamp >= ~PHP_INT_MAX);
if ((int) $timestamp === $timestamp) {
return true;
}
if ($timestamp <= PHP_INT_MAX) {
return true;
}
if ($timestamp >= ~PHP_INT_MAX) {
return true;
}
return false;
}
}
}
src/InfluxDB/Query/Builder.php
+45 -31
View File
@@ -1,7 +1,4 @@
<?php
/**
* @author Stephen "TheCodeAssassin" Hoogendijk <s.hoogendijk@tech.leaseweb.com>
*/
namespace InfluxDB\Query;
@@ -24,16 +21,43 @@ use InfluxDB\ResultSet;
* @todo add merge
*
* @package InfluxDB\Query
* @author Stephen "TheCodeAssassin" Hoogendijk <s.hoogendijk@tech.leaseweb.com>
*/
class Builder
{
/**
* @var Database
*/
protected $db;
protected $db = null;
/**
* @var string
*/
protected $selection = '*';
/**
* @var string[]
*/
protected $where = array();
protected $startTime = null;
protected $endTime = null;
protected $metric = null;
/**
* @var string
*/
protected $startTime;
/**
* @var string
*/
protected $endTime;
/**
* @var string
*/
protected $metric;
/**
* @var string
*/
protected $limitClause = '';
/**
@@ -45,8 +69,7 @@ class Builder
}
/**
* @param string $metric The metric to select (required)
*
* @param string $metric The metric to select (required)
* @return $this
*/
public function from($metric)
@@ -63,8 +86,7 @@ class Builder
*
* $series->select('sum(value)',
*
* @param string $customSelect
*
* @param string $customSelect
* @return $this
*/
public function select($customSelect)
@@ -83,7 +105,6 @@ class Builder
*/
public function where(array $conditions)
{
foreach ($conditions as $condition) {
$this->where[] = $condition;
}
@@ -92,8 +113,7 @@ class Builder
}
/**
* @param string $field
*
* @param string $field
* @return $this
*/
public function count($field = 'type')
@@ -104,8 +124,7 @@ class Builder
}
/**
* @param string $field
*
* @param string $field
* @return $this
*/
public function median($field = 'type')
@@ -116,8 +135,7 @@ class Builder
}
/**
* @param string $field
*
* @param string $field
* @return $this
*/
public function mean($field = 'type')
@@ -128,8 +146,7 @@ class Builder
}
/**
* @param string $field
*
* @param string $field
* @return $this
*/
public function sum($field = 'type')
@@ -140,8 +157,7 @@ class Builder
}
/**
* @param string $field
*
* @param string $field
* @return $this
*/
public function first($field = 'type')
@@ -152,8 +168,7 @@ class Builder
}
/**
* @param string $field
*
* @param string $field
* @return $this
*/
public function last($field = 'type')
@@ -166,9 +181,8 @@ class Builder
/**
* Set's the time range to select data from
*
* @param int $from Unix timestamp from
* @param int $to Unix timestamp to
*
* @param int $from
* @param int $to
* @return $this
*/
public function setTimeRange($from, $to)
@@ -207,7 +221,6 @@ class Builder
return $this;
}
/**
* @return string
*/
@@ -233,12 +246,13 @@ class Builder
{
$query = sprintf("SELECT %s FROM %s", $this->selection, $this->metric);
if (!$this->metric) {
if (! $this->metric) {
throw new \InvalidArgumentException('No metric provided to from()');
}
for ($i=0; $i < count($this->where); $i++) {
for ($i = 0; $i < count($this->where); $i++) {
$selection = 'WHERE';
if ($i > 0) {
$selection = 'AND';
}
@@ -254,4 +268,4 @@ class Builder
return $query;
}
}
}
src/InfluxDB/Query/Exception.php
+4 -6
View File
@@ -1,12 +1,10 @@
<?php
/**
* @author Stephen "TheCodeAssassin" Hoogendijk
*/
namespace InfluxDB\Query;
/**
* @author Stephen "TheCodeAssassin" Hoogendijk
*/
class Exception extends \InfluxDB\Exception
{
}
}
src/InfluxDB/ResultSet.php
+22 -41
View File
@@ -1,7 +1,4 @@
<?php
/**
* @author Stephen "TheCodeAssassin" Hoogendijk
*/
namespace InfluxDB;
@@ -11,49 +8,42 @@ use InfluxDB\Client\Exception as ClientException;
* Class ResultSet
*
* @package InfluxDB
* @author Stephen "TheCodeAssassin" Hoogendijk
*/
class ResultSet
{
/**
* @var string
*/
protected $raw = '';
/**
* @var array|mixed
*/
protected $parsedResults = array();
/**
* @param $raw
*
* @param string $raw
* @throws \InvalidArgumentException
* @throws Exception
*/
public function __construct($raw)
{
$this->raw = $raw;
$this->parsedResults = json_decode($raw, true);
$this->parsedResults = json_decode((string) $raw, true);
if (json_last_error() !== JSON_ERROR_NONE) {
throw new \InvalidArgumentException("Invalid JSON");
throw new \InvalidArgumentException('Invalid JSON');
}
// There was an error in the query thrown by influxdb
if (isset($this->parsedResults['error'])) {
throw new ClientException($this->parsedResults['error']);
}
// Check if there are errors in the first serie
} elseif (isset($this->parsedResults['results'][0]['error'])) {
// Check if there are errors in the first serie
if (isset($this->parsedResults['results'][0]['error'])) {
throw new ClientException($this->parsedResults['results'][0]['error']);
}
}
/**
* @param $metricName
* @param array $tags
*
* @param $metricName
* @param array $tags
* @return array $points
*/
public function getPoints($metricName = '', array $tags = array())
@@ -62,7 +52,6 @@ class ResultSet
$series = $this->getSeries();
foreach ($series as $serie) {
if ((empty($metricName) && empty($tags)
|| $serie['name'] == $metricName
|| (isset($serie['tags']) && array_intersect($tags, $serie['tags'])))
@@ -82,30 +71,26 @@ class ResultSet
* each containing the keys for a series
*
* @throws Exception
*
* @return array $series
*/
public function getSeries()
{
$pickSeries = function ($object) {
if (isset($object['error'])) {
throw new ClientException($object['error']);
}
return (isset($object['series']) ? $object['series'] : array());
};
// we use array_shift because of compatibility with php5.3
// Foreach object, pick series key
$map = array_map($pickSeries, $this->parsedResults['results']);
return array_shift(
$map
array_map(
function ($object) {
if (isset($object['error'])) {
throw new ClientException($object['error']);
}
return isset($object['series']) ? $object['series'] : array();
},
$this->parsedResults['results']
)
);
}
/**
* @param array $serie
* @param array $serie
* @return array
*/
private function getPointsFromSerie(array $serie)
@@ -113,13 +98,9 @@ class ResultSet
$points = array();
foreach ($serie['values'] as $point) {
$points[] = array_combine(
$serie['columns'],
$point
);
$points[] = array_combine($serie['columns'], $point);
}
return $points;
}
}
}