Skip to content

Commit

Permalink
Docs: Deprecate external/import.php from this project
Browse files Browse the repository at this point in the history
  • Loading branch information
glensc committed May 31, 2022
1 parent 5b8516b commit e75aa57
Showing 1 changed file with 11 additions and 13 deletions.
24 changes: 11 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
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 e75aa57

Please sign in to comment.