Tracing: Add code and message to Span -> Status by mayurkale22 · Pull Request #328 · census-instrumentation/opencensus-node

mayurkale22 · 2019-02-05T01:36:36Z

Fixes #327

codecov-io · 2019-02-05T01:44:15Z

Codecov Report

Merging #328 into master will increase coverage by 0.04%.
The diff coverage is n/a.

@@           Coverage Diff            @@
##           master   #328      +/-   ##
========================================
+ Coverage   94.95%    95%   +0.04%     
========================================
  Files         119    120       +1     
  Lines        8172   8202      +30     
  Branches      732    730       -2     
========================================
+ Hits         7760   7792      +32     
+ Misses        412    410       -2

Impacted Files	Coverage Δ
src/http.ts	`89.23% <0%> (-0.58%)`	⬇️
src/zpages.ts	`91.04% <0%> (-0.51%)`	⬇️
src/adapters.ts	`96.87% <0%> (-0.07%)`	⬇️
src/index.ts	`100% <0%> (ø)`	⬆️
src/trace/model/span-base.ts	`100% <0%> (ø)`	⬆️
test/test-span.ts	`100% <0%> (ø)`	⬆️
src/grpc.ts	`93.78% <0%> (ø)`	⬆️
src/trace/model/types.ts	`100% <0%> (ø)`
test/test-grpc.ts	`99.58% <0%> (ø)`	⬆️
test/test-http.ts	`99.43% <0%> (ø)`	⬆️
... and 2 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 94cc98c...5741699. Read the comment docs.

draffensperger · 2019-02-05T02:00:39Z

packages/opencensus-core/src/trace/model/span-base.ts

+   */
+  setStatus(code: number, message?: string) {
+    this.status.code = code;
+    if (message) {


If someone sets a new code but no message, would this check leave the old message assigned to status?

Could this function just be this.status = {code, message}, since we the message field is optional?

Good catch! Done.

draffensperger · 2019-02-05T02:03:09Z

packages/opencensus-core/src/trace/model/types.ts

+ * with an optional descriptive message.
+ */
+export interface Status {
+  /** The status code. */


Could you add in the comment that this status code should correspond with a specific set of OpenCensus trace status codes and that HTTP status codes should be appropriately converted per the specs at https://github.com/census-instrumentation/opencensus-specs/blob/master/trace/HTTP.md#mapping-from-http-status-codes-to-trace-status-codes?

Done as per #328 (comment).

draffensperger · 2019-02-05T02:05:22Z

packages/opencensus-core/test/test-span.ts

+  /**
+   * Should set a status
+   */
+  describe('addStatus()', () => {


Nit: 'setStatus'

draffensperger · 2019-02-05T02:06:53Z

packages/opencensus-core/test/test-span.ts

+      rootSpan.start();
+      const span = new Span(rootSpan);
+      span.start();
+      span.setStatus(400, 'This is an error');


Per comment about about the canonical values, could this be a number like span.SetSTatus('3', 'Invalid argument') ?

draffensperger · 2019-02-05T02:07:20Z

packages/opencensus-core/src/trace/model/types.ts

+  /** A developer-facing error message. */
+  message?: string;
+}
+


What would you think about adding an enum with the list of OpenCensus status codes from the table referenced above?

To be clear I'm not suggesting the type of the code field be the enum (that might limit clients of the library if a new status is added but they can't upgrade yet, and for opencensus-web I want to keep @opencensus/core just as a dev dependency). But just having the enum provides documentation for what the possible canonical status codes are.

I checked in Java implementation, we are using enum for code -> https://github.com/census-instrumentation/opencensus-java/blob/master/api/src/main/java/io/opencensus/trace/Status.java#L384. This is also matching with status spec.

OK, I'd be fine with using an enum for it.

draffensperger

LGTM pending a couple new comments

draffensperger · 2019-02-05T19:21:15Z

CHANGELOG.md

 - Add optional `uncompressedSize` and `compressedSize` fields to `MessageEvent` interface.
+- Add a ```setStatus``` method in the Span.

 **This release has multiple breaking changes. Please test your code accordingly after upgrading.**


Should you mention that the status field on Span is no longer a number, since that's a breaking change?

draffensperger · 2019-02-05T19:22:21Z

packages/opencensus-core/test/test-span.ts

    });
  });
+
+  /**


Optional: what would you think about removing this comment? I personally find it a bit redundant with the describe('setStatus

draffensperger · 2019-02-05T19:26:28Z

packages/opencensus-instrumentation-grpc/src/grpc.ts

        // tslint:disable-next-line:no-any
        value: any, trailer: grpcTypes.Metadata, flags: grpcTypes.writeFlags) {
      if (err) {
-        rootSpan.status = GrpcPlugin.convertGrpcStatusToSpanStatus(err.code);


Do you need to make similar changes to HttpPlugin.convertTraceStatus to make use of this new enum?

See:

opencensus-node/packages/opencensus-instrumentation-http/src/http.ts

Line 403 in 94cc98c

static convertTraceStatus(statusCode: number): number {

Already did it here: https://github.com/census-instrumentation/opencensus-node/pull/328/files#diff-a5285736aa52f4a852028199a7016379R404

Thanks! I think I got lost in the changes there and did not look closely enough.

mayurkale22 · 2019-02-06T02:12:04Z

Thanks @draffensperger for the reviews.

googlebot added the cla: yes label Feb 5, 2019

mayurkale22 requested review from draffensperger, justindsmith and songy23 February 5, 2019 01:36

mayurkale22 changed the title ~~Add code and message to Span->Status~~ Tracing: Add code and message to Span->Status Feb 5, 2019

mayurkale22 changed the title ~~Tracing: Add code and message to Span->Status~~ Tracing: Add code and message to Span -> Status Feb 5, 2019

mayurkale22 force-pushed the set_status branch from 3bc29f9 to abd29c4 Compare February 5, 2019 01:40

draffensperger reviewed Feb 5, 2019

View reviewed changes

mayurkale22 added 2 commits February 5, 2019 11:14

Add code and message to Span->Status

e1563b3

Use enum(CanonicalCode) for status->code

4e11ae6

mayurkale22 force-pushed the set_status branch from 1123b8f to 4e11ae6 Compare February 5, 2019 19:15

draffensperger approved these changes Feb 5, 2019

View reviewed changes

Update CHANGELOG

5741699

draffensperger approved these changes Feb 6, 2019

View reviewed changes

mayurkale22 merged commit 57b1da5 into census-instrumentation:master Feb 6, 2019

mayurkale22 deleted the set_status branch February 6, 2019 18:38

mayurkale22 mentioned this pull request Feb 12, 2019

chore(multiple): 0.0.9 release proposal #341

Merged

                   });
                 });
+                /**

Conversation

mayurkale22 commented Feb 5, 2019

Uh oh!

codecov-io commented Feb 5, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

draffensperger left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mayurkale22 commented Feb 6, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

codecov-io commented Feb 5, 2019 •

edited

Loading