Initial skeleton #2

mayurkale22 · 2019-05-15T00:35:55Z

This PR contains,

npm init
lerna init
Created a opentelemetry-core package.
Added common tsconfig.base.json in the root of our project, each individual package will have its own tsconfig.json whose extended root.

A high level package structure. The core package includes interfaces for trace, metrics, tags and resources along with no-op implementations.

opentelemetry/core
   |__ trace/
      |__ propagation/
      |__ samplers/
   |__ metrics/
      |__ stats/
   |__ tags/
      |__ propagation/
   |__ resources/
   |__ utils/

New Update

API Package layout specs : open-telemetry/opentelemetry-specification#86

mayurkale22 · 2019-05-15T03:12:58Z

I signed it

justindsmith

LGTM!

mayurkale22 · 2019-05-17T17:22:36Z

@draffensperger Can you please review this?

draffensperger · 2019-05-17T19:47:47Z

package.json

@@ -0,0 +1,32 @@
+{
+  "name": "opentelemetry",


Should this be opentelemetry-base similar to the @opencensus/opencensus-base for OpenCensus?

Done. Thanks

mayurkale22 · 2019-05-17T20:31:38Z

@flands Can we merge this?

mayurkale22 · 2019-06-03T18:06:13Z

@rochdev Could you please review this?

rochdev · 2019-06-03T19:58:11Z

Will review by the end of the day.

rochdev · 2019-06-03T22:33:03Z

package.json

+  "description": "OpenTelemetry is a distributed tracing and stats collection framework.",
+  "main": "build/src/index.js",
+  "types": "build/src/index.d.ts",
+  "scripts": {


There should be a script to do TDD in watch mode. I find this is usually very hard to add later on, especially in TypeScript projects that take an increasing amount of time to build.

Sure, done. "tdd": "yarn run test -- --watch-extensions ts --watch"

rochdev · 2019-06-03T22:38:41Z

package.json

+  "license": "Apache-2.0",
+  "devDependencies": {
+    "lerna": "^3.13.4",
+    "typescript": "^3.4.5"


Was there ever a discussion to determine whether it makes sense to use TypeScript? As discussed in a few other issues already, I feel that for a Node library, and especially this type of project, it can actually make it very difficult to have for example different code paths per version of Node, or to test constructs that don't exist in every versions.

I think it would be a good exercise to actually weigh the pros and cons and not simply go with TypeScript because of its popularity. Also, do we have a plan for how watch mode would work with TypeScript?

TypeScript was agreed upon by the majority. A guideline will be created to ensure it is used in a way that is compatible with this type of project.

rochdev · 2019-06-03T22:39:34Z

package.json

+  "types": "build/src/index.d.ts",
+  "scripts": {
+    "fix": "lerna run fix",
+    "postinstall": "npm run bootstrap",


Why was npm used over yarn? I try to go back to npm pretty much every year but in the end yarn is always superior.

rochdev

LGTM. Left a few comments about a few things I think are worth discussing, but the structure itself looks good 👍

mayurkale22 · 2019-06-06T00:13:50Z

@rochdev Added tdd script in watch mode, removed lockfiles (as discussed in the meeting) and used yarn wherever needed. PTAL

rochdev

LGTM. The TS compilation rules may need to be adjusted, but this can happen according to the TypeScript Guideline discussion after this is merged.

vmarchaud

LGTM, just a quick remark on the ts config

vmarchaud · 2019-06-07T12:19:51Z

packages/tsconfig.base.json

+    "allowUnusedLabels": false,
+    "declaration": true,
+    "forceConsistentCasingInFileNames": true,
+    "lib": ["es2016"],


i don't think we need to bundle the es6 since we target es6,everything should be available at runtime

I agree. In general, I think a few rules will change once we work on the TypeScript guidelines if we decide to go with bundling basically nothing and relying on manually provided shims. (manually in the sense that we require them based on conditions, not that the user has to do it)

chore: removing _cleanupGlobalShutdownListeners

Add ResourceProvider to sessions prototype

mayurkale22 requested review from flands and justindsmith May 15, 2019 00:35

justindsmith approved these changes May 15, 2019

View reviewed changes

draffensperger approved these changes May 17, 2019

View reviewed changes

rochdev reviewed Jun 3, 2019

View reviewed changes

mayurkale22 mentioned this pull request Jun 3, 2019

Package Manager: npm or yarn #14

Closed

draffensperger mentioned this pull request Jun 5, 2019

Typescript vs Pure Javascript #15

Closed

rochdev approved these changes Jun 6, 2019

View reviewed changes

danielkhan approved these changes Jun 7, 2019

View reviewed changes

vmarchaud approved these changes Jun 7, 2019

View reviewed changes

mayurkale22 added 6 commits June 7, 2019 11:18

Initial API Skeleton

1e260f1

remove build files

3ff6439

Rename base package to opentelemetry-base

b2143b4

Package rename api -> core

0fb172b

Add tdd script, npm->yarn, remove lockfiles

3083022

remove --lib option from tsconfig

539962a

mayurkale22 force-pushed the initial_skeleton branch from d95fa67 to 539962a Compare June 7, 2019 18:33

mayurkale22 requested review from iredelmeier and yurishkuro as code owners June 7, 2019 18:33

mayurkale22 merged commit efe9fab into open-telemetry:master Jun 10, 2019

mayurkale22 deleted the initial_skeleton branch June 10, 2019 17:23

mayurkale22 mentioned this pull request Jun 10, 2019

TypeScript Guideline #22

Closed

rochdev mentioned this pull request Jun 14, 2019

REQUEST: New membership for @rochdev open-telemetry/community#112

Closed

6 tasks

davidwitten added a commit to davidwitten/opentelemetry-js that referenced this pull request Jun 26, 2020

Rename, try open-telemetry#2

0f078f5

obecny referenced this pull request in obecny/opentelemetry-js Aug 13, 2020

Merge pull request #2 from obecny/pr_1321_fix

9c21dbb

chore: removing _cleanupGlobalShutdownListeners

martinkuba referenced this pull request in martinkuba/opentelemetry-js Apr 23, 2022

Merge pull request #2 from martinkuba/session-prototype-resourceprovider

3887c6f

Add ResourceProvider to sessions prototype

trentm mentioned this pull request Jul 13, 2023

ESM output not functional #3989

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Initial skeleton #2

Initial skeleton #2

mayurkale22 commented May 15, 2019 •

edited

Loading

mayurkale22 commented May 15, 2019

justindsmith left a comment

mayurkale22 commented May 17, 2019

draffensperger May 17, 2019

mayurkale22 May 17, 2019

mayurkale22 commented May 17, 2019

mayurkale22 commented Jun 3, 2019

rochdev commented Jun 3, 2019

rochdev Jun 3, 2019

mayurkale22 Jun 6, 2019

rochdev Jun 3, 2019

rochdev Jun 5, 2019

rochdev Jun 3, 2019

mayurkale22 Jun 6, 2019

rochdev left a comment

mayurkale22 commented Jun 6, 2019

rochdev left a comment

vmarchaud left a comment

vmarchaud Jun 7, 2019

rochdev Jun 7, 2019

mayurkale22 Jun 7, 2019

Initial skeleton #2

Initial skeleton #2

Conversation

mayurkale22 commented May 15, 2019 • edited Loading

New Update

mayurkale22 commented May 15, 2019

justindsmith left a comment

Choose a reason for hiding this comment

mayurkale22 commented May 17, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mayurkale22 commented May 17, 2019

mayurkale22 commented Jun 3, 2019

rochdev commented Jun 3, 2019

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

Choose a reason for hiding this comment

rochdev left a comment

Choose a reason for hiding this comment

mayurkale22 commented Jun 6, 2019

rochdev left a comment

Choose a reason for hiding this comment

vmarchaud 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

mayurkale22 commented May 15, 2019 •

edited

Loading