feat: adding Koa instrumentation by carolinee21 · Pull Request #144 · open-telemetry/opentelemetry-js-contrib

carolinee21 · 2020-07-17T15:39:53Z

Which problem is this PR solving?

Fixes Plugin for Koa #93
Adds automatic instrumentation for Koa, a Node.js web framework.

Short description of the changes

This instrumentation adds traces to middleware for both the Koa core and Koa Router modules.
Some example traces are shown here:
User friendly example code is also added under examples/koa

linux-foundation-easycla · 2020-07-17T15:40:08Z

The committers are authorized under a signed CLA.

✅ carolinee21 (e80ceda, efca91b, 199cb7d, 55f9a86, 1c684fc, 5241daa, 6763375, a084a1d, 4fb5597, a66102c, a16d6a8, 3b1e1e5, 9910682, aec43b1, c681bd0, dfea6b6, 69a4e04, 3101050, aa4fc44, 1b35f8b, d8f72f4, 1315670, 0200d23, 9b93428, 19ad821, fe75b18, ae5d0e8, ece953f, c734e70, 206dd8f, a9af954, f2482df, 07c850e, 1a906da, d5b70c6, a6959ae, 1f57da9, befe3f6, 7d38b14, febe541, 1cfcb5e, b1f5f4c, 6cc29e8, 43438e9, 9b7a799, daa8df8, 4056324, 67169cb, 86bea49, ccacd8e)

codecov · 2020-07-17T15:42:42Z

Codecov Report

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

@@            Coverage Diff             @@
##           master     #144      +/-   ##
==========================================
+ Coverage   94.31%   94.61%   +0.29%     
==========================================
  Files          77       84       +7     
  Lines        3836     4124     +288     
  Branches      415      432      +17     
==========================================
+ Hits         3618     3902     +284     
- Misses        218      222       +4

Impacted Files	Coverage Δ
.../node/opentelemetry-koa-instrumentation/src/koa.ts	`98.00% <0.00%> (ø)`
...e/opentelemetry-koa-instrumentation/src/version.ts	`100.00% <0.00%> (ø)`
...opentelemetry-koa-instrumentation/test/koa.test.ts	`99.08% <0.00%> (ø)`
...ode/opentelemetry-koa-instrumentation/src/types.ts	`100.00% <0.00%> (ø)`
...emetry-koa-instrumentation/test/koa-router.test.ts	`99.09% <0.00%> (ø)`
...ode/opentelemetry-koa-instrumentation/.eslintrc.js	`0.00% <0.00%> (ø)`
...ode/opentelemetry-koa-instrumentation/src/utils.ts	`100.00% <0.00%> (ø)`

chore: add tslint chore: add standard license chore: add npmignore chore: initial package config docs: initial README chore: create initial structure chore: adds traces to Application.use method itself (on instantiation) feat: traces for app.use chore: update typescript version chore: return original layer result chore: remove app.use span based on design chore: refactor span attribute assignments into util chore: add router types feat: added tracing for koa-router functions and routes feat: don't create koa spans without root span feat: added base tests for Koa core and Koa router chore: finalizing plugin feat: added kLayerPatched check test: creating example code for Koa plugin chore: cleaning up code chore: update README chore: update README chore: update README chore: add async middleware tests chore: improve sample code Add files via upload Add files via upload Add files via upload chore: add jaeger example Add files via upload chore: add linter to example code chore: rename plugin to instrumentation chore: cleaning tests/examples Add files via upload Add files via upload chore: fix async example code and span timing chore: refine test style docs: add comments to plugin patching operations chore: file cleanup chore: fix code style

Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com>

…try-js-contrib into master

dyladan

Please bump all core dependencies to 0.12.2

obecny

Please bump all core dependencies to 0.12.2

I think @dyladan meant 0.10.2

…try-js-contrib

carolinee21 · 2020-08-10T18:08:52Z

@dyladan @obecny @michaelgoin Now that the other PR has been merged, this one is unblocked and should be ready to go!

obecny · 2020-08-10T18:41:51Z

@dyladan @obecny @michaelgoin Now that the other PR has been merged, this one is unblocked and should be ready to go!

@dyladan requested changes, wait for him to approve first

carolinee21 · 2020-08-14T00:59:38Z

@dyladan Hi Daniel! Please let me know if there's anything else missing from me on this or the Hapi PR. Thanks! :)

carolinee21 requested a review from a team July 17, 2020 15:39

carolinee21 force-pushed the master branch from ccacd8e to 3aaae4d Compare July 17, 2020 17:03

carolinee21 mentioned this pull request Jul 17, 2020

Plugin for Koa #93

