-
Notifications
You must be signed in to change notification settings - Fork 21
Update readme, add contributing guide & changelog #43
Conversation
Codecov Report
@@ Coverage Diff @@
## master #43 +/- ##
=======================================
Coverage 96.94% 96.94%
=======================================
Files 25 25
Lines 557 557
Branches 69 69
=======================================
Hits 540 540
Misses 17 17 Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added minor nits
README.md
Outdated
application performance and behavior monitoring data. This library currently | ||
generates traces for the initial page load of a site in the browser. It supports | ||
sending the trace sampling decision and trace ID from the web server to the | ||
browser client to enable latency debuging across the stack. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: s/debuging/debugging
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, done
README.md
Outdated
useful for experimentation with the library but is not appropriate for a real | ||
application. | ||
|
||
OpenCensus Web also supports connecting the server side spand for the initial |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
typo: spand?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed, "spans"
README.md
Outdated
opencensus libraries, then there is no deprecation period. Otherwise, we will deprecate it for 18 | ||
months before removing it, if possible. | ||
|
||
**Alpha**: Libraries defined at a Alpha quality level can be unstable and could cause crashes or data loss. Alpha software may not contain all of the features that are planned for the final version. The API is subject to change. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: s/a Alpha/an Alpha
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
Add multiplexing/"pass through" mode where spans from sources other than the initiating node can be sent and they should be properly proxied to their final destination. If the currently received node is nil, use the previously received and non-nil node, and after processing spans, memoize the last received node. Updated the tests to lock-in this behavior. This change also adds in tests to ensure this behavior and to avoid regressions in the future. Fixes census-instrumentation#43
The usage instructions will continue to evolve as the library matures, but this is a decent start.