Skip to content

Commit 6844863

Browse files
committed
Add import script documentation
1 parent a35259f commit 6844863

1 file changed

Lines changed: 19 additions & 1 deletion

File tree

README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ In order to profile your application, you need to:
2626
- [Install profiler extension](#installing-profilers)
2727
- [Instantiate the profiler](#create-profiler)
2828
- [Configure saver to send data to XHGui](#savers)
29+
- [Import jsonl files](#import-jsonl-files) (optional)
2930

3031
## Installation
3132

@@ -202,7 +203,7 @@ Example config:
202203
),
203204
```
204205

205-
To import a saved files, use XHGui's provided `external/import.php` script.
206+
To import a saved files, see [Import jsonl files](#import-jsonl-files) section.
206207

207208
### MongoDB Saver
208209

@@ -292,6 +293,23 @@ class StdOutSaver implements SaverInterface
292293
$profiler->setSaver(new StdOutSaver());
293294
```
294295

296+
### Import jsonl files
297+
298+
You can use `./bin/import.php` script to submit files saved by [File Saver](#file-saver) to XHGui server.
299+
300+
1. [Setup config file](#using-config-file)
301+
1. Configure to use [Upload Saver](#upload-saver)
302+
1. Execute the `./bin/import.php` script
303+
304+
The script can take multiple [jsonl] formatted files, or if none given read stdin stream.
305+
306+
```sh
307+
$ ./bin/import.php tests/tmp/php-profiler-xhgui-test-1596093567.787220-c857.json
308+
Imported 1 lines
309+
```
310+
311+
[jsonl]: https://jsonlines.org/
312+
295313
## Configure Profiling Rate
296314

297315
You may want to change how frequently you profile the application. The

0 commit comments

Comments
 (0)