Feature/monitor manager (#30)

Added monitor manager

Added getMetrics function to retrieve Prometheus metrics from the database

Performance: Sped up JSON decoding for responses smaller than 1MB (configurable)

Author: LaravelFreelancerNL

.github/workflows/coverage.yml

@@ -38,6 +38,6 @@ jobs:
 
       - name: Test coverage
         run: |
-          vendor/bin/phpunit --coverage-clover clover.xml --whitelist src
+          composer test:coverage
           echo "Upload results to Scrutinizer-ci"
           vendor/bin/ocular code-coverage:upload --format=php-clover clover.xml

.github/workflows/fix-code-style.yml

@@ -38,7 +38,7 @@ jobs:
       - name: Fix style
         if: ${{ always() }}
         run: |
-          "${GITHUB_WORKSPACE}/vendor/bin/pint"
+          composer style
 
       - name: Commit changes
         uses: stefanzweifel/git-auto-commit-action@v5

.github/workflows/quality-assurance.yml

@@ -36,5 +36,4 @@ jobs:
       - name: Run all QA tests
         if: ${{ always() }}
         run: |
-          chmod +x "${GITHUB_WORKSPACE}/bin/qa.sh"
-          "${GITHUB_WORKSPACE}/bin/qa.sh"
+          composer analyse

.github/workflows/run-tests.yml

@@ -12,7 +12,7 @@ jobs:
       fail-fast: true
       matrix:
         os: [ubuntu-latest]
-        arangodb: ["3.10", 3.11]
+        arangodb: ["3.10", 3.11, 3.12]
         php: [8.1, 8.2, 8.3]
         stability: [prefer-stable]
 

.gitignore

@@ -1,11 +1,13 @@
+.env
+.env.backup
 .idea
 .php_cs
 .php_cs.cache
 .phpunit.result.cache
 .vscode
-.env
-.env.backup
+clover.xml
 composer.lock
+ray.php
 /build
 /coverage
 /vendor

README.md

@@ -70,6 +70,12 @@ The admin manager manages administrative functions and information retrieval for
 $client->admin()->version();
 ```
 
+### Monitor manager
+The monitor manager manages monitoring functions the server/cluster.
+``` 
+$client->monitor()->getMetrics();
+```
+
 ### Schema manager
 The schema manager manages all schema related operations.
 ``` 
@@ -86,15 +92,16 @@ $client->transactions()->begin(['write' => ['users', 'teams']]);
 1) [ArangoDB PHP client](docs/arangodb-client.md)
 2) [AQL query statements](docs/statements.md)
 3) [Admin manager](docs/admin-manager.md)
-4) Schema manager
+4) [Monitor manager](docs/monitor-manager.md)
+5Schema manager
     1) [Database schema](docs/schema-databases.md)
     2) [User schema](docs/schema-users.md)
     3) [Collection schema](docs/schema-collections.md)
     4) [Index schema](docs/schema-indexes.md)
     5) [Graph schema](docs/schema-graphs.md)
     6) [View schema](docs/schema-views.md)
     7) [Analyzer schema](docs/schema-analyzers.md)
-5) [Transaction manager](docs/transaction-manager.md)
+6[Transaction manager](docs/transaction-manager.md)
 
 ## Related packages
 * [AQL query builder](https://github.com/LaravelFreelancerNL/fluentaql)

bin/qa.sh

@@ -21,7 +21,8 @@
         "ext-json": "*",
         "guzzlehttp/guzzle": "^7.3",
         "halaxa/json-machine": "^1.0",
-        "spatie/data-transfer-object": "^3.9"
+        "spatie/data-transfer-object": "^3.9",
+        "spatie/ray": "^1.41"
     },
     "require-dev": {
         "laravel/pint": "^1.2.1",
@@ -45,7 +46,7 @@
     "scripts": {
         "analyse": "vendor/bin/phpstan analyse",
         "test": "vendor/bin/phpunit",
-        "test-coverage": "vendor/bin/phpunit --coverage",
+        "test:coverage": "vendor/bin/phpunit --coverage-clover clover.xml --whitelist src",
         "style": "vendor/bin/pint"
     },
     "config": {

composer.json

@@ -13,6 +13,7 @@ Upon creation, you can alter the default configuration of the client. The follow
 * username = null
 * password = null
 * database = '_system'
+* responseSizeDecoderSwitch = 1 * 1024 * 1024
 
 ```
 $config = [
@@ -25,6 +26,15 @@ $config = [
 $arangoClient = new ArangoClient($config);
 ```
 
+### Speed vs response size
+JSON response decoding is normally done by the default json_decode method. This method
+is optimized for speed and can take a large amount of memory; up to ~ 20x of the JSON size.
+
+Therefor we use halaxa/json-machine to stream decode for responses larger than 1MB.
+You can alter this cutoff by setting the `responseSizeDecoderSwitch` to a different size in **Bytes**.
+
+This removed any memory issues at the cost of speed.
+
 ### Support Guzzle configuration
 In addition to the above mentioned options you can use the following Guzzle 7 specific options:
 * [version](https://docs.guzzlephp.org/en/stable/request-options.html#version)

docs/arangodb-client.md

@@ -0,0 +1,13 @@
+# Monitor manager
+
+Manages monitoring functions for the server/cluster.
+
+## Functions
+The monitor manager supports the following functions:
+
+### getMetrics(): Metrics
+Get Prometheus metrics of the server
+
+```
+$arangoClient->monitor()->getMetrics();
+```