GAX: Debug Logging improvements
@Hectorhammett is already working on this.
Since Dec 11, 2024.
Assessment
This issue has not been assessed yet.
Description
A few things to keep track of for improving Debug Logging for next year:
- Remove logging of client configuration when
OperationsClientis created by GAPIC clients (this is a tricky issue that will require some consideration) - Create a standalone logging library (e.g.
StructuredLoggingEventor something similar) based on https://cloud.google.com/logging/docs/structured-logging - Test the logging in
GrpcFallbackTransport - Consider logging Response Status Code ONLY when logger level is set to
INFO - Add back
readonlytoRpcLogEvent::$timestampandRpcLogEvent::$millisecondsonce we drop support for PHP 8.0 - Add a static method to get the
requestIdinstead of repeating "crc32((string) spl_object_id($request) . getmypid())" every time.- NOTE: There are some places which use the requestID, like
RestTransport, which do not implementLoggingTrait, and so if we wanted one place for it to be generated, we would need a static method somewhere instead. Could be a private method likeLoggingTrait::getRequestId, or a public static method such asRpcLogEvent::getRequestId($request).
- NOTE: There are some places which use the requestID, like
- Verify what types of requests/responses ClientStream/BidiStream can accept and potentially tighten the typing and/or log them (right now it only logs requests of type
Message) - Look into why REST JSON responses contain newlines (might be in Guzzle), and if we can strip them.
- Dominant language
- PHP
- Stars
- 1.2k
- Forks
- 464
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 103
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from googleapis/google-cloud-php
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
googleapis/google-cloud-php#9730 ·
-
type: feature request
Difficulty 1/5 Under an hour Newbie friendliness 75/100
googleapis/google-cloud-php#9716 · 11 reactions ·
-
Difficulty 3/5 1-2 days Newbie friendliness 65/100
googleapis/google-cloud-php#9725 ·
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
googleapis/google-cloud-php#9675 · 1 comment ·
-
Difficulty 4/5 3-5 days Newbie friendliness 55/100
googleapis/google-cloud-php#9674 · 1 comment ·
All issues in googleapis/google-cloud-php
Similar issues
-
tooling
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
UX
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
ProfessionalWiki/NeoWiki#1525 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
OpenConext/OpenConext-engineblock#2122 ·
-
Bug
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
Automattic/safe-publish#594 ·