Skip to content

Commit a411313

Browse files
authored
Refactor: Consistent package naming and structure (#413)
* fix(http-plugin): move node-sdk to dev deps * refactor: rename opentelemetry-sdk-base * refactor: rename opentelemetry-tracer-basic * refactor: rename opentelemetry-node-sdk * docs: update readme * docs: update readme * refactor: rename opentelemetry-tracer-web * fix: styling * fix: doc consistency * fix: sliiped in typo * fix: postgres and doc
1 parent 3b3030c commit a411313

File tree

146 files changed

+181
-181
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

146 files changed

+181
-181
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This is the JavaScript version of [OpenTelemetry](https://opentelemetry.io/), a
1010
> This project is currently in Alpha stage. Its APIs can change at any time and it is not intended to be used in production scenarios!
1111
1212
## Quick start
13-
To get started, see [@opentelemetry/tracer-basic](https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-tracer-basic) for an SDK that supports creating traces through manual instrumentation or [@opentelemetry/node-sdk](https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-node-sdk) which provides auto-instrumentation for Node.js applications.
13+
To get started, see [@opentelemetry/tracing](https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-tracing) for an SDK that supports creating traces through manual instrumentation or [@opentelemetry/node](https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-node) which provides auto-instrumentation for Node.js applications.
1414

1515
## Release Schedule
1616

@@ -52,8 +52,8 @@ We have a weekly SIG meeting! See the [community page](https://github.com/open-t
5252

5353
| Package | Description |
5454
| ----------------------- | -----------------|
55-
| [@opentelemetry/tracer-basic](https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-tracer-basic) | This module provides a full control over instrumentation and span creation. It doesn't load [`async_hooks`](https://nodejs.org/api/async_hooks.html) or any instrumentation plugin by default. It is intended for use both on the server and in the browser. |
56-
| [@opentelemetry/node-sdk](https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-node-sdk) | This module provides automatic tracing for Node.js applications. It is intended for use on the server only. |
55+
| [@opentelemetry/tracing](https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-tracing) | This module provides a full control over instrumentation and span creation. It doesn't load [`async_hooks`](https://nodejs.org/api/async_hooks.html) or any instrumentation plugin by default. It is intended for use both on the server and in the browser. |
56+
| [@opentelemetry/node](https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-node) | This module provides automatic tracing for Node.js applications. It is intended for use on the server only. |
5757

5858
### Exporters
5959

doc/plugin-guide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ export const plugin = new HttpPlugin(...);
1616
```
1717

1818
> Example of simple module plugin created and used in the tests.
19-
https://github.com/open-telemetry/opentelemetry-js/blob/master/packages/opentelemetry-node-sdk/test/instrumentation/node_modules/%40opentelemetry/plugin-simple-module/simple-module.js
19+
https://github.com/open-telemetry/opentelemetry-js/blob/master/packages/opentelemetry-node/test/instrumentation/node_modules/%40opentelemetry/plugin-simple-module/simple-module.js
2020

2121
After the plugin is created, it must be added in the [list of default supported plugins][DEFAULT_INSTRUMENTATION_PLUGINS].
2222
```typescript
@@ -48,4 +48,4 @@ Please refer to the [HTTP instrumentation][http-plugin] or [gRPC instrumentation
4848
[base-plugin]: https://github.com/open-telemetry/opentelemetry-js/blob/master/packages/opentelemetry-core/src/trace/instrumentation/BasePlugin.ts#L29
4949
[http-plugin]: https://github.com/open-telemetry/opentelemetry-js/blob/master/packages/opentelemetry-plugin-http/src/http.ts#L44
5050
[grpc-plugin]: https://github.com/open-telemetry/opentelemetry-js/blob/master/packages/opentelemetry-plugin-grpc/src/grpc.ts#L52
51-
[DEFAULT_INSTRUMENTATION_PLUGINS]: https://github.com/open-telemetry/opentelemetry-js/blob/master/packages/opentelemetry-node-sdk/src/config.ts#L29
51+
[DEFAULT_INSTRUMENTATION_PLUGINS]: https://github.com/open-telemetry/opentelemetry-js/blob/master/packages/opentelemetry-node/src/config.ts#L29

examples/basic-tracer-node/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Overview
22

3-
This example shows how to use [@opentelemetry/tracer-basic](https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-tracer-basic) to instrument a simple Node.js application - e.g. a batch job.
3+
This example shows how to use [@opentelemetry/tracing](https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-tracing) to instrument a simple Node.js application - e.g. a batch job.
44
It supports exporting spans either to [Zipkin](https://zipkin.io) or to [Jaeger](https://www.jaegertracing.io).
55

66
## Installation
@@ -59,7 +59,7 @@ Click on the trace to view its details.
5959

6060
## Useful links
6161
- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
62-
- For more information on tracer-basic, visit: <https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-tracer-basic>
62+
- For more information on tracer-basic, visit: <https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-tracing>
6363

6464
## LICENSE
6565

examples/basic-tracer-node/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
const opentelemetry = require('@opentelemetry/core');
2-
const { BasicTracer, SimpleSpanProcessor } = require('@opentelemetry/tracer-basic');
2+
const { BasicTracer, SimpleSpanProcessor } = require('@opentelemetry/tracing');
33
const { JaegerExporter } = require('@opentelemetry/exporter-jaeger');
44
const { ZipkinExporter } = require('@opentelemetry/exporter-zipkin');
55

examples/basic-tracer-node/package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "example-tracer-basic-node",
33
"private": true,
44
"version": "0.1.0",
5-
"description": "Example of using @opentelemetry/tracer-basic in Node.js",
5+
"description": "Example of using @opentelemetry/tracing in Node.js",
66
"main": "index.js",
77
"scripts": {
88
"zipkin:basic": "cross-env EXPORTER=zipkin node ./index.js",
@@ -29,10 +29,10 @@
2929
"@opentelemetry/core": "^0.1.0",
3030
"@opentelemetry/exporter-jaeger": "^0.1.0",
3131
"@opentelemetry/exporter-zipkin": "^0.1.0",
32-
"@opentelemetry/tracer-basic": "^0.1.0"
32+
"@opentelemetry/tracing": "^0.1.0"
3333
},
3434
"homepage": "https://github.com/open-telemetry/opentelemetry-js#readme",
3535
"devDependencies": {
3636
"cross-env": "^6.0.0"
3737
}
38-
}
38+
}

examples/grpc/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Go to Jaeger with your browser [http://localhost:50051/trace/(your-trace-id)]()
6161

6262
## Useful links
6363
- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
64-
- For more information on OpenTelemetry for Node.js, visit: <https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-node-sdk>
64+
- For more information on OpenTelemetry for Node.js, visit: <https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-node>
6565

6666
## LICENSE
6767

examples/grpc/package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,11 @@
2828
"url": "https://github.com/open-telemetry/opentelemetry-js/issues"
2929
},
3030
"dependencies": {
31-
"@opentelemetry/tracer-basic": "^0.1.0",
31+
"@opentelemetry/tracing": "^0.1.0",
3232
"@opentelemetry/core": "^0.1.0",
3333
"@opentelemetry/exporter-jaeger": "^0.1.0",
3434
"@opentelemetry/exporter-zipkin": "^0.1.0",
35-
"@opentelemetry/node-sdk": "^0.1.0",
35+
"@opentelemetry/node": "^0.1.0",
3636
"@opentelemetry/plugin-grpc": "^0.1.0",
3737
"google-protobuf": "^3.9.2",
3838
"grpc": "^1.23.3",
@@ -42,4 +42,4 @@
4242
"devDependencies": {
4343
"cross-env": "^6.0.0"
4444
}
45-
}
45+
}

examples/grpc/setup.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
'use strict';
22

33
const opentelemetry = require('@opentelemetry/core');
4-
const { NodeTracer } = require('@opentelemetry/node-sdk');
5-
const { SimpleSpanProcessor } = require('@opentelemetry/tracer-basic');
4+
const { NodeTracer } = require('@opentelemetry/node');
5+
const { SimpleSpanProcessor } = require('@opentelemetry/tracing');
66
const { JaegerExporter } = require('@opentelemetry/exporter-jaeger');
77
const { ZipkinExporter } = require('@opentelemetry/exporter-zipkin');
88
const EXPORTER = process.env.EXPORTER || '';

examples/http/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Go to Jaeger with your browser [http://localhost:16686/trace/(your-trace-id)]()
7070

7171
## Useful links
7272
- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
73-
- For more information on OpenTelemetry for Node.js, visit: <https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-node-sdk>
73+
- For more information on OpenTelemetry for Node.js, visit: <https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-node>
7474

7575
## LICENSE
7676

examples/http/package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,12 @@
3131
"@opentelemetry/core": "^0.1.0",
3232
"@opentelemetry/exporter-jaeger": "^0.1.0",
3333
"@opentelemetry/exporter-zipkin": "^0.1.0",
34-
"@opentelemetry/node-sdk": "^0.1.0",
34+
"@opentelemetry/node": "^0.1.0",
3535
"@opentelemetry/plugin-http": "^0.1.0",
36-
"@opentelemetry/tracer-basic": "^0.1.0"
36+
"@opentelemetry/tracing": "^0.1.0"
3737
},
3838
"homepage": "https://github.com/open-telemetry/opentelemetry-js#readme",
3939
"devDependencies": {
4040
"cross-env": "^6.0.0"
4141
}
42-
}
42+
}

0 commit comments

Comments
 (0)