You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -57,20 +57,20 @@ Please also see [GitHub workflow](https://github.com/open-telemetry/community/bl
57
57
58
58
The `opentelemetry-js` project is written in TypeScript.
59
59
60
-
-`yarn install` or `npm install` to install dependencies.
61
-
-`yarn compile` or `npm run compile` compiles the code, checking for type errors.
62
-
-`yarn bootstrap` or `npm run bootstrap` Bootstrap the packages in the current Lerna repo. Installs all of their dependencies and links any cross-dependencies.
63
-
-`yarn test` or `npm test` tests code the same way that our CI will test it.
64
-
-`yarn fix` or `npm run fix` lint (and maybe fix) any changes.
60
+
-`npm install` to install dependencies.
61
+
-`npm run compile` compiles the code, checking for type errors.
62
+
-`npm run bootstrap` Bootstrap the packages in the current Lerna repo. Installs all of their dependencies and links any cross-dependencies.
63
+
-`npm test` tests code the same way that our CI will test it.
64
+
-`npm run fix` lint (and maybe fix) any changes.
65
65
66
66
67
67
### Generating API documentation
68
-
-`yarn docs` or `npm run docs` to generate API documentation. Generates the documentation in `packages/opentelemetry-api/docs/out`
68
+
-`npm run docs` to generate API documentation. Generates the documentation in `packages/opentelemetry-api/docs/out`
69
69
70
70
### Generating CHANGELOG documentation
71
-
-`yarn changelog` or `npm run changelog` to generate CHANGELOG documentation in your terminal (see [RELEASING.md](RELEASING.md) for more details).
71
+
-`npm run changelog` to generate CHANGELOG documentation in your terminal (see [RELEASING.md](RELEASING.md) for more details).
72
72
73
73
### Benchmarks
74
74
When two or more approaches must be compared, please write a benchmark in the benchmark/index.js module so that we can keep track of the most efficient algorithm.
75
75
76
-
-`yarn bench` or `npm run bench` to run your benchmark.
|[@opentelemetry/api][otel-api]| This package provides TypeScript interfacesand enums for the OpenTelemetry core trace and metrics model. It is intended for use both on the server and in the browser. |
99
+
|[@opentelemetry/api][otel-api]| This package provides TypeScript interfaces, enums and no-op implementations for the OpenTelemetry core trace and metrics model. It is intended for use both on the server and in the browser. |
100
100
|[@opentelemetry/core][otel-core]| This package provides default and no-op implementations of the OpenTelemetry api for trace and metrics. It's intended for use both on the server and in the browser. |
101
101
102
102
### Implementation / SDKs
@@ -137,10 +137,12 @@ OpenTelemetry can collect tracing data automatically using plugins. Vendors/User
-[@opentelemetry/plugin-dns][otel-plugin-dns] - By default, this plugin is not loaded [#612](https://github.com/open-telemetry/opentelemetry-js/issues/612)
140
+
-[@opentelemetry/plugin-express][otel-plugin-express] - By default, this plugin is not loaded
To request automatic tracing support for a module not on this list, please [file an issue](https://github.com/open-telemetry/opentelemetry-js/issues). Alternatively, you can [write a plugin yourself](https://github.com/open-telemetry/opentelemetry-js/blob/master/doc/plugin-guide.md).
146
148
@@ -191,7 +193,9 @@ Apache 2.0 - See [LICENSE][license-url] for more information.
Copy file name to clipboardExpand all lines: doc/development-guide.md
+8-10Lines changed: 8 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,19 +2,17 @@
2
2
3
3
Before contributing to this open source project, read our [CONTRIBUTING](../CONTRIBUTING.md). We gratefully welcome improvements to documentation as well as to code.
4
4
5
-
The code base is a monorepo. We use [Lerna](https://lerna.js.org/) for managing inter-module dependencies, which makes it easier to develop coordinated changes between the modules. Instead of running lerna directly, the commands are wrapped with `yarn`;
5
+
The code base is a monorepo. We use [Lerna](https://lerna.js.org/) for managing inter-module dependencies, which makes it easier to develop coordinated changes between the modules. Instead of running lerna directly, the commands are wrapped with `npm`;
6
6
7
7
### Requirements
8
8
9
9
Since this project supports multiple Node versions, using a version
10
10
manager such as [nvm](https://github.com/creationix/nvm) is recommended.
11
11
12
-
We use [yarn](https://yarnpkg.com/) for its workspace functionality, so make sure to install that as well.
13
-
14
-
To get started once you have Node and yarn installed, run:
12
+
To get started once you have Node installed, run:
15
13
16
14
```sh
17
-
$ yarn
15
+
$ npm install
18
16
```
19
17
20
18
This will install all the necessary modules.
@@ -26,13 +24,13 @@ This will install all the necessary modules.
26
24
To run the all unit tests, use:
27
25
28
26
```sh
29
-
$ yarntest
27
+
$ npm runtest
30
28
```
31
29
32
30
To run the unit tests continuously in watch mode while developing, use:
33
31
34
32
```sh
35
-
$ yarn tdd
33
+
$ npm run tdd
36
34
```
37
35
38
36
### Linting
@@ -43,12 +41,12 @@ Before raising a pull request, make sure there are no lint problems.
43
41
44
42
To check the linter, use:
45
43
```sh
46
-
$ yarn run check
44
+
$ npm run check
47
45
```
48
46
49
47
To fix the linter, use:
50
48
```sh
51
-
$ yarn fix
49
+
$ npm run fix
52
50
```
53
51
54
52
### Continuous Integration
@@ -74,7 +72,7 @@ We use [typedoc](https://www.npmjs.com/package/typedoc) to generate the api docu
74
72
75
73
To generate the docs, use:
76
74
```sh
77
-
$ yarn docs
75
+
$ npm run docs
78
76
```
79
77
80
78
The document will be available under `packages/opentelemetry-api/docs/out` path.
Copy file name to clipboardExpand all lines: doc/exporter-guide.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -43,7 +43,7 @@ The `MetricExporter` defines the interface that protocol-specific exporters must
43
43
44
44
The current `MetricExporter` interface (`0.2.0`) defines 2 methods:
45
45
46
-
-`export`: Exports a batch of telemetry data. In this method you’ll process and translate `ReadableMetric` Data into the data that your metric backend accepts.
46
+
-`export`: Exports a batch of telemetry data. In this method you’ll process and translate `MetricRecord` Data into the data that your metric backend accepts.
47
47
48
48
-`shutdown`: Shuts down the exporter. This is an opportunity for exporter to do any cleanup required. `Shutdown` should be called only once for each Exporter instance. After the call to `Shutdown` subsequent calls to Export are not allowed and should return `FailedNotRetryable` error.
Copy file name to clipboardExpand all lines: doc/plugin-guide.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Plugin Developer Guide
2
2
3
-
The `NodeTracer` or `Node-SDK` is driven by a set of plugins that describe how to patch a module to generate trace spans when that module is used. We provide out-of-the-box instrumentation for many popular frameworks and libraries by using a plugin system (see [builtin plugins][builtin-plugins]), and provide a means for developers to create their own.
3
+
The `NodeTracerProvider` or `Node-SDK` is driven by a set of plugins that describe how to patch a module to generate trace spans when that module is used. We provide out-of-the-box instrumentation for many popular frameworks and libraries by using a plugin system (see [builtin plugins][builtin-plugins]), and provide a means for developers to create their own.
4
4
5
5
We strongly recommended to create a dedicated package for newly added plugin, example: `@opentelemetry/plugin-xxx`.
0 commit comments