diff --git a/docs/config/http-dumps.md b/docs/config/http-dumps.md index 859d404..f3e9c4e 100644 --- a/docs/config/http-dumps.md +++ b/docs/config/http-dumps.md @@ -13,4 +13,25 @@ For instance, let's say you have a POST request: `http://http-dump@127.0.0.1:800 server will intercept the request and capture all the relevant information. It will then display the dumped data, allowing you to examine the request details, including the URI segments (`user/3/update` in this example). -![http dumps](https://github.com/buggregator/server/assets/773481/fc823390-b490-4bbb-a787-44471eca9fb6) \ No newline at end of file +![http dumps](https://github.com/buggregator/server/assets/773481/fc823390-b490-4bbb-a787-44471eca9fb6) + +## Client configuration + +There are several ways to say Buggregator that your request is a dump request: + +### Using http auth + +Add `http-dump` to the host name, e.g. `http://http-dump@...` + +```curl +curl --location 'http://http-dump@127.0.0.1:8000?foo=bar' +``` + +### Using header + +Add a header `X-Buggregator-Event` with value `http-dump` + +```curl +curl --location 'http://127.0.0.1:8000?foo=bar' \ + --header 'X-Buggregator-Event: http-dump' +``` \ No newline at end of file diff --git a/docs/config/xhprof.md b/docs/config/xhprof.md index 55a0811..598a9bf 100644 --- a/docs/config/xhprof.md +++ b/docs/config/xhprof.md @@ -51,5 +51,23 @@ configure the profiler. ```dotenv PROFILER_ENDPOINT=http://profiler@127.0.0.1:8000 -PROFILER_APP_NAME=My super app +PROFILER_APP_NAME="My super app" ``` + +## Client configuration + +When integrating with Buggregator, especially if you're developing a custom client, it's essential to understand how to +correctly configure the data transmission. This guide outlines various methods to designate your requests as xhprof +requests + +### Using HTTP auth + +Add `profiler` to the host name, e.g. `http://profiler@...` + +### Using header + +Add a header `X-Buggregator-Event` with value `profiler` or just add `X-Profiler-Dump` with any value. + +### Special endpoint + +You can use special endpoint `/profiler/store` to send data to Buggregator. \ No newline at end of file