Api separation #727

dyladan · 2020-01-22T23:24:39Z

Which problem is this PR solving?

Fixes Separate API from SDK #721

Short description of the changes

Rename @opentelemetry/types to @opentelemetry/api
Move API related concerns such as get/set tracer/meter registries to @opentelemetry/api
Move all noop implementations to @opentelemetry/api

TODO:

update all README files
update examples
update getting started
update benchmarks
~~browser tests for API~~

codecov-io · 2020-01-23T00:17:59Z

Codecov Report

Merging #727 into master will decrease coverage by 1.45%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master     #727      +/-   ##
==========================================
- Coverage   92.47%   91.01%   -1.46%     
==========================================
  Files         234      234              
  Lines       10475    10599     +124     
  Branches      944      959      +15     
==========================================
- Hits         9687     9647      -40     
- Misses        788      952     +164

Impacted Files	Coverage Δ
...ckages/opentelemetry-plugin-ioredis/src/ioredis.ts	`100% <100%> (ø)`	⬆️
...lemetry-plugin-http/test/functionals/utils.test.ts	`99.37% <100%> (+0.02%)`	⬆️
...try-propagator-jaeger/src/JaegerHttpTraceFormat.ts	`95.65% <100%> (ø)`	⬆️
packages/opentelemetry-plugin-http/src/utils.ts	`97.26% <100%> (-0.66%)`	⬇️
...opagator-jaeger/test/JaegerHttpTraceFormat.test.ts	`100% <100%> (ø)`	⬆️
...y-plugin-http/test/functionals/http-enable.test.ts	`96.21% <100%> (ø)`	⬆️
packages/opentelemetry-core/test/utils/url.test.ts	`50% <0%> (-50%)`	⬇️
...pentelemetry-core/test/internal/validators.test.ts	`50% <0%> (-50%)`	⬇️
...elemetry-core/test/trace/spancontext-utils.test.ts	`55.55% <0%> (-44.45%)`	⬇️
...lemetry-core/test/trace/ProbabilitySampler.test.ts	`56.52% <0%> (-43.48%)`	⬇️
... and 33 more

mayurkale22

Overall I like the idea, added a few comments in the first phase.

packages/opentelemetry-api/package.json

packages/opentelemetry-api/src/api/tracing.ts

packages/opentelemetry-api/src/index.ts

packages/opentelemetry-api/src/trace/NoopTracer.ts

packages/opentelemetry-api/test/noop-meter.test.ts

packages/opentelemetry-api/package.json

vmarchaud

i didn't reviewed every files but it seems good, i mostly want to say that i agree with that changes.

obecny

left few comments, lgtm, although not sure if we should change it this now or later for safety and also this change should be released with major version, not patch

packages/opentelemetry-api/src/api/trace.ts

obecny · 2020-01-23T12:41:55Z

packages/opentelemetry-api/src/api/trace.ts

