Shortcuts on this page
r m x toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
1# -*- coding: utf-8 -*-
2# Copyright 2025 Google LLC
3#
4# Licensed under the Apache License, Version 2.0 (the "License");
5# you may not use this file except in compliance with the License.
6# You may obtain a copy of the License at
7#
8# http://www.apache.org/licenses/LICENSE-2.0
9#
10# Unless required by applicable law or agreed to in writing, software
11# distributed under the License is distributed on an "AS IS" BASIS,
12# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13# See the License for the specific language governing permissions and
14# limitations under the License.
15#
16import json
17import logging as std_logging
18import pickle
19import warnings
20from typing import Callable, Dict, Optional, Sequence, Tuple, Union
22from google.api_core import grpc_helpers
23from google.api_core import gapic_v1
24import google.auth # type: ignore
25from google.auth import credentials as ga_credentials # type: ignore
26from google.auth.transport.grpc import SslCredentials # type: ignore
27from google.protobuf.json_format import MessageToJson
28import google.protobuf.message
30import grpc # type: ignore
31import proto # type: ignore
33from google.cloud.logging_v2.types import logging
34from google.longrunning import operations_pb2 # type: ignore
35from google.protobuf import empty_pb2 # type: ignore
36from .base import LoggingServiceV2Transport, DEFAULT_CLIENT_INFO
38try:
39 from google.api_core import client_logging # type: ignore
41 CLIENT_LOGGING_SUPPORTED = True # pragma: NO COVER
42except ImportError: # pragma: NO COVER
43 CLIENT_LOGGING_SUPPORTED = False
45_LOGGER = std_logging.getLogger(__name__)
48class _LoggingClientInterceptor(grpc.UnaryUnaryClientInterceptor): # pragma: NO COVER
49 def intercept_unary_unary(self, continuation, client_call_details, request):
50 logging_enabled = CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor(
51 std_logging.DEBUG
52 )
53 if logging_enabled: # pragma: NO COVER
54 request_metadata = client_call_details.metadata
55 if isinstance(request, proto.Message):
56 request_payload = type(request).to_json(request)
57 elif isinstance(request, google.protobuf.message.Message):
58 request_payload = MessageToJson(request)
59 else:
60 request_payload = f"{type(request).__name__}: {pickle.dumps(request)}"
62 request_metadata = {
63 key: value.decode("utf-8") if isinstance(value, bytes) else value
64 for key, value in request_metadata
65 }
66 grpc_request = {
67 "payload": request_payload,
68 "requestMethod": "grpc",
69 "metadata": dict(request_metadata),
70 }
71 _LOGGER.debug(
72 f"Sending request for {client_call_details.method}",
73 extra={
74 "serviceName": "google.logging.v2.LoggingServiceV2",
75 "rpcName": client_call_details.method,
76 "request": grpc_request,
77 "metadata": grpc_request["metadata"],
78 },
79 )
81 response = continuation(client_call_details, request)
82 if logging_enabled: # pragma: NO COVER
83 response_metadata = response.trailing_metadata()
84 # Convert gRPC metadata `<class 'grpc.aio._metadata.Metadata'>` to list of tuples
85 metadata = (
86 dict([(k, str(v)) for k, v in response_metadata])
87 if response_metadata
88 else None
89 )
90 result = response.result()
91 if isinstance(result, proto.Message):
92 response_payload = type(result).to_json(result)
93 elif isinstance(result, google.protobuf.message.Message):
94 response_payload = MessageToJson(result)
95 else:
96 response_payload = f"{type(result).__name__}: {pickle.dumps(result)}"
97 grpc_response = {
98 "payload": response_payload,
99 "metadata": metadata,
100 "status": "OK",
101 }
102 _LOGGER.debug(
103 f"Received response for {client_call_details.method}.",
104 extra={
105 "serviceName": "google.logging.v2.LoggingServiceV2",
106 "rpcName": client_call_details.method,
107 "response": grpc_response,
108 "metadata": grpc_response["metadata"],
109 },
110 )
111 return response
114class LoggingServiceV2GrpcTransport(LoggingServiceV2Transport):
115 """gRPC backend transport for LoggingServiceV2.
117 Service for ingesting and querying logs.
119 This class defines the same methods as the primary client, so the
120 primary client can load the underlying transport implementation
121 and call it.
123 It sends protocol buffers over the wire using gRPC (which is built on
124 top of HTTP/2); the ``grpcio`` package must be installed.
125 """
127 _stubs: Dict[str, Callable]
129 def __init__(
130 self,
131 *,
132 host: str = "logging.googleapis.com",
133 credentials: Optional[ga_credentials.Credentials] = None,
134 credentials_file: Optional[str] = None,
135 scopes: Optional[Sequence[str]] = None,
136 channel: Optional[Union[grpc.Channel, Callable[..., grpc.Channel]]] = None,
137 api_mtls_endpoint: Optional[str] = None,
138 client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None,
139 ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None,
140 client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None,
141 quota_project_id: Optional[str] = None,
142 client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO,
143 always_use_jwt_access: Optional[bool] = False,
144 api_audience: Optional[str] = None,
145 ) -> None:
146 """Instantiate the transport.
148 Args:
149 host (Optional[str]):
150 The hostname to connect to (default: 'logging.googleapis.com').
151 credentials (Optional[google.auth.credentials.Credentials]): The
152 authorization credentials to attach to requests. These
153 credentials identify the application to the service; if none
154 are specified, the client will attempt to ascertain the
155 credentials from the environment.
156 This argument is ignored if a ``channel`` instance is provided.
157 credentials_file (Optional[str]): A file with credentials that can
158 be loaded with :func:`google.auth.load_credentials_from_file`.
159 This argument is ignored if a ``channel`` instance is provided.
160 scopes (Optional(Sequence[str])): A list of scopes. This argument is
161 ignored if a ``channel`` instance is provided.
162 channel (Optional[Union[grpc.Channel, Callable[..., grpc.Channel]]]):
163 A ``Channel`` instance through which to make calls, or a Callable
164 that constructs and returns one. If set to None, ``self.create_channel``
165 is used to create the channel. If a Callable is given, it will be called
166 with the same arguments as used in ``self.create_channel``.
167 api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint.
168 If provided, it overrides the ``host`` argument and tries to create
169 a mutual TLS channel with client SSL credentials from
170 ``client_cert_source`` or application default SSL credentials.
171 client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]):
172 Deprecated. A callback to provide client SSL certificate bytes and
173 private key bytes, both in PEM format. It is ignored if
174 ``api_mtls_endpoint`` is None.
175 ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials
176 for the grpc channel. It is ignored if a ``channel`` instance is provided.
177 client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]):
178 A callback to provide client certificate bytes and private key bytes,
179 both in PEM format. It is used to configure a mutual TLS channel. It is
180 ignored if a ``channel`` instance or ``ssl_channel_credentials`` is provided.
181 quota_project_id (Optional[str]): An optional project to use for billing
182 and quota.
183 client_info (google.api_core.gapic_v1.client_info.ClientInfo):
184 The client info used to send a user-agent string along with
185 API requests. If ``None``, then default info will be used.
186 Generally, you only need to set this if you're developing
187 your own client library.
188 always_use_jwt_access (Optional[bool]): Whether self signed JWT should
189 be used for service account credentials.
191 Raises:
192 google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport
193 creation failed for any reason.
194 google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials``
195 and ``credentials_file`` are passed.
196 """
197 self._grpc_channel = None
198 self._ssl_channel_credentials = ssl_channel_credentials
199 self._stubs: Dict[str, Callable] = {}
201 if api_mtls_endpoint:
202 warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning)
203 if client_cert_source:
204 warnings.warn("client_cert_source is deprecated", DeprecationWarning)
206 if isinstance(channel, grpc.Channel):
207 # Ignore credentials if a channel was passed.
208 credentials = None
209 self._ignore_credentials = True
210 # If a channel was explicitly provided, set it.
211 self._grpc_channel = channel
212 self._ssl_channel_credentials = None
214 else:
215 if api_mtls_endpoint:
216 host = api_mtls_endpoint
218 # Create SSL credentials with client_cert_source or application
219 # default SSL credentials.
220 if client_cert_source:
221 cert, key = client_cert_source()
222 self._ssl_channel_credentials = grpc.ssl_channel_credentials(
223 certificate_chain=cert, private_key=key
224 )
225 else:
226 self._ssl_channel_credentials = SslCredentials().ssl_credentials
228 else:
229 if client_cert_source_for_mtls and not ssl_channel_credentials:
230 cert, key = client_cert_source_for_mtls()
231 self._ssl_channel_credentials = grpc.ssl_channel_credentials(
232 certificate_chain=cert, private_key=key
233 )
235 # The base transport sets the host, credentials and scopes
236 super().__init__(
237 host=host,
238 credentials=credentials,
239 credentials_file=credentials_file,
240 scopes=scopes,
241 quota_project_id=quota_project_id,
242 client_info=client_info,
243 always_use_jwt_access=always_use_jwt_access,
244 api_audience=api_audience,
245 )
247 if not self._grpc_channel:
248 # initialize with the provided callable or the default channel
249 channel_init = channel or type(self).create_channel
250 self._grpc_channel = channel_init(
251 self._host,
252 # use the credentials which are saved
253 credentials=self._credentials,
254 # Set ``credentials_file`` to ``None`` here as
255 # the credentials that we saved earlier should be used.
256 credentials_file=None,
257 scopes=self._scopes,
258 ssl_credentials=self._ssl_channel_credentials,
259 quota_project_id=quota_project_id,
260 options=[
261 ("grpc.max_send_message_length", -1),
262 ("grpc.max_receive_message_length", -1),
263 ],
264 )
266 self._interceptor = _LoggingClientInterceptor()
267 self._logged_channel = grpc.intercept_channel(
268 self._grpc_channel, self._interceptor
269 )
271 # Wrap messages. This must be done after self._logged_channel exists
272 self._prep_wrapped_messages(client_info)
274 @classmethod
275 def create_channel(
276 cls,
277 host: str = "logging.googleapis.com",
278 credentials: Optional[ga_credentials.Credentials] = None,
279 credentials_file: Optional[str] = None,
280 scopes: Optional[Sequence[str]] = None,
281 quota_project_id: Optional[str] = None,
282 **kwargs,
283 ) -> grpc.Channel:
284 """Create and return a gRPC channel object.
285 Args:
286 host (Optional[str]): The host for the channel to use.
287 credentials (Optional[~.Credentials]): The
288 authorization credentials to attach to requests. These
289 credentials identify this application to the service. If
290 none are specified, the client will attempt to ascertain
291 the credentials from the environment.
292 credentials_file (Optional[str]): A file with credentials that can
293 be loaded with :func:`google.auth.load_credentials_from_file`.
294 This argument is mutually exclusive with credentials.
295 scopes (Optional[Sequence[str]]): A optional list of scopes needed for this
296 service. These are only used when credentials are not specified and
297 are passed to :func:`google.auth.default`.
298 quota_project_id (Optional[str]): An optional project to use for billing
299 and quota.
300 kwargs (Optional[dict]): Keyword arguments, which are passed to the
301 channel creation.
302 Returns:
303 grpc.Channel: A gRPC channel object.
305 Raises:
306 google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials``
307 and ``credentials_file`` are passed.
308 """
310 return grpc_helpers.create_channel(
311 host,
312 credentials=credentials,
313 credentials_file=credentials_file,
314 quota_project_id=quota_project_id,
315 default_scopes=cls.AUTH_SCOPES,
316 scopes=scopes,
317 default_host=cls.DEFAULT_HOST,
318 **kwargs,
319 )
321 @property
322 def grpc_channel(self) -> grpc.Channel:
323 """Return the channel designed to connect to this service."""
324 return self._grpc_channel
326 @property
327 def delete_log(self) -> Callable[[logging.DeleteLogRequest], empty_pb2.Empty]:
328 r"""Return a callable for the delete log method over gRPC.
330 Deletes all the log entries in a log for the \_Default Log
331 Bucket. The log reappears if it receives new entries. Log
332 entries written shortly before the delete operation might not be
333 deleted. Entries received after the delete operation with a
334 timestamp before the operation will be deleted.
336 Returns:
337 Callable[[~.DeleteLogRequest],
338 ~.Empty]:
339 A function that, when called, will call the underlying RPC
340 on the server.
341 """
342 # Generate a "stub function" on-the-fly which will actually make
343 # the request.
344 # gRPC handles serialization and deserialization, so we just need
345 # to pass in the functions for each.
346 if "delete_log" not in self._stubs:
347 self._stubs["delete_log"] = self._logged_channel.unary_unary(
348 "/google.logging.v2.LoggingServiceV2/DeleteLog",
349 request_serializer=logging.DeleteLogRequest.serialize,
350 response_deserializer=empty_pb2.Empty.FromString,
351 )
352 return self._stubs["delete_log"]
354 @property
355 def write_log_entries(
356 self,
357 ) -> Callable[[logging.WriteLogEntriesRequest], logging.WriteLogEntriesResponse]:
358 r"""Return a callable for the write log entries method over gRPC.
360 Writes log entries to Logging. This API method is the
361 only way to send log entries to Logging. This method is
362 used, directly or indirectly, by the Logging agent
363 (fluentd) and all logging libraries configured to use
364 Logging. A single request may contain log entries for a
365 maximum of 1000 different resources (projects,
366 organizations, billing accounts or folders)
368 Returns:
369 Callable[[~.WriteLogEntriesRequest],
370 ~.WriteLogEntriesResponse]:
371 A function that, when called, will call the underlying RPC
372 on the server.
373 """
374 # Generate a "stub function" on-the-fly which will actually make
375 # the request.
376 # gRPC handles serialization and deserialization, so we just need
377 # to pass in the functions for each.
378 if "write_log_entries" not in self._stubs:
379 self._stubs["write_log_entries"] = self._logged_channel.unary_unary(
380 "/google.logging.v2.LoggingServiceV2/WriteLogEntries",
381 request_serializer=logging.WriteLogEntriesRequest.serialize,
382 response_deserializer=logging.WriteLogEntriesResponse.deserialize,
383 )
384 return self._stubs["write_log_entries"]
386 @property
387 def list_log_entries(
388 self,
389 ) -> Callable[[logging.ListLogEntriesRequest], logging.ListLogEntriesResponse]:
390 r"""Return a callable for the list log entries method over gRPC.
392 Lists log entries. Use this method to retrieve log entries that
393 originated from a project/folder/organization/billing account.
394 For ways to export log entries, see `Exporting
395 Logs <https://cloud.google.com/logging/docs/export>`__.
397 Returns:
398 Callable[[~.ListLogEntriesRequest],
399 ~.ListLogEntriesResponse]:
400 A function that, when called, will call the underlying RPC
401 on the server.
402 """
403 # Generate a "stub function" on-the-fly which will actually make
404 # the request.
405 # gRPC handles serialization and deserialization, so we just need
406 # to pass in the functions for each.
407 if "list_log_entries" not in self._stubs:
408 self._stubs["list_log_entries"] = self._logged_channel.unary_unary(
409 "/google.logging.v2.LoggingServiceV2/ListLogEntries",
410 request_serializer=logging.ListLogEntriesRequest.serialize,
411 response_deserializer=logging.ListLogEntriesResponse.deserialize,
412 )
413 return self._stubs["list_log_entries"]
415 @property
416 def list_monitored_resource_descriptors(
417 self,
418 ) -> Callable[
419 [logging.ListMonitoredResourceDescriptorsRequest],
420 logging.ListMonitoredResourceDescriptorsResponse,
421 ]:
422 r"""Return a callable for the list monitored resource
423 descriptors method over gRPC.
425 Lists the descriptors for monitored resource types
426 used by Logging.
428 Returns:
429 Callable[[~.ListMonitoredResourceDescriptorsRequest],
430 ~.ListMonitoredResourceDescriptorsResponse]:
431 A function that, when called, will call the underlying RPC
432 on the server.
433 """
434 # Generate a "stub function" on-the-fly which will actually make
435 # the request.
436 # gRPC handles serialization and deserialization, so we just need
437 # to pass in the functions for each.
438 if "list_monitored_resource_descriptors" not in self._stubs:
439 self._stubs[
440 "list_monitored_resource_descriptors"
441 ] = self._logged_channel.unary_unary(
442 "/google.logging.v2.LoggingServiceV2/ListMonitoredResourceDescriptors",
443 request_serializer=logging.ListMonitoredResourceDescriptorsRequest.serialize,
444 response_deserializer=logging.ListMonitoredResourceDescriptorsResponse.deserialize,
445 )
446 return self._stubs["list_monitored_resource_descriptors"]
448 @property
449 def list_logs(
450 self,
451 ) -> Callable[[logging.ListLogsRequest], logging.ListLogsResponse]:
452 r"""Return a callable for the list logs method over gRPC.
454 Lists the logs in projects, organizations, folders,
455 or billing accounts. Only logs that have entries are
456 listed.
458 Returns:
459 Callable[[~.ListLogsRequest],
460 ~.ListLogsResponse]:
461 A function that, when called, will call the underlying RPC
462 on the server.
463 """
464 # Generate a "stub function" on-the-fly which will actually make
465 # the request.
466 # gRPC handles serialization and deserialization, so we just need
467 # to pass in the functions for each.
468 if "list_logs" not in self._stubs:
469 self._stubs["list_logs"] = self._logged_channel.unary_unary(
470 "/google.logging.v2.LoggingServiceV2/ListLogs",
471 request_serializer=logging.ListLogsRequest.serialize,
472 response_deserializer=logging.ListLogsResponse.deserialize,
473 )
474 return self._stubs["list_logs"]
476 @property
477 def tail_log_entries(
478 self,
479 ) -> Callable[[logging.TailLogEntriesRequest], logging.TailLogEntriesResponse]:
480 r"""Return a callable for the tail log entries method over gRPC.
482 Streaming read of log entries as they are ingested.
483 Until the stream is terminated, it will continue reading
484 logs.
486 Returns:
487 Callable[[~.TailLogEntriesRequest],
488 ~.TailLogEntriesResponse]:
489 A function that, when called, will call the underlying RPC
490 on the server.
491 """
492 # Generate a "stub function" on-the-fly which will actually make
493 # the request.
494 # gRPC handles serialization and deserialization, so we just need
495 # to pass in the functions for each.
496 if "tail_log_entries" not in self._stubs:
497 self._stubs["tail_log_entries"] = self._logged_channel.stream_stream(
498 "/google.logging.v2.LoggingServiceV2/TailLogEntries",
499 request_serializer=logging.TailLogEntriesRequest.serialize,
500 response_deserializer=logging.TailLogEntriesResponse.deserialize,
501 )
502 return self._stubs["tail_log_entries"]
504 def close(self):
505 self._logged_channel.close()
507 @property
508 def cancel_operation(
509 self,
510 ) -> Callable[[operations_pb2.CancelOperationRequest], None]:
511 r"""Return a callable for the cancel_operation method over gRPC."""
512 # Generate a "stub function" on-the-fly which will actually make
513 # the request.
514 # gRPC handles serialization and deserialization, so we just need
515 # to pass in the functions for each.
516 if "cancel_operation" not in self._stubs:
517 self._stubs["cancel_operation"] = self._logged_channel.unary_unary(
518 "/google.longrunning.Operations/CancelOperation",
519 request_serializer=operations_pb2.CancelOperationRequest.SerializeToString,
520 response_deserializer=None,
521 )
522 return self._stubs["cancel_operation"]
524 @property
525 def get_operation(
526 self,
527 ) -> Callable[[operations_pb2.GetOperationRequest], operations_pb2.Operation]:
528 r"""Return a callable for the get_operation method over gRPC."""
529 # Generate a "stub function" on-the-fly which will actually make
530 # the request.
531 # gRPC handles serialization and deserialization, so we just need
532 # to pass in the functions for each.
533 if "get_operation" not in self._stubs:
534 self._stubs["get_operation"] = self._logged_channel.unary_unary(
535 "/google.longrunning.Operations/GetOperation",
536 request_serializer=operations_pb2.GetOperationRequest.SerializeToString,
537 response_deserializer=operations_pb2.Operation.FromString,
538 )
539 return self._stubs["get_operation"]
541 @property
542 def list_operations(
543 self,
544 ) -> Callable[
545 [operations_pb2.ListOperationsRequest], operations_pb2.ListOperationsResponse
546 ]:
547 r"""Return a callable for the list_operations method over gRPC."""
548 # Generate a "stub function" on-the-fly which will actually make
549 # the request.
550 # gRPC handles serialization and deserialization, so we just need
551 # to pass in the functions for each.
552 if "list_operations" not in self._stubs:
553 self._stubs["list_operations"] = self._logged_channel.unary_unary(
554 "/google.longrunning.Operations/ListOperations",
555 request_serializer=operations_pb2.ListOperationsRequest.SerializeToString,
556 response_deserializer=operations_pb2.ListOperationsResponse.FromString,
557 )
558 return self._stubs["list_operations"]
560 @property
561 def kind(self) -> str:
562 return "grpc"
565__all__ = ("LoggingServiceV2GrpcTransport",)