Stackdriver Trace API by chingor13 · Pull Request #388 · googleapis/google-cloud-php

chingor13 · 2017-03-07T21:44:18Z

This PR includes only the REST interface for the Google Cloud Trace. It does not include the nice context tracking integration points for developers to use.

Implements basic Trace and TraceSpan resources. TraceClient tests Fix tests. Connection needed to be protected Code style fixes

jdpedrie

This is looking great! Hope these comments aren't coming too early in your process.

Sign in to view

+     */
+    public function __construct(array $options)
+    {
+        $this->projectId = $options['projectId'];


Sign in to view

+     *
+     * @param TraceSpan[] $spans
+     */
+    public function setSpans(array $spans)


Sign in to view

+     * @param Trace[] $traces The trace logs to send.
+     * @return Trace[] Array of new or updated traces.
+     */
+    public function patchTraces(array $traces)


Sign in to view

+     *
+     * @return array
+     */
+    public function info()


Sign in to view

+     * @param  \DateTime $when [optional] The end time of this span.
+     *         **Defaults to** now.
+     */
+    public function finish(\DateTime $when = null)


Sign in to view

+     *
+     * @param array $labels Labels in the form of $label => $value
+     */
+    public function addLabels($labels)


Sign in to view

+ * limitations under the License.
+ */
+
+namespace Google\Cloud\Tests\Trace\Connection;


jdpedrie · 2017-03-08T15:21:23Z

Can you provide an example of how the constants in Labels are used? Is it worth having a class dedicated to them entirely, or could they be contained in TraceClient?

chingor13 · 2017-03-15T16:54:08Z

@jdpedrie I'll remove it for now as the design for it's use isn't solidified yet. Originally, TraceSpan had one labels collection object, but now the TraceSpan just manages the labels itself. Currently it's just a namespace for some constants. We can revisit when the user integration pieces are built.

jdpedrie · 2017-03-15T18:33:49Z

Make sure you rebase against upstream/master to get the component split changes. Most of the classes that moved are going to be in Google\Cloud\Core.

…ctor

chingor13 · 2017-03-16T18:28:06Z

@jdpedrie If you have a chance to review, the basic API endpoints are all working and tested (unit/snippet/system). For a sneak peek into how the developer integration piece might look, see: https://github.com/chingor13/google-cloud-php/pull/3/files and https://github.com/chingor13/laravel_blog/blob/master/app/Providers/GoogleCloudProvider.php

Sign in to view

+    /**
+     * Retrieves the spans for this trace.
+     *
+     * @return array


Sign in to view

+     *
+     * @return string
+     */
+    public function projectId()


Sign in to view

+        ]);
+
+        if (empty($trace)) {
+            throw new NotFoundException('Trace ID does not exist', 404);


Sign in to view

+    }
+
+    /**
+     * Lazily find or instantiates a trace. There are no network requests made at this


Sign in to view

+     *      @type string $orderBy Field used to sort the returned traces. Can be one
+     *            of 'traceId', 'name', 'duration', 'start'. Descending order
+     * }
+     * @return \Generator<Trace>


Sign in to view

+     * @param  \DateTime $when [optional] The start time of this span.
+     *         **Defaults to** now.
+     */
+    public function setStart(\DateTime $when = null)


Sign in to view

+     *         **Defaults to** now.
+     * @return string
+     */
+    private function formatDate($when = null)


Sign in to view

+        $span2 = new TraceSpan(['name' => 'inner', 'parentSpanId' => $span->spanId()]);
+        $span2->setStart();
+
+        usleep(20000);


Sign in to view

+     *
+     * @param array $config [optional] Configuration options. See
+     *        {@see Google\Cloud\ServiceBuilder::__construct()} for the available options.
+     * @return StorageClient


Sign in to view

+     *      @type string $orderBy Field used to sort the returned traces. Can be one
+     *            of 'traceId', 'name', 'duration', 'start'. Descending order
+     * }
+     * @return \Generator<Trace>


Sign in to view

+     * @return Trace
+     * @throws ServiceException
+     */
+    public function getTrace($traceId)


Sign in to view