Closed

fix: add eslint-plugin-headers dependency

9cca8d8

mayurkale22 requested a review from a team July 17, 2020 17:31

dyladan reviewed Jul 17, 2020

View reviewed changes

vmarchaud reviewed Jul 18, 2020

View reviewed changes

carolinee21 and others added 2 commits July 20, 2020 06:38

chore: incorporating PR comments

c5290b7

Update plugins/node/opentelemetry-koa-instrumentation/src/koa.ts

b4ec189

Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com>

markwolff reviewed Jul 20, 2020

View reviewed changes

Comment thread examples/koa/package.json Outdated

markwolff reviewed Jul 20, 2020

View reviewed changes

Comment thread plugins/node/opentelemetry-koa-instrumentation/src/types.ts Outdated

markwolff reviewed Jul 20, 2020

View reviewed changes

Comment thread plugins/node/opentelemetry-koa-instrumentation/src/types.ts Outdated

carolinee21 added 4 commits July 20, 2020 12:30

fix: more changes based on feedback

c3bdb37

fix: fixing linting issue

c970fc4

Merge branch 'master' of https://github.com/open-telemetry/openteleme…

7e4d80a

…try-js-contrib into master

chore: bump codecov

6798351

carolinee21 requested review from dyladan and vmarchaud July 24, 2020 19:58

vmarchaud reviewed Jul 27, 2020

View reviewed changes

Comment thread plugins/node/opentelemetry-koa-instrumentation/src/koa.ts Outdated

chore: code style

11e9e5e

vmarchaud approved these changes Jul 27, 2020

View reviewed changes

markwolff approved these changes Jul 27, 2020

View reviewed changes

carolinee21 changed the title ~~Adding Koa Instrumentation~~ feat: adding Koa instrumentation Jul 29, 2020

dyladan approved these changes Jul 29, 2020

View reviewed changes

michaelgoin reviewed Jul 29, 2020

View reviewed changes

Comment thread plugins/node/opentelemetry-koa-instrumentation/src/koa.ts

feat: adding test cases for nested and prefixed routers

1d55a79

michaelgoin approved these changes Jul 31, 2020

View reviewed changes

dyladan requested changes Aug 5, 2020

View reviewed changes

Comment thread plugins/node/opentelemetry-koa-instrumentation/package.json Outdated

Comment thread plugins/node/opentelemetry-koa-instrumentation/package.json Outdated

carolinee21 added 2 commits August 5, 2020 08:56

chore: bump version to 0.9.0

9ee38b6

Merge branch 'master' of https://github.com/open-telemetry/openteleme…

9072652

…try-js-contrib into master

dyladan added the Internship Ending Soon label Aug 5, 2020

dyladan reviewed Aug 5, 2020

View reviewed changes

Comment thread examples/koa/package.json Outdated

Comment thread plugins/node/opentelemetry-koa-instrumentation/package.json Outdated

fix: bumping core dependencies to 0.10.2

cd12d4f

obecny reviewed Aug 6, 2020

View reviewed changes

Comment thread examples/koa/package.json Outdated

Comment thread plugins/node/opentelemetry-koa-instrumentation/package.json Outdated

Comment thread plugins/node/opentelemetry-koa-instrumentation/test/koa.test.ts

michaelgoin mentioned this pull request Aug 6, 2020

fix: various compilation errors #170

Merged

michaelgoin reviewed Aug 6, 2020

View reviewed changes

Comment thread plugins/node/opentelemetry-koa-instrumentation/package.json

carolinee21 added 2 commits August 6, 2020 15:42

chore: refactor test server logic

3b9340e

Merge branch 'master' of https://github.com/open-telemetry/openteleme…

8dfb1cf

…try-js-contrib

carolinee21 requested a review from dyladan August 10, 2020 18:08

dyladan approved these changes Aug 14, 2020

View reviewed changes

Merge branch 'master' into master

5b19cfd

obecny merged commit 17005e4 into open-telemetry:master Aug 18, 2020

obecny added the instrumentation-request label Sep 7, 2020

Uh oh!

Conversation

carolinee21 commented Jul 17, 2020

Which problem is this PR solving?

Short description of the changes

Uh oh!

linux-foundation-easycla Bot commented Jul 17, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov Bot commented Jul 17, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dyladan left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

obecny left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

carolinee21 commented Aug 10, 2020

Uh oh!

obecny commented Aug 10, 2020

Uh oh!

carolinee21 commented Aug 14, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

linux-foundation-easycla Bot commented Jul 17, 2020 •

edited

Loading

codecov Bot commented Jul 17, 2020 •

edited

Loading