+  }
+
+  /**
+   * Set the current global tracer. Returns the initialized global tracer registry


if this function only sets registry, it should have different name then init
Maybe add or set because it doesn't init anything

This was brought over from the old core package. A rename like this could be discussed though. cc @mayurkale22

obecny · 2020-01-23T12:45:15Z

packages/opentelemetry-api/src/trace/NoopSpan.ts

+import { Status } from './status';
+import { TraceFlags } from './trace_flags';
+
+export const INVALID_TRACE_ID = '0';


why is it 0 and not empty for example ?

This was the exact example in the old core package. I think because it needs to satisfy the typings of the TraceContext interface.

OlivierAlbertini

LGTM

packages/opentelemetry-api/README.md

packages/opentelemetry-api/package.json

mayurkale22

lgtm

mayurkale22 · 2020-01-23T18:59:43Z

@markwolff and @xiao-lix it would be nice if you can review this change.

markwolff

Overall SGTM. Agree with the concept as I think it is what other SIGs (e.g python) were already doing.

markwolff · 2020-01-23T20:31:49Z

packages/opentelemetry-metrics/test/Meter.test.ts

@@ -205,19 +200,19 @@ describe('Meter', () => {

      it('should return no op metric if name is an empty string', () => {
        const counter = meter.createCounter('');
-        assert.ok(counter instanceof NoopMetric);
+        assert.ok(counter instanceof types.NoopMetric);


nit: I usually expect * as types imports to be only used for types and to be compiled away.

An instanceof cannot be compiled away because it is a runtime check. In any case, this is a test not deployed code.

Yes sorry I should have been more clear. I am proposing renaming this to * as core or * as api, but as you've stated this is only a test so its only a nit :)

Even if it wasn't a test, this is an instanceof check which is a runtime check that can't be compiled away.

I agree. My point is that because it is not being compiled away, using import * as types here is misleading because it is being used for something other than just compile-time types.

dyladan · 2020-01-27T16:56:36Z

Looks like one of our dependencies doesn't like node 8 anymore and requires 10 or higher

nstawski · 2020-01-29T17:27:23Z

Will have to update the documentation in /getting-started in all places where @opentelemetry/types is used.

* feat: create an api package * chore: update circle for new api package * chore: bring back getTracer * chore: add wrongly removed dev dependency * chore: review comments * chore: review comments * chore: lint * chore: export all noop implementations * chore: update API README * chore: ignore known working links that are not yet published * chore: add jsdoc for getInstance calls * chore: add jsdoc for private constructors * chore: review comments * chore: fix readme npm url * chore: fix old readmes without registry * chore: update api calling convention

Co-authored-by: Amir Blum <[email protected]> Co-authored-by: Bartlomiej Obecny <[email protected]>

dyladan added 2 commits January 22, 2020 18:06

feat: create an api package

357267e

Merge remote-tracking branch 'origin/master' into api-separation

bb1c264

dyladan requested review from bg451, markwolff, mayurkale22, obecny, OlivierAlbertini, rochdev and vmarchaud as code owners January 22, 2020 23:24

dyladan added 3 commits January 22, 2020 18:27

chore: update circle for new api package

bb13ea8

chore: bring back getTracer

53e4197

chore: add wrongly removed dev dependency

298ee9e

mayurkale22 reviewed Jan 23, 2020

View reviewed changes

dyladan added 3 commits January 22, 2020 19:58

chore: review comments

0def03a

chore: review comments

7a30fc1

chore: lint

b53bfbe

vmarchaud approved these changes Jan 23, 2020

View reviewed changes

chore: export all noop implementations

4769174

obecny approved these changes Jan 23, 2020

View reviewed changes

dyladan added 4 commits January 23, 2020 09:44

chore: update API README

23232ed

chore: ignore known working links that are not yet published

814891c

chore: add jsdoc for getInstance calls

8e6a95e

chore: add jsdoc for private constructors

9a671ae

dyladan requested a review from mayurkale22 January 23, 2020 15:06

OlivierAlbertini approved these changes Jan 23, 2020

View reviewed changes

mayurkale22 reviewed Jan 23, 2020

View reviewed changes

dyladan added 2 commits January 23, 2020 13:43

chore: review comments

a6b7db8

Merge remote-tracking branch 'origin/master' into api-separation

9314357

mayurkale22 approved these changes Jan 23, 2020

View reviewed changes

mayurkale22 added API and removed size/XXL labels Jan 23, 2020

dyladan mentioned this pull request Jan 23, 2020

OpenTelemetry types package renaming Azure/azure-sdk-for-js#7079

Closed

markwolff approved these changes Jan 23, 2020

View reviewed changes

Merge remote-tracking branch 'origin/master' into api-separation

7fc7247

dyladan added 4 commits January 29, 2020 15:04

Merge remote-tracking branch 'origin/master' into api-separation

fb91c52

chore: fix readme npm url

d9e81d1

chore: fix old readmes without registry

2d5f329

chore: update api calling convention

ebab028

mayurkale22 merged commit 5d6c99d into open-telemetry:master Jan 29, 2020

OlivierAlbertini added the breaking label Jan 30, 2020

Flarna deleted the api-separation branch June 12, 2020 21:20

pichlermarc pushed a commit to dynatrace-oss-contrib/opentelemetry-js that referenced this pull request Dec 15, 2023

chore: release main (open-telemetry#727)

089e3cb

Co-authored-by: Amir Blum <[email protected]> Co-authored-by: Bartlomiej Obecny <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Api separation #727

Api separation #727

dyladan commented Jan 22, 2020 •

edited

Loading

codecov-io commented Jan 23, 2020 •

edited

Loading

mayurkale22 left a comment

vmarchaud left a comment

obecny left a comment •

edited

Loading

obecny Jan 23, 2020

dyladan Jan 23, 2020

obecny Jan 23, 2020

dyladan Jan 23, 2020

OlivierAlbertini left a comment

mayurkale22 left a comment

mayurkale22 commented Jan 23, 2020

markwolff left a comment

markwolff Jan 23, 2020

dyladan Jan 23, 2020

markwolff Jan 24, 2020

dyladan Jan 24, 2020

markwolff Jan 25, 2020 •

edited

Loading

dyladan commented Jan 27, 2020

nstawski commented Jan 29, 2020

Api separation #727

Api separation #727

Conversation

dyladan commented Jan 22, 2020 • edited Loading

Which problem is this PR solving?

Short description of the changes

TODO:

codecov-io commented Jan 23, 2020 • edited Loading

Codecov Report

mayurkale22 left a comment

Choose a reason for hiding this comment

vmarchaud left a comment

Choose a reason for hiding this comment

obecny left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

OlivierAlbertini left a comment

Choose a reason for hiding this comment

mayurkale22 left a comment

Choose a reason for hiding this comment

mayurkale22 commented Jan 23, 2020

markwolff left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

markwolff Jan 25, 2020 • edited Loading

Choose a reason for hiding this comment

dyladan commented Jan 27, 2020

nstawski commented Jan 29, 2020

dyladan commented Jan 22, 2020 •

edited

Loading

codecov-io commented Jan 23, 2020 •

edited

Loading

obecny left a comment •

edited

Loading

markwolff Jan 25, 2020 •

edited

Loading