update debugging explainer with debugging data #157
Conversation
|
Should we add the BYOB logging details here as well? |
Co-authored-by: Akshay Pundle <[email protected]>
How that works? it should work in same way as existing UDF logs? |
|
BYOB logging should be a follow up update after full details are internally finalized. |
|
|
||
| Each server has `PS_VERBOSITY` flag, which sets the verbosity level of the output logs. A higher verbosity will give more logging data, but can also slow down request processing. This is especially relevant in `non_prod` builds because there can be large volume of request logs. At high QPS, we recommend setting `PS_VERBOSITY` `<=3`. | ||
|
|
||
| 2. Event message |
There was a problem hiding this comment.
Should we call this "Request/Response export"?
There was a problem hiding this comment.
There can be others in the Event message, like udf log and kv signal.
| This is a [structured proto message](https://github.com/privacysandbox/bidding-auction-servers/blob/e40a4fccdce168379189ab7b6b87b55b1e3f736d/api/bidding_auction_servers.proto#L1582) to include the API proto object. | ||
| It is written to cloud storage through Open Telemetry log collector([example config](https://github.com/privacysandbox/bidding-auction-servers/blob/main/production/deploy/gcp/terraform/services/autoscaling/collector_startup.tftpl)) for [AdTech consented debugging](#adtech-consented-debugging). | ||
|
|
||
| 3. Adtech UDF Log |
There was a problem hiding this comment.
We shoul dmention which UDFs in the text below.
There was a problem hiding this comment.
This should include all the UDFs
|
|
||
| 3. Adtech UDF Log | ||
|
|
||
| This is the log from javascript `console.log`. They are only exported for [AdTech consented debugging](#adtech-consented-debugging), through both Request logs and Event message. |
There was a problem hiding this comment.
What is Request log in this context? Is it system log?
There was a problem hiding this comment.
it is mentioned above under "Verbose logs" - Log types - Request logs
|
Sorry, I think I got a bit confused by request log. So, we are saying that we have:
Do you think we should try to clarify the difference between 2) and 3)? I know you called 3) as "Event message" in your original documentation... |
Co-authored-by: Akshay Pundle <[email protected]>
we can clarify with this: |
No description provided.