+    /**
+     * Fetch all traces in the project
+     *
+     * @param array $options [optional] {


Sign in to view

+     *      @type string $viewType Type of data returned for traces in the list.
+     *            Can be one of 'VIEW_TYPE_UNSPECIFIED', 'MINIMAL', 'ROOTSPAN', or
+     *            'COMPLETE'
+     *      @type integer $pageSize Maximum number of traces to return


Sign in to view

+     *            'COMPLETE'
+     *      @type integer $pageSize Maximum number of traces to return
+     *      @type string $pageToken Token identifying the page of results to return
+     *      @type string $startTime Start of the time interval during which trace data


Sign in to view

+     *            collected
+     *      @type sring $filter An optional filter for the request
+     *      @type string $orderBy Field used to sort the returned traces. Can be one
+     *            of 'traceId', 'name', 'duration', 'start'. Descending order


Sign in to view

+     *
+     * @param TraceSpan[] $spans
+     */
+    public function setSpans(array $spans)


dwsupplee · 2017-03-16T19:15:09Z

Sorry for any overlapping items that @jdpedrie may have pointed out. I didn't notice his review items until after I had just posted.

dwsupplee

Nice work!

Sign in to view

+     * }
+     * @return ItemIterator<Trace>
+     */
+    public function traces(array $options = [])


Sign in to view

+     * Associative array containing all the fields representing this TraceSpan.
+     * @var array
+     */
+    private $info;


Sign in to view

+            'kind' => self::SPAN_KIND_UNSPECIFIED
+        ];
+
+        if (!array_key_exists('spanId', $this->info)) {


Sign in to view

+     */
+    private function generateSpanName()
+    {
+        // FIXME: clean backtrace rather than guessing the stack depth


Sign in to view

+use Rize\UriTemplate;
+
+/**
+ * @group translate


Sign in to view

+use Google\Cloud\Trace\TraceSpan;
+use Google\Cloud\Trace\Trace;
+
+class BasicTest extends \PHPUnit_Framework_TestCase


Sign in to view

+            $micro = sprintf("%06d", $usec * 1000000);
+            $when = new \DateTime(date('Y-m-d H:i:s.' . $micro));
+        }
+        return $when->format('Y-m-d\TH:i:s.u000\Z');


Sign in to view

+use Google\Cloud\Trace\Connection\Rest;
+
+/**
+ * Google Stackdriver Trace client. Allows you to collect latency data from


Sign in to view

+     * @param Trace[] $traces The trace logs to send.
+     * @param array $options [optional] Configuration Options
+     * @return bool
+     * @throws ServiceException


Sign in to view

+ * This plain PHP class represents a Trace resource. For more information see
+ * [TraceResource](https://cloud.google.com/trace/docs/reference/v1/rest/v1/projects.traces#resource-trace)
+ */
+class Trace


Sign in to view

+        ] + $options);
+
+        if (empty($trace)) {
+            throw new NotFoundException('Trace ID does not exist', 404);


chingor13 · 2017-03-28T17:38:22Z

@dwsupplee @jdpedrie I'm working on part 2 (nice client context handling for building traces) in a separate branch with a PR into this branch here: chingor13#3. I'm not sure how you want to handle merging/releasing it - take the APIs first, then have a separate PR for part 2, or merge part 2 into the API branch and take it as one big PR.

…kage

chingor13 · 2017-04-07T21:28:58Z

@dwsupplee @jdpedrie Is there anything else we need for the trace apis?

chingor13 · 2017-04-07T21:34:27Z

The travis error seems to be a random failure to install php 7.1

chingor13 · 2017-04-17T19:33:20Z

@dwsupplee @jdpedrie Do we need anything else to proceed here?

dwsupplee · 2017-04-17T19:50:54Z

We should probably get a trace repo going so we can release this as an individual component as well.

@bshaffer would you be able to assist with that? :)

chingor13 · 2017-04-18T00:34:44Z

The ball was started on that. We will follow up on its creation this week.

I wasn't envisioning releasing the trace library separately until the integration part 2 was ready (blocked by this PR as well as the AsyncBatchRunner)

dwsupplee · 2017-04-18T00:38:50Z

Sounds good. The code looks good to me, so ready to merge as long as everything looks good to @jdpedrie as well.

jdpedrie · 2017-04-18T13:30:45Z

That is fine by me. We need to temporarily remove src/Trace/composer.json (or rename it, perhaps, composer.json.temp?) in order to prevent the release build from attempting to push to a repository that does not exist. After that, I'm fine with it being merged!

…ce repo is available

This reverts commit 5e1320f.

