Skip to content

Commit

Permalink
Merge pull request #480 from perftools/0.20.x-merge-up-into-0.21.x_QZ…
Browse files Browse the repository at this point in the history
…wVThhl
  • Loading branch information
glensc committed Jun 6, 2022
2 parents 353ee03 + 777306e commit f94faa4
Showing 1 changed file with 12 additions and 14 deletions.
26 changes: 12 additions & 14 deletions README.md
Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand Down

0 comments on commit f94faa4

Please sign in to comment.