Skip to content

feat: add client debug logging support for server side streaming REST calls #2340

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
parthea merged 5 commits into from
May 9, 2025
Merged

feat: add client debug logging support for server side streaming REST calls #2340

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8b5c863
feat: add client debug logging support for unary-stream REST calls
parthea Feb 19, 2025
6478506
add comment
parthea Mar 31, 2025
0dda26a
Update gapic/templates/%namespace/%name_%version/%sub/services/%servi…
parthea May 9, 2025
58d6a89
update comments
parthea May 9, 2025
a20e709
Merge branch 'main' into add-unary-stream-logging-rest
parthea May 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions gapic/templates/%namespace/%name_%version/%sub/services/%service/transports/rest.py.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,17 +258,25 @@ class {{service.name}}RestTransport(_Base{{ service.name }}RestTransport):
resp = self._interceptor.post_{{ method.name|snake_case }}(resp)
response_metadata = [(k, str(v)) for k, v in response.headers.items()]
resp, _ = self._interceptor.post_{{ method.name|snake_case }}_with_metadata(resp, response_metadata)
{# TODO(https://github.com/googleapis/gapic-generator-python/issues/2279): Add logging support for rest streaming. #}
{% if not method.server_streaming %}
if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER
{# Logging of the streaming response payload is in `google-api-core` because the response #}
Copy link
Contributor

@vchudnov-g vchudnov-g Apr 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Depending how we want to log (a) receiving a streaming response vs (b) exposing the next streamed item to the user, we could possibly want to log something here
(a) should always happen in api-core
(b) could happen in api-core, or it could happen here when we iterate to the next streamed item that was previously received.

Ditto for async

Copy link
Contributor Author

@parthea parthea May 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I filed #2389 to follow up on this and I also captured this comment in the code.

Copy link
Contributor Author

@parthea parthea May 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated comments in 58d6a89

{# type `rest_streaming.ResponseIterator` is an iterator. #}
{# Each response 'item' is logged at the time that it is fetched which happens in google-api-core. #}
{% if not method.server_streaming %}
try:
response_payload = {% if method.output.ident.is_proto_plus_type %}{{ method.output.ident }}.to_json(response){% else %}json_format.MessageToJson(resp){% endif %}

except:
{# TODO(https://github.com/googleapis/gapic-generator-python/issues/2283): Remove try/except once unit tests are updated. #}
response_payload = None
{% endif %}{# if not method.server_streaming #}
http_response = {
{# Logging of the streaming response payload is in `google-api-core` because the response #}
{# type `rest_streaming.ResponseIterator` is an iterator. #}
{# Each response 'item' is logged at the time that it is fetched which happens in google-api-core. #}
{% if not method.server_streaming %}
"payload": response_payload,
{% endif %}{# if not method.server_streaming #}
"headers": dict(response.headers),
"status": response.status_code,
}
Expand All @@ -282,7 +290,6 @@ class {{service.name}}RestTransport(_Base{{ service.name }}RestTransport):
"httpResponse": http_response,
},
)
{% endif %}{# if not method.server_streaming #}
return resp

{% endif %}{# method.void #}
Expand Down
13 changes: 10 additions & 3 deletions .../templates/%namespace/%name_%version/%sub/services/%service/transports/rest_asyncio.py.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,17 +219,25 @@ class Async{{service.name}}RestTransport(_Base{{ service.name }}RestTransport):
resp = await self._interceptor.post_{{ method.name|snake_case }}(resp)
response_metadata = [(k, str(v)) for k, v in response.headers.items()]
resp, _ = await self._interceptor.post_{{ method.name|snake_case }}_with_metadata(resp, response_metadata)
{# TODO(https://github.com/googleapis/gapic-generator-python/issues/2279): Add logging support for rest streaming. #}
{% if not method.server_streaming %}
if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(logging.DEBUG): # pragma: NO COVER
{# Logging of the streaming response payload is in `google-api-core` because the response #}
{# type `rest_streaming_async.AsyncResponseIterator` is an iterator. #}
{# Each response 'item' is logged at the time that it is fetched which happens in google-api-core. #}
{% if not method.server_streaming %}
try:
response_payload = {% if method.output.ident.is_proto_plus_type %}{{ method.output.ident }}.to_json(response){% else %}json_format.MessageToJson(resp){% endif %}

except:
{# TODO(https://github.com/googleapis/gapic-generator-python/issues/2283): Remove try/except once unit tests are updated. #}
response_payload = None
{% endif %}{# if not method.server_streaming #}
http_response = {
{# Logging of the streaming response payload is in `google-api-core` because the response #}
{# type `rest_streaming_async.AsyncResponseIterator` is an iterator. #}
{# Each response 'item' is logged at the time that it is fetched which happens in google-api-core. #}
{% if not method.server_streaming %}
"payload": response_payload,
{% endif %}{# if not method.server_streaming #}
"headers": dict(response.headers),
"status": "OK", # need to obtain this properly
}
Expand All @@ -243,7 +251,6 @@ class Async{{service.name}}RestTransport(_Base{{ service.name }}RestTransport):
},
)

{% endif %}{# if not method.server_streaming #}
return resp

{% endif %}{# method.void #}
Expand Down
Loading