Implement the Trace REST API Client.

dcb52a1

Implements basic Trace and TraceSpan resources. TraceClient tests Fix tests. Connection needed to be protected Code style fixes

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

jdpedrie reviewed Mar 7, 2017

View reviewed changes

Rename some methods, move a required parameter

ee30828

jdpedrie added the do not merge Indicates a pull request not ready for merge, due to either quality or timing. label Mar 8, 2017

chingor13 added 3 commits March 15, 2017 09:56

remove labels class for now

589d42b

Refactor TraceSpan to store attributes directly in the info array

6c2892c

Fix Trace namespace in ServiceBuilder

a642052

chingor13 added 8 commits March 15, 2017 13:11

Rename some getter methods. Whitelist attributes in TraceSpan constru…

74f8e39

…ctor

Merge remote-tracking branch 'upstream/master' into trace_only_api

b1feb9a

Fix aliases for Core classes

5077976

Snippet tests and phpcs fixes

820e924

add Trace test

0f8c1bd

Add system tests for using the TraceClient

38913cf

list traces test depends on creating the traces

6771fe8

Merge remote-tracking branch 'upstream/master' into trace_only_api

5f263cc

chingor13 changed the title ~~WIP: Stackdriver Trace API~~ Stackdriver Trace API Mar 16, 2017

jdpedrie reviewed Mar 16, 2017

View reviewed changes

dwsupplee reviewed Mar 16, 2017

View reviewed changes

chingor13 added 6 commits March 16, 2017 12:28

Fix some typehinting and documentation

5484225

Refactor Trace to lazy load span data if not set.

d025287

Convert listTraces output from a generator to an ItemIterator

51d33b4

Add @see note for Trace list function

4901a14

Fix Trace system tests

746eaef

Add TraceSpan factory function on Trace

a6fc21d

chingor13 added 3 commits March 22, 2017 11:01

Documentation updates

edaacc4

Remove projectId getter/setter from Trace.

93dfcbb

cs ignore for long documentation links

5576268

dwsupplee reviewed Mar 22, 2017

View reviewed changes

chingor13 added 5 commits March 22, 2017 14:27

Docs, fixing traces resultLimit, set timezone

af285ee

Generate a span name from a cleaned backtrace

f746e75

If the trace span is not created within a class, is the file's basename

eb6609b

Some backtrace entries do not have line numbers

bb58877

Revert the change to info() that tried to maintain an info array

5676de4

chingor13 commented Mar 23, 2017

View reviewed changes

Comment thread src/Trace/Trace.php

] + $options);

if (empty($trace)) {

throw new NotFoundException('Trace ID does not exist', 404);

This comment was marked as spam.

Sign in to view

chingor13 added 3 commits March 29, 2017 09:50

Adding version, license, docs for creating new google/cloud-trace pac…

b520908

…kage

Merge remote-tracking branch 'upstream/master' into trace_only_api

e6ffa25

Merge remote-tracking branch 'upstream/master' into trace_only_api

116ef5b

chingor13 added 2 commits April 7, 2017 14:49

Add Trace section to main README

15bfd3f

Rename finish -> end for consistency across languages

435978e

Merge remote-tracking branch 'upstream/master' into trace_only_api

7f5517e

Temporarily rename Trace composer.json until the google-cloud-php-tra…

6c16606

…ce repo is available

dwsupplee removed the do not merge Indicates a pull request not ready for merge, due to either quality or timing. label Apr 18, 2017

Merge remote-tracking branch 'upstream/master' into trace_only_api

0fa02d9

dwsupplee merged commit 5e1320f into googleapis:master Apr 18, 2017

chingor13 deleted the trace_only_api branch April 18, 2017 18:40

tmatsuo pushed a commit that referenced this pull request Apr 24, 2017

Revert "Stackdriver Trace API (#388)"

b4840f9

This reverts commit 5e1320f.

Uh oh!

Conversation

chingor13 commented Mar 7, 2017

Uh oh!

jdpedrie 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!

jdpedrie commented Mar 8, 2017

Uh oh!

chingor13 commented Mar 15, 2017

Uh oh!

jdpedrie commented Mar 15, 2017

Uh oh!

chingor13 commented Mar 16, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

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!

chingor13 commented Mar 16, 2017 •

edited

Loading

chingor13 commented Apr 18, 2017 •

edited

Loading