Implemented trace library based on the autogen, gax only #3513

liyanhui1228 · 2017-06-20T01:23:37Z

Implemented the veneer layer of the trace library based on the auto-generated code. This will provide the trace and span context managers and simplify the API for users who want to manually instrument their code. Sample usage in the gist: https://gist.github.com/liyanhui1228/20ac515d74e134ea39b0e63a9d0524bf

theacodes

This looks mostly good to me from a design perspective, I defer to @dhermes for style review.

We'll also need some tests.

trace/google/cloud/trace/__init__.py

+# limitations under the License.
+
+from pkg_resources import get_distribution
+__version__ = get_distribution('google-cloud-trace').version


trace/google/cloud/trace/_gax.py

+
+"""GAX Wrapper for interacting with the Stackdriver Trace API."""
+
+from google.cloud.gapic.trace.v1.trace_service_client import (


trace/google/cloud/trace/trace_span.py

+            self,
+            name,
+            kind=Enum.SpanKind.SPAN_KIND_UNSPECIFIED,
+            parent_span_id=None,


trace/google/cloud/trace/__init__.py

+from google.cloud.trace.trace_span import TraceSpan
+
+
+__all__ = ['_TraceAPI', 'Client', 'Trace', 'TraceSpan']


trace/google/cloud/trace/_gax.py

+
+"""GAX Wrapper for interacting with the Stackdriver Trace API."""
+
+from google.cloud.gapic.trace.v1.trace_service_client import (


trace/google/cloud/trace/_gax.py

+        return GAXIterator(self.client, page_iter, item_to_value)
+
+
+def _parse_trace_pb(trace_pb):


trace/google/cloud/trace/_gax.py

+        raise
+
+
+def _item_to_mapping(iterator, trace_pb):


trace/google/cloud/trace/_helper.py

@@ -0,0 +1,65 @@
+# Copyright 2017 Google Inc.


trace/google/cloud/trace/trace_span.py

+    return int(span_id)
+
+
+def format_span_json(span):


trace/google/cloud/trace/trace_span.py

+    :returns: Identifier for the span. Must be a 64-bit integer other
+                than 0 and unique within a trace. Converted to string.
+    """
+    span_id = str(random.getrandbits(64))


trace/tests/unit/test__gax.py

+
+        from datetime import datetime
+
+        PROJECT = 'PROJECT'


trace/tests/unit/test_client.py

+            None, None, None, None, None, None, None))
+
+
+class _DummyTraceAPI(object):


trace/tests/unit/test__gax.py

+        self.assertIs(trace_api.client, client)
+
+
+class _GAXTraceAPI(_GAXBaseAPI):


liyanhui1228 · 2017-06-26T21:00:57Z

Ready for another review.

trace/google/cloud/trace/_gax.py

+        return GAXIterator(self.client, page_iter, item_to_value)
+
+
+def _parse_trace_pb(trace_pb):


trace/google/cloud/trace/_gax.py

+        raise
+
+
+def _item_to_mapping(iterator, trace_pb):


trace/google/cloud/trace/trace.py

+    def __init__(self, client, project_id=None, trace_id=None):
+        self.client = client
+
+        if project_id is None:


theacodes · 2017-06-26T21:31:28Z

@lukesneeringer @dhermes this mostly looks good to me. I have a few outstanding questions for you two and I would like one of y'all to do a final review.

trace/MANIFEST.in

@@ -1,5 +1,6 @@
 include README.rst LICENSE
-global-include *.json
+recursive-include unit_tests *


trace/google/cloud/trace/trace.py

+    :rtype: str
+    :returns: 32 digits randomly generated trace ID.
+    """
+    trace_id = str(uuid.uuid4()).replace('-', '')


trace/google/cloud/trace/trace_span.py

+    :returns: Identifier for the span. Must be a 64-bit integer other
+                than 0 and unique within a trace. Converted to string.
+    """
+    span_id = uuid.uuid4().int & (1 << 64)-1


trace/tests/unit/test__gax.py

+        return self._get_target_class()(*args, **kw)
+
+
+class Test__TraceAPI(_Base, unittest.TestCase):


trace/tests/unit/test__gax.py

+        self.assertIs(trace_api.client, client)
+
+
+class _GAXTraceAPI(_GAXBaseAPI):


liyanhui1228 · 2017-06-27T23:36:28Z

@duggelz Should be the first one, actually the order doesn't matter. As long as we patch a list of spans to the trace API, the cloud trace console will show the trace graph according to the parent_span_id in each span.

liyanhui1228 · 2017-06-28T16:43:50Z

Ready for another review.

googlebot · 2017-06-29T22:57:01Z

So there's good news and bad news.

👍 The good news is that everyone that needs to sign a CLA (the pull request submitter and all commit authors) have done so. Everything is all good there.

😕 The bad news is that it appears that one or more commits were authored by someone other than the pull request submitter. We need to confirm that they're okay with their commits being contributed to this project. Please have them confirm that here in the pull request.

Note to project maintainer: This is a terminal state, meaning the cla/google commit status will not change from this state. It's up to you to confirm consent of the commit author(s) and merge this pull request when appropriate.

googlebot · 2017-06-30T00:54:45Z

CLAs look good, thanks!

liyanhui1228 · 2017-07-05T17:37:01Z

@lukesneeringer Can I merge this to the auto-gen branch now? Or wait for the autogen code to be updated?

Implemented trace library based on the autogen, gax only

e63974e

googlebot added the cla: yes This human has signed the Contributor License Agreement. label Jun 20, 2017

liyanhui1228 requested review from duggelz and theacodes June 20, 2017 01:40

dhermes mentioned this pull request Jun 20, 2017

Auto-generated trace library (GAPIC only) #3512

Merged

theacodes reviewed Jun 20, 2017

View reviewed changes

liyanhui1228 requested a review from dhermes June 20, 2017 16:46

liyanhui1228 added 6 commits June 20, 2017 15:29

Address Jon's comments, add support for nested spans.

661c463

Fix lint and modify nox.py

f8574b0

Use the FromDatetime function to convert datetime to timestamp protobuf

2b09170

Add unit test for _gax.py and client.py

3549f28

Add unit test skeleton for trace.py and trace_span.py

7ebb8ba

Fix stuff

0bbd3d7

theacodes suggested changes Jun 23, 2017

View reviewed changes

liyanhui1228 added 4 commits June 23, 2017 13:21

Fix style

95bd77b

Fix stuff

d5186f5

Fix test coverage

da12264

Complete unit test for trace.py

6436717

theacodes added the api: cloudtrace Issues related to the Cloud Trace API. label Jun 26, 2017

gyangscrf mentioned this pull request Jun 26, 2017

autodetect schema for avro file is not enabled #3539

Closed

liyanhui1228 added 2 commits June 26, 2017 13:29

Complete unit test for trace_span.py

9434b75

Remove unused function

46171d4

theacodes suggested changes Jun 26, 2017

View reviewed changes

duggelz reviewed Jun 27, 2017

View reviewed changes

liyanhui1228 added 3 commits June 27, 2017 11:36

Modify tests

709b7dd

Change to use itertools to traverse spans

9162cf6

Fix style

992c749

googlebot added cla: no This human has *not* signed the Contributor License Agreement. and removed cla: yes This human has signed the Contributor License Agreement. labels Jun 29, 2017

liyanhui1228 force-pushed the trace-manual branch 2 times, most recently from cd4a01e to 992c749 Compare June 30, 2017 00:54

googlebot added cla: yes This human has signed the Contributor License Agreement. and removed cla: no This human has *not* signed the Contributor License Agreement. labels Jun 30, 2017

lukesneeringer approved these changes Jul 5, 2017

View reviewed changes

lukesneeringer merged commit 57160b2 into trace-autogen Jul 25, 2017

dhermes deleted the trace-manual branch August 2, 2017 15:55


		"""GAX Wrapper for interacting with the Stackdriver Trace API."""

		from google.cloud.gapic.trace.v1.trace_service_client import (

		from google.cloud.trace.trace_span import TraceSpan


		__all__ = ['_TraceAPI', 'Client', 'Trace', 'TraceSpan']

		return GAXIterator(self.client, page_iter, item_to_value)


		def _parse_trace_pb(trace_pb):

		None, None, None, None, None, None, None))


		class _DummyTraceAPI(object):

		self.assertIs(trace_api.client, client)


		class _GAXTraceAPI(_GAXBaseAPI):

		return self._get_target_class()(args, *kw)


		class Test__TraceAPI(_Base, unittest.TestCase):

Implemented trace library based on the autogen, gax only #3513

Implemented trace library based on the autogen, gax only #3513

Uh oh!

Conversation

liyanhui1228 commented Jun 20, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

theacodes left a comment

Choose a reason for hiding this comment

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

liyanhui1228 commented Jun 20, 2017 •

edited

Loading

liyanhui1228 commented Jun 27, 2017 •

edited

Loading