From e75aa5799b4a6daaf54522952b23b9fa2a2de549 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Elan=20Ruusam=C3=A4e?= Date: Wed, 1 Jun 2022 01:32:04 +0300 Subject: [PATCH 1/2] Docs: Deprecate external/import.php from this project --- README.md | 24 +++++++++++------------- 1 file changed, 11 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index dbd3b8dc..b2e29c22 100644 --- a/README.md +++ b/README.md @@ -184,28 +184,26 @@ server { # Profiling a Web Request or CLI script -The recommended way tho profile an application is to use [perftools/php-profiler] package. +The supported way to profile an application is to use [perftools/php-profiler] +package. -You can use that package to collect data from your web applications and CLI -scripts. +You can use that package to collect data from your web application or a CLI +script. -This data is then pushed into XHGui database where it can be viewed with this +This data is then pushed into XHGui database where it can be viewed with XHGui application. -It offers submitting data directly to XHGui instance once the profiling is -complete at the end of the request. +The `php-profiler` package offers submitting data directly to XHGui instance +once the profiling is complete at the end of the request. -If the site cannot directly connect to XHGui instance, the package offers -solution to capture profiling data to file which you can import using -`external/import.php` script: - -```bash -php external/import.php -f /path/to/jsonlinesfile.jsonl -``` +If the application cannot directly connect to XHGui instance, the package +offers solution to capture profiling data to a file which you can import later +using the [import][import-jsonl-files] script. **Warning**: Importing the same file twice will create duplicate profiles. [perftools/php-profiler]: https://github.com/perftools/php-profiler +[import-jsonl-files]: https://github.com/perftools/php-profiler#import-jsonl-files ## Limiting MongoDB Disk Usage From b7482f1fdb23868184741871496a8b7086761baf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Elan=20Ruusam=C3=A4e?= Date: Wed, 1 Jun 2022 01:41:01 +0300 Subject: [PATCH 2/2] Fix version typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b2e29c22..9c9628f1 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ backend. The default installation uses MongoDB database. Most of the documentation speaks about MongoDB. - [MongoDB Extension][ext-mongodb] MongoDB PHP driver: `pecl install mongodb` - XHGui requires verison 1.3.0 or later. + XHGui requires version 1.3.0 or later. - [MongoDB][mongodb] MongoDB Itself. XHGui requires version 3.2 or later. [ext-mongodb]: https://pecl.php.net/package/mongodb