Rename @opentelemetry/sdk-metrics-base to @opentelemetry/sdk-metrics (#3162)
* Rename @opentelemetry/sdk-metrics-base to @opentelemetry/sdk-metrics * Update all remaining references * Addressing comments * Add pr number in changelog * Changing path of metrics SDK project
This commit is contained in:
parent
3cca2cec8f
commit
6807deff5a
|
|
@ -228,7 +228,7 @@ Maintainers ([@open-telemetry/js-maintainers](https://github.com/orgs/open-telem
|
||||||
| Package | Description |
|
| Package | Description |
|
||||||
| ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| [@opentelemetry/sdk-trace-base][otel-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 by default. It is intended for use both on the server and in the browser. |
|
| [@opentelemetry/sdk-trace-base][otel-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 by default. It is intended for use both on the server and in the browser. |
|
||||||
| [@opentelemetry/sdk-metrics-base][otel-metrics] | This module provides instruments and meters for reporting of time series data. |
|
| [@opentelemetry/sdk-metrics][otel-metrics] | This module provides instruments and meters for reporting of time series data. |
|
||||||
| [@opentelemetry/sdk-trace-node][otel-node] | This module provides automatic tracing for Node.js applications. It is intended for use on the server only. |
|
| [@opentelemetry/sdk-trace-node][otel-node] | This module provides automatic tracing for Node.js applications. It is intended for use on the server only. |
|
||||||
| [@opentelemetry/sdk-trace-web][otel-web] | This module provides automated instrumentation and tracing for Web applications. It is intended for use in the browser only. |
|
| [@opentelemetry/sdk-trace-web][otel-web] | This module provides automated instrumentation and tracing for Web applications. It is intended for use in the browser only. |
|
||||||
|
|
||||||
|
|
@ -540,7 +540,7 @@ Apache 2.0 - See [LICENSE][license-url] for more information.
|
||||||
[compliance-matrix]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/spec-compliance-matrix.md
|
[compliance-matrix]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/spec-compliance-matrix.md
|
||||||
[CONTRIBUTING]: https://github.com/open-telemetry/opentelemetry-js/blob/main/CONTRIBUTING.md
|
[CONTRIBUTING]: https://github.com/open-telemetry/opentelemetry-js/blob/main/CONTRIBUTING.md
|
||||||
|
|
||||||
[otel-metrics]: https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/opentelemetry-sdk-metrics-base
|
[otel-metrics]: https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/opentelemetry-sdk-metrics
|
||||||
[otel-node]: https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-sdk-trace-node
|
[otel-node]: https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-sdk-trace-node
|
||||||
|
|
||||||
[otel-instrumentation-fetch]: https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/opentelemetry-instrumentation-fetch
|
[otel-instrumentation-fetch]: https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/opentelemetry-instrumentation-fetch
|
||||||
|
|
|
||||||
|
|
@ -11,7 +11,7 @@ Sometimes you may want to use a specific aggregator for one of your metric, expo
|
||||||
Here is what an aggregator that does that would look like:
|
Here is what an aggregator that does that would look like:
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
import { Aggregator } from '@opentelemetry/sdk-metrics-base';
|
import { Aggregator } from '@opentelemetry/sdk-metrics';
|
||||||
import { hrTime } from '@opentelemetry/core';
|
import { hrTime } from '@opentelemetry/core';
|
||||||
|
|
||||||
export class AverageAggregator implements Aggregator {
|
export class AverageAggregator implements Aggregator {
|
||||||
|
|
@ -54,7 +54,7 @@ import {
|
||||||
CounterSumAggregator,
|
CounterSumAggregator,
|
||||||
ObserverAggregator,
|
ObserverAggregator,
|
||||||
MeasureExactAggregator,
|
MeasureExactAggregator,
|
||||||
} from '@opentelemetry/sdk-metrics-base';
|
} from '@opentelemetry/sdk-metrics';
|
||||||
|
|
||||||
export class CustomProcessor extends UngroupedProcessor {
|
export class CustomProcessor extends UngroupedProcessor {
|
||||||
aggregatorFor (metricDescriptor: MetricDescriptor) {
|
aggregatorFor (metricDescriptor: MetricDescriptor) {
|
||||||
|
|
@ -86,7 +86,7 @@ import {
|
||||||
MeasureExactAggregator,
|
MeasureExactAggregator,
|
||||||
MeterProvider,
|
MeterProvider,
|
||||||
Aggregator,
|
Aggregator,
|
||||||
} from '@opentelemetry/sdk-metrics-base';
|
} from '@opentelemetry/sdk-metrics';
|
||||||
import { hrTime } from '@opentelemetry/core';
|
import { hrTime } from '@opentelemetry/core';
|
||||||
|
|
||||||
export class AverageAggregator implements Aggregator {
|
export class AverageAggregator implements Aggregator {
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
const { DiagConsoleLogger, DiagLogLevel, diag } = require('@opentelemetry/api');
|
const { DiagConsoleLogger, DiagLogLevel, diag } = require('@opentelemetry/api');
|
||||||
const { metrics } = require('@opentelemetry/api-metrics');
|
const { metrics } = require('@opentelemetry/api-metrics');
|
||||||
const { OTLPMetricExporter } = require('@opentelemetry/exporter-metrics-otlp-http');
|
const { OTLPMetricExporter } = require('@opentelemetry/exporter-metrics-otlp-http');
|
||||||
const { MeterProvider, PeriodicExportingMetricReader } = require('@opentelemetry/sdk-metrics-base');
|
const { MeterProvider, PeriodicExportingMetricReader } = require('@opentelemetry/sdk-metrics');
|
||||||
|
|
||||||
// Optional and only needed to see the internal diagnostic logging (during development)
|
// Optional and only needed to see the internal diagnostic logging (during development)
|
||||||
diag.setLogger(new DiagConsoleLogger(), DiagLogLevel.DEBUG);
|
diag.setLogger(new DiagConsoleLogger(), DiagLogLevel.DEBUG);
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,7 @@
|
||||||
"name": "web-opentelemetry-example",
|
"name": "web-opentelemetry-example",
|
||||||
"private": true,
|
"private": true,
|
||||||
"version": "0.31.0",
|
"version": "0.31.0",
|
||||||
"description": "Example of using @opentelemetry/sdk-trace-web and @opentelemetry/sdk-metrics-base in browser",
|
"description": "Example of using @opentelemetry/sdk-trace-web and @opentelemetry/sdk-metrics in browser",
|
||||||
"main": "index.js",
|
"main": "index.js",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"start": "webpack serve --progress --color --port 8090 --config webpack.dev.config.js --hot --host 0.0.0.0 --compress",
|
"start": "webpack serve --progress --color --port 8090 --config webpack.dev.config.js --hot --host 0.0.0.0 --compress",
|
||||||
|
|
@ -53,7 +53,7 @@
|
||||||
"@opentelemetry/instrumentation-fetch": "0.31.0",
|
"@opentelemetry/instrumentation-fetch": "0.31.0",
|
||||||
"@opentelemetry/instrumentation-xml-http-request": "0.31.0",
|
"@opentelemetry/instrumentation-xml-http-request": "0.31.0",
|
||||||
"@opentelemetry/propagator-b3": "^1.0.1",
|
"@opentelemetry/propagator-b3": "^1.0.1",
|
||||||
"@opentelemetry/sdk-metrics-base": "0.31.0",
|
"@opentelemetry/sdk-metrics": "0.31.0",
|
||||||
"@opentelemetry/sdk-trace-base": "^1.0.1",
|
"@opentelemetry/sdk-trace-base": "^1.0.1",
|
||||||
"@opentelemetry/sdk-trace-web": "^1.0.1",
|
"@opentelemetry/sdk-trace-web": "^1.0.1",
|
||||||
"@opentelemetry/semantic-conventions": "^1.0.1"
|
"@opentelemetry/semantic-conventions": "^1.0.1"
|
||||||
|
|
|
||||||
|
|
@ -4,7 +4,7 @@ const { DiagConsoleLogger, DiagLogLevel, diag } = require('@opentelemetry/api');
|
||||||
const { OTLPMetricExporter } = require('@opentelemetry/exporter-metrics-otlp-http');
|
const { OTLPMetricExporter } = require('@opentelemetry/exporter-metrics-otlp-http');
|
||||||
// const { OTLPMetricExporter } = require('@opentelemetry/exporter-metrics-otlp-grpc');
|
// const { OTLPMetricExporter } = require('@opentelemetry/exporter-metrics-otlp-grpc');
|
||||||
// const { OTLPMetricExporter } = require('@opentelemetry/exporter-metrics-otlp-proto');
|
// const { OTLPMetricExporter } = require('@opentelemetry/exporter-metrics-otlp-proto');
|
||||||
const { MeterProvider, PeriodicExportingMetricReader } = require('@opentelemetry/sdk-metrics-base');
|
const { MeterProvider, PeriodicExportingMetricReader } = require('@opentelemetry/sdk-metrics');
|
||||||
const { Resource } = require('@opentelemetry/resources');
|
const { Resource } = require('@opentelemetry/resources');
|
||||||
const { SemanticResourceAttributes } = require('@opentelemetry/semantic-conventions');
|
const { SemanticResourceAttributes } = require('@opentelemetry/semantic-conventions');
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -38,7 +38,7 @@
|
||||||
"@opentelemetry/exporter-trace-otlp-http": "0.31.0",
|
"@opentelemetry/exporter-trace-otlp-http": "0.31.0",
|
||||||
"@opentelemetry/exporter-trace-otlp-proto": "0.31.0",
|
"@opentelemetry/exporter-trace-otlp-proto": "0.31.0",
|
||||||
"@opentelemetry/resources": "1.5.0",
|
"@opentelemetry/resources": "1.5.0",
|
||||||
"@opentelemetry/sdk-metrics-base": "0.31.0",
|
"@opentelemetry/sdk-metrics": "0.31.0",
|
||||||
"@opentelemetry/sdk-trace-base": "1.5.0",
|
"@opentelemetry/sdk-trace-base": "1.5.0",
|
||||||
"@opentelemetry/semantic-conventions": "1.5.0"
|
"@opentelemetry/semantic-conventions": "1.5.0"
|
||||||
},
|
},
|
||||||
|
|
|
||||||
|
|
@ -6,6 +6,8 @@ All notable changes to experimental packages in this project will be documented
|
||||||
|
|
||||||
### :boom: Breaking Change
|
### :boom: Breaking Change
|
||||||
|
|
||||||
|
* Rename @opentelemetry/sdk-metrics-base package to @opentelemetry/sdk-metrics [#3162](https://github.com/open-telemetry/opentelemetry-js/pull/3162) @hectorhdzg
|
||||||
|
|
||||||
### :rocket: (Enhancement)
|
### :rocket: (Enhancement)
|
||||||
|
|
||||||
* feature(add-console-metrics-exporter): add ConsoleMetricExporter [#3120](https://github.com/open-telemetry/opentelemetry-js/pull/3120) @weyert
|
* feature(add-console-metrics-exporter): add ConsoleMetricExporter [#3120](https://github.com/open-telemetry/opentelemetry-js/pull/3120) @weyert
|
||||||
|
|
|
||||||
|
|
@ -54,7 +54,7 @@ If you are using the default configurations, the prometheus client will be avail
|
||||||
## Useful links
|
## Useful links
|
||||||
|
|
||||||
- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
|
- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
|
||||||
- For more information on OpenTelemetry metrics, visit: <https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/opentelemetry-sdk-metrics-base>
|
- For more information on OpenTelemetry metrics, visit: <https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/opentelemetry-sdk-metrics>
|
||||||
- For more information on OpenTelemetry for Node.js, visit: <https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-sdk-trace-node>
|
- For more information on OpenTelemetry for Node.js, visit: <https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-sdk-trace-node>
|
||||||
|
|
||||||
## LICENSE
|
## LICENSE
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
'use strict';
|
'use strict';
|
||||||
|
|
||||||
const { DiagConsoleLogger, DiagLogLevel, diag } = require('@opentelemetry/api');
|
const { DiagConsoleLogger, DiagLogLevel, diag } = require('@opentelemetry/api');
|
||||||
const { MeterProvider } = require('@opentelemetry/sdk-metrics-base');
|
const { MeterProvider } = require('@opentelemetry/sdk-metrics');
|
||||||
const { PrometheusExporter } = require('@opentelemetry/exporter-prometheus');
|
const { PrometheusExporter } = require('@opentelemetry/exporter-prometheus');
|
||||||
|
|
||||||
// Optional and only needed to see the internal diagnostic logging (during development)
|
// Optional and only needed to see the internal diagnostic logging (during development)
|
||||||
|
|
|
||||||
|
|
@ -19,7 +19,7 @@ To get started you need to install the SDK and instrumentations, create a MeterP
|
||||||
$ # Install metrics dependencies
|
$ # Install metrics dependencies
|
||||||
$ npm install \
|
$ npm install \
|
||||||
@opentelemetry/api-metrics \
|
@opentelemetry/api-metrics \
|
||||||
@opentelemetry/sdk-metrics-base \
|
@opentelemetry/sdk-metrics \
|
||||||
@opentelemetry/exporter-prometheus # add exporters as needed
|
@opentelemetry/exporter-prometheus # add exporters as needed
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
@ -35,7 +35,7 @@ To collect traces and metrics, you will have to tell the SDK where to export tel
|
||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
const api = require("@opentelemetry/api-metrics");
|
const api = require("@opentelemetry/api-metrics");
|
||||||
const { MeterProvider } = require("@opentelemetry/sdk-metrics-base");
|
const { MeterProvider } = require("@opentelemetry/sdk-metrics");
|
||||||
const { PrometheusExporter } = require("@opentelemetry/exporter-prometheus");
|
const { PrometheusExporter } = require("@opentelemetry/exporter-prometheus");
|
||||||
|
|
||||||
const meterProvider = new MeterProvider({
|
const meterProvider = new MeterProvider({
|
||||||
|
|
|
||||||
|
|
@ -23,7 +23,7 @@ To see sample code and documentation for the traces exporter, as well as instruc
|
||||||
The OTLPMetricsExporter in Node expects the URL to only be the hostname. It will not work with `/v1/metrics`. All options that work with trace also work with metrics.
|
The OTLPMetricsExporter in Node expects the URL to only be the hostname. It will not work with `/v1/metrics`. All options that work with trace also work with metrics.
|
||||||
|
|
||||||
```js
|
```js
|
||||||
const { MeterProvider, PeriodicExportingMetricReader } = require('@opentelemetry/sdk-metrics-base');
|
const { MeterProvider, PeriodicExportingMetricReader } = require('@opentelemetry/sdk-metrics');
|
||||||
const { OTLPMetricExporter } = require('@opentelemetry/exporter-metrics-otlp-grpc');
|
const { OTLPMetricExporter } = require('@opentelemetry/exporter-metrics-otlp-grpc');
|
||||||
const collectorOptions = {
|
const collectorOptions = {
|
||||||
// url is optional and can be omitted - default is http://localhost:4317
|
// url is optional and can be omitted - default is http://localhost:4317
|
||||||
|
|
|
||||||
|
|
@ -74,7 +74,7 @@
|
||||||
"@opentelemetry/otlp-grpc-exporter-base": "0.31.0",
|
"@opentelemetry/otlp-grpc-exporter-base": "0.31.0",
|
||||||
"@opentelemetry/otlp-transformer": "0.31.0",
|
"@opentelemetry/otlp-transformer": "0.31.0",
|
||||||
"@opentelemetry/resources": "1.5.0",
|
"@opentelemetry/resources": "1.5.0",
|
||||||
"@opentelemetry/sdk-metrics-base": "0.31.0"
|
"@opentelemetry/sdk-metrics": "0.31.0"
|
||||||
},
|
},
|
||||||
"homepage": "https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/opentelemetry-exporter-metrics-otlp-grpc"
|
"homepage": "https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/opentelemetry-exporter-metrics-otlp-grpc"
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -19,7 +19,7 @@ import {
|
||||||
OTLPMetricExporterBase,
|
OTLPMetricExporterBase,
|
||||||
OTLPMetricExporterOptions
|
OTLPMetricExporterOptions
|
||||||
} from '@opentelemetry/exporter-metrics-otlp-http';
|
} from '@opentelemetry/exporter-metrics-otlp-http';
|
||||||
import { ResourceMetrics } from '@opentelemetry/sdk-metrics-base';
|
import { ResourceMetrics } from '@opentelemetry/sdk-metrics';
|
||||||
import {
|
import {
|
||||||
OTLPGRPCExporterConfigNode,
|
OTLPGRPCExporterConfigNode,
|
||||||
OTLPGRPCExporterNodeBase,
|
OTLPGRPCExporterNodeBase,
|
||||||
|
|
|
||||||
|
|
@ -33,7 +33,7 @@ import {
|
||||||
mockHistogram,
|
mockHistogram,
|
||||||
mockObservableGauge, setUp, shutdown,
|
mockObservableGauge, setUp, shutdown,
|
||||||
} from './metricsHelper';
|
} from './metricsHelper';
|
||||||
import { AggregationTemporality, ResourceMetrics } from '@opentelemetry/sdk-metrics-base';
|
import { AggregationTemporality, ResourceMetrics } from '@opentelemetry/sdk-metrics';
|
||||||
import { IExportMetricsServiceRequest, IResourceMetrics } from '@opentelemetry/otlp-transformer';
|
import { IExportMetricsServiceRequest, IResourceMetrics } from '@opentelemetry/otlp-transformer';
|
||||||
|
|
||||||
const metricsServiceProtoPath =
|
const metricsServiceProtoPath =
|
||||||
|
|
|
||||||
|
|
@ -25,7 +25,7 @@ import {
|
||||||
MeterProvider,
|
MeterProvider,
|
||||||
MetricReader,
|
MetricReader,
|
||||||
View,
|
View,
|
||||||
} from '@opentelemetry/sdk-metrics-base';
|
} from '@opentelemetry/sdk-metrics';
|
||||||
import { IKeyValue, IMetric, IResource } from '@opentelemetry/otlp-transformer';
|
import { IKeyValue, IMetric, IResource } from '@opentelemetry/otlp-transformer';
|
||||||
|
|
||||||
class TestMetricReader extends MetricReader {
|
class TestMetricReader extends MetricReader {
|
||||||
|
|
|
||||||
|
|
@ -22,7 +22,7 @@
|
||||||
"path": "../opentelemetry-exporter-metrics-otlp-http"
|
"path": "../opentelemetry-exporter-metrics-otlp-http"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"path": "../opentelemetry-sdk-metrics-base"
|
"path": "../opentelemetry-sdk-metrics"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"path": "../otlp-grpc-exporter-base"
|
"path": "../otlp-grpc-exporter-base"
|
||||||
|
|
|
||||||
|
|
@ -23,7 +23,7 @@ To see sample code and documentation for the traces exporter, visit the [Collect
|
||||||
The OTLPMetricExporter in Web expects the endpoint to end in `/v1/metrics`.
|
The OTLPMetricExporter in Web expects the endpoint to end in `/v1/metrics`.
|
||||||
|
|
||||||
```js
|
```js
|
||||||
import { MeterProvider, PeriodicExportingMetricReader } from '@opentelemetry/sdk-metrics-base';
|
import { MeterProvider, PeriodicExportingMetricReader } from '@opentelemetry/sdk-metrics';
|
||||||
import { OTLPMetricExporter } from '@opentelemetry/exporter-metrics-otlp-http';
|
import { OTLPMetricExporter } from '@opentelemetry/exporter-metrics-otlp-http';
|
||||||
const collectorOptions = {
|
const collectorOptions = {
|
||||||
url: '<opentelemetry-collector-url>', // url is optional and can be omitted - default is http://localhost:4318/v1/metrics
|
url: '<opentelemetry-collector-url>', // url is optional and can be omitted - default is http://localhost:4318/v1/metrics
|
||||||
|
|
@ -47,7 +47,7 @@ counter.add(10, { 'key': 'value' });
|
||||||
## Metrics in Node
|
## Metrics in Node
|
||||||
|
|
||||||
```js
|
```js
|
||||||
const { MeterProvider, PeriodicExportingMetricReader } = require('@opentelemetry/sdk-metrics-base');
|
const { MeterProvider, PeriodicExportingMetricReader } = require('@opentelemetry/sdk-metrics');
|
||||||
const { OTLPMetricExporter } = require('@opentelemetry/exporter-metrics-otlp-http');
|
const { OTLPMetricExporter } = require('@opentelemetry/exporter-metrics-otlp-http');
|
||||||
const collectorOptions = {
|
const collectorOptions = {
|
||||||
url: '<opentelemetry-collector-url>', // url is optional and can be omitted - default is http://localhost:4318/v1/metrics
|
url: '<opentelemetry-collector-url>', // url is optional and can be omitted - default is http://localhost:4318/v1/metrics
|
||||||
|
|
|
||||||
|
|
@ -99,7 +99,7 @@
|
||||||
"@opentelemetry/otlp-exporter-base": "0.31.0",
|
"@opentelemetry/otlp-exporter-base": "0.31.0",
|
||||||
"@opentelemetry/otlp-transformer": "0.31.0",
|
"@opentelemetry/otlp-transformer": "0.31.0",
|
||||||
"@opentelemetry/resources": "1.5.0",
|
"@opentelemetry/resources": "1.5.0",
|
||||||
"@opentelemetry/sdk-metrics-base": "0.31.0"
|
"@opentelemetry/sdk-metrics": "0.31.0"
|
||||||
},
|
},
|
||||||
"homepage": "https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/opentelemetry-exporter-metrics-otlp-http"
|
"homepage": "https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/opentelemetry-exporter-metrics-otlp-http"
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -21,7 +21,7 @@ import {
|
||||||
InstrumentType,
|
InstrumentType,
|
||||||
PushMetricExporter,
|
PushMetricExporter,
|
||||||
ResourceMetrics
|
ResourceMetrics
|
||||||
} from '@opentelemetry/sdk-metrics-base';
|
} from '@opentelemetry/sdk-metrics';
|
||||||
import { defaultOptions, OTLPMetricExporterOptions } from './OTLPMetricExporterOptions';
|
import { defaultOptions, OTLPMetricExporterOptions } from './OTLPMetricExporterOptions';
|
||||||
import { OTLPExporterBase } from '@opentelemetry/otlp-exporter-base';
|
import { OTLPExporterBase } from '@opentelemetry/otlp-exporter-base';
|
||||||
import { IExportMetricsServiceRequest } from '@opentelemetry/otlp-transformer';
|
import { IExportMetricsServiceRequest } from '@opentelemetry/otlp-transformer';
|
||||||
|
|
|
||||||
|
|
@ -14,7 +14,7 @@
|
||||||
* limitations under the License.
|
* limitations under the License.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import { AggregationTemporality } from '@opentelemetry/sdk-metrics-base';
|
import { AggregationTemporality } from '@opentelemetry/sdk-metrics';
|
||||||
import { OTLPExporterConfigBase } from '@opentelemetry/otlp-exporter-base';
|
import { OTLPExporterConfigBase } from '@opentelemetry/otlp-exporter-base';
|
||||||
|
|
||||||
export interface OTLPMetricExporterOptions extends OTLPExporterConfigBase {
|
export interface OTLPMetricExporterOptions extends OTLPExporterConfigBase {
|
||||||
|
|
|
||||||
|
|
@ -14,7 +14,7 @@
|
||||||
* limitations under the License.
|
* limitations under the License.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import { ResourceMetrics } from '@opentelemetry/sdk-metrics-base';
|
import { ResourceMetrics } from '@opentelemetry/sdk-metrics';
|
||||||
import { baggageUtils, getEnv } from '@opentelemetry/core';
|
import { baggageUtils, getEnv } from '@opentelemetry/core';
|
||||||
import { defaultOptions, OTLPMetricExporterOptions } from '../../OTLPMetricExporterOptions';
|
import { defaultOptions, OTLPMetricExporterOptions } from '../../OTLPMetricExporterOptions';
|
||||||
import { OTLPMetricExporterBase } from '../../OTLPMetricExporterBase';
|
import { OTLPMetricExporterBase } from '../../OTLPMetricExporterBase';
|
||||||
|
|
|
||||||
|
|
@ -14,7 +14,7 @@
|
||||||
* limitations under the License.
|
* limitations under the License.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import { ResourceMetrics } from '@opentelemetry/sdk-metrics-base';
|
import { ResourceMetrics } from '@opentelemetry/sdk-metrics';
|
||||||
import { getEnv, baggageUtils} from '@opentelemetry/core';
|
import { getEnv, baggageUtils} from '@opentelemetry/core';
|
||||||
import { defaultOptions, OTLPMetricExporterOptions } from '../../OTLPMetricExporterOptions';
|
import { defaultOptions, OTLPMetricExporterOptions } from '../../OTLPMetricExporterOptions';
|
||||||
import { OTLPMetricExporterBase } from '../../OTLPMetricExporterBase';
|
import { OTLPMetricExporterBase } from '../../OTLPMetricExporterBase';
|
||||||
|
|
|
||||||
|
|
@ -17,7 +17,7 @@
|
||||||
import { diag, DiagLogger, DiagLogLevel } from '@opentelemetry/api';
|
import { diag, DiagLogger, DiagLogLevel } from '@opentelemetry/api';
|
||||||
import { Counter, Histogram, } from '@opentelemetry/api-metrics';
|
import { Counter, Histogram, } from '@opentelemetry/api-metrics';
|
||||||
import { ExportResultCode, hrTimeToNanoseconds } from '@opentelemetry/core';
|
import { ExportResultCode, hrTimeToNanoseconds } from '@opentelemetry/core';
|
||||||
import { AggregationTemporality, ResourceMetrics, } from '@opentelemetry/sdk-metrics-base';
|
import { AggregationTemporality, ResourceMetrics, } from '@opentelemetry/sdk-metrics';
|
||||||
import * as assert from 'assert';
|
import * as assert from 'assert';
|
||||||
import * as sinon from 'sinon';
|
import * as sinon from 'sinon';
|
||||||
import { OTLPMetricExporter } from '../../src/platform/browser';
|
import { OTLPMetricExporter } from '../../src/platform/browser';
|
||||||
|
|
|
||||||
|
|
@ -17,7 +17,7 @@
|
||||||
import { ExportResultCode } from '@opentelemetry/core';
|
import { ExportResultCode } from '@opentelemetry/core';
|
||||||
import {
|
import {
|
||||||
ResourceMetrics,
|
ResourceMetrics,
|
||||||
} from '@opentelemetry/sdk-metrics-base';
|
} from '@opentelemetry/sdk-metrics';
|
||||||
import * as assert from 'assert';
|
import * as assert from 'assert';
|
||||||
import * as sinon from 'sinon';
|
import * as sinon from 'sinon';
|
||||||
import { collect, mockCounter, mockObservableGauge, setUp, shutdown } from '../metricsHelper';
|
import { collect, mockCounter, mockObservableGauge, setUp, shutdown } from '../metricsHelper';
|
||||||
|
|
|
||||||
|
|
@ -32,7 +32,7 @@ import {
|
||||||
MeterProvider,
|
MeterProvider,
|
||||||
MetricReader,
|
MetricReader,
|
||||||
View
|
View
|
||||||
} from '@opentelemetry/sdk-metrics-base';
|
} from '@opentelemetry/sdk-metrics';
|
||||||
import {
|
import {
|
||||||
IExportMetricsServiceRequest,
|
IExportMetricsServiceRequest,
|
||||||
IKeyValue,
|
IKeyValue,
|
||||||
|
|
|
||||||
|
|
@ -41,7 +41,7 @@ import {
|
||||||
HISTOGRAM_AGGREGATION_VIEW,
|
HISTOGRAM_AGGREGATION_VIEW,
|
||||||
} from '../metricsHelper';
|
} from '../metricsHelper';
|
||||||
import { MockedResponse } from './nodeHelpers';
|
import { MockedResponse } from './nodeHelpers';
|
||||||
import { AggregationTemporality, ResourceMetrics } from '@opentelemetry/sdk-metrics-base';
|
import { AggregationTemporality, ResourceMetrics } from '@opentelemetry/sdk-metrics';
|
||||||
import { Stream, PassThrough } from 'stream';
|
import { Stream, PassThrough } from 'stream';
|
||||||
import { OTLPExporterError, OTLPExporterNodeConfigBase } from '@opentelemetry/otlp-exporter-base';
|
import { OTLPExporterError, OTLPExporterNodeConfigBase } from '@opentelemetry/otlp-exporter-base';
|
||||||
import { IExportMetricsServiceRequest } from '@opentelemetry/otlp-transformer';
|
import { IExportMetricsServiceRequest } from '@opentelemetry/otlp-transformer';
|
||||||
|
|
|
||||||
|
|
@ -19,7 +19,7 @@
|
||||||
"path": "../opentelemetry-api-metrics"
|
"path": "../opentelemetry-api-metrics"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"path": "../opentelemetry-sdk-metrics-base"
|
"path": "../opentelemetry-sdk-metrics"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"path": "../otlp-exporter-base"
|
"path": "../otlp-exporter-base"
|
||||||
|
|
|
||||||
|
|
@ -21,7 +21,7 @@ To see sample code and documentation for the traces exporter, visit the [Collect
|
||||||
## Metrics in Node - PROTO over http
|
## Metrics in Node - PROTO over http
|
||||||
|
|
||||||
```js
|
```js
|
||||||
const { MeterProvider, PeriodicExportingMetricReader } = require('@opentelemetry/sdk-metrics-base');
|
const { MeterProvider, PeriodicExportingMetricReader } = require('@opentelemetry/sdk-metrics');
|
||||||
const { OTLPMetricExporter } = require('@opentelemetry/exporter-metrics-otlp-proto');
|
const { OTLPMetricExporter } = require('@opentelemetry/exporter-metrics-otlp-proto');
|
||||||
const collectorOptions = {
|
const collectorOptions = {
|
||||||
url: '<opentelemetry-collector-url>', // url is optional and can be omitted - default is http://localhost:4318/v1/metrics
|
url: '<opentelemetry-collector-url>', // url is optional and can be omitted - default is http://localhost:4318/v1/metrics
|
||||||
|
|
|
||||||
|
|
@ -74,7 +74,7 @@
|
||||||
"@opentelemetry/otlp-proto-exporter-base": "0.31.0",
|
"@opentelemetry/otlp-proto-exporter-base": "0.31.0",
|
||||||
"@opentelemetry/otlp-transformer": "0.31.0",
|
"@opentelemetry/otlp-transformer": "0.31.0",
|
||||||
"@opentelemetry/resources": "1.5.0",
|
"@opentelemetry/resources": "1.5.0",
|
||||||
"@opentelemetry/sdk-metrics-base": "0.31.0",
|
"@opentelemetry/sdk-metrics": "0.31.0",
|
||||||
"protobufjs": "^6.9.0"
|
"protobufjs": "^6.9.0"
|
||||||
},
|
},
|
||||||
"homepage": "https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/opentelemetry-exporter-metrics-otlp-proto"
|
"homepage": "https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/opentelemetry-exporter-metrics-otlp-proto"
|
||||||
|
|
|
||||||
|
|
@ -19,8 +19,8 @@ import {
|
||||||
OTLPMetricExporterOptions
|
OTLPMetricExporterOptions
|
||||||
} from '@opentelemetry/exporter-metrics-otlp-http';
|
} from '@opentelemetry/exporter-metrics-otlp-http';
|
||||||
import { ServiceClientType, OTLPProtoExporterNodeBase } from '@opentelemetry/otlp-proto-exporter-base';
|
import { ServiceClientType, OTLPProtoExporterNodeBase } from '@opentelemetry/otlp-proto-exporter-base';
|
||||||
import { getEnv, baggageUtils} from '@opentelemetry/core';
|
import { getEnv, baggageUtils } from '@opentelemetry/core';
|
||||||
import { ResourceMetrics} from '@opentelemetry/sdk-metrics-base';
|
import { ResourceMetrics } from '@opentelemetry/sdk-metrics';
|
||||||
import { OTLPMetricExporterBase } from '@opentelemetry/exporter-metrics-otlp-http';
|
import { OTLPMetricExporterBase } from '@opentelemetry/exporter-metrics-otlp-http';
|
||||||
import {
|
import {
|
||||||
OTLPExporterNodeConfigBase,
|
OTLPExporterNodeConfigBase,
|
||||||
|
|
|
||||||
|
|
@ -32,7 +32,7 @@ import {
|
||||||
mockObservableGauge,
|
mockObservableGauge,
|
||||||
mockHistogram, collect, setUp, shutdown,
|
mockHistogram, collect, setUp, shutdown,
|
||||||
} from './metricsHelper';
|
} from './metricsHelper';
|
||||||
import { AggregationTemporality, ResourceMetrics } from '@opentelemetry/sdk-metrics-base';
|
import { AggregationTemporality, ResourceMetrics } from '@opentelemetry/sdk-metrics';
|
||||||
import { OTLPMetricExporterOptions } from '@opentelemetry/exporter-metrics-otlp-http';
|
import { OTLPMetricExporterOptions } from '@opentelemetry/exporter-metrics-otlp-http';
|
||||||
import { Stream, PassThrough } from 'stream';
|
import { Stream, PassThrough } from 'stream';
|
||||||
import { OTLPExporterNodeConfigBase } from '@opentelemetry/otlp-exporter-base';
|
import { OTLPExporterNodeConfigBase } from '@opentelemetry/otlp-exporter-base';
|
||||||
|
|
|
||||||
|
|
@ -29,7 +29,7 @@ import {
|
||||||
MeterProvider,
|
MeterProvider,
|
||||||
MetricReader,
|
MetricReader,
|
||||||
View
|
View
|
||||||
} from '@opentelemetry/sdk-metrics-base';
|
} from '@opentelemetry/sdk-metrics';
|
||||||
import { IExportMetricsServiceRequest, IKeyValue, IMetric } from '@opentelemetry/otlp-transformer';
|
import { IExportMetricsServiceRequest, IKeyValue, IMetric } from '@opentelemetry/otlp-transformer';
|
||||||
import { Stream } from 'stream';
|
import { Stream } from 'stream';
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -22,7 +22,7 @@
|
||||||
"path": "../opentelemetry-exporter-metrics-otlp-http"
|
"path": "../opentelemetry-exporter-metrics-otlp-http"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"path": "../opentelemetry-sdk-metrics-base"
|
"path": "../opentelemetry-sdk-metrics"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"path": "../otlp-exporter-base"
|
"path": "../otlp-exporter-base"
|
||||||
|
|
|
||||||
|
|
@ -3,14 +3,14 @@
|
||||||
[![NPM Published Version][npm-img]][npm-url]
|
[![NPM Published Version][npm-img]][npm-url]
|
||||||
[![Apache License][license-image]][license-image]
|
[![Apache License][license-image]][license-image]
|
||||||
|
|
||||||
The OpenTelemetry Prometheus Metrics Exporter allows the user to send collected [OpenTelemetry Metrics](https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/opentelemetry-sdk-metrics-base) to Prometheus.
|
The OpenTelemetry Prometheus Metrics Exporter allows the user to send collected [OpenTelemetry Metrics](https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/opentelemetry-sdk-metrics) to Prometheus.
|
||||||
|
|
||||||
[Prometheus](https://prometheus.io/) is a monitoring system that collects metrics, by scraping exposed endpoints at regular intervals, evaluating rule expressions. It can also trigger alerts if certain conditions are met. For assistance setting up Prometheus, [Click here](https://opencensus.io/codelabs/prometheus/#0) for a guided codelab.
|
[Prometheus](https://prometheus.io/) is a monitoring system that collects metrics, by scraping exposed endpoints at regular intervals, evaluating rule expressions. It can also trigger alerts if certain conditions are met. For assistance setting up Prometheus, [Click here](https://opencensus.io/codelabs/prometheus/#0) for a guided codelab.
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm install --save @opentelemetry/sdk-metrics-base
|
npm install --save @opentelemetry/sdk-metrics
|
||||||
npm install --save @opentelemetry/exporter-prometheus
|
npm install --save @opentelemetry/exporter-prometheus
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
@ -20,7 +20,7 @@ Create & register the exporter on your application.
|
||||||
|
|
||||||
```js
|
```js
|
||||||
const { PrometheusExporter } = require('@opentelemetry/exporter-prometheus');
|
const { PrometheusExporter } = require('@opentelemetry/exporter-prometheus');
|
||||||
const { MeterProvider } = require('@opentelemetry/sdk-metrics-base');
|
const { MeterProvider } = require('@opentelemetry/sdk-metrics');
|
||||||
|
|
||||||
// Add your port and startServer to the Prometheus options
|
// Add your port and startServer to the Prometheus options
|
||||||
const options = {port: 9464, startServer: true};
|
const options = {port: 9464, startServer: true};
|
||||||
|
|
|
||||||
|
|
@ -61,7 +61,7 @@
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@opentelemetry/api-metrics": "0.31.0",
|
"@opentelemetry/api-metrics": "0.31.0",
|
||||||
"@opentelemetry/core": "1.5.0",
|
"@opentelemetry/core": "1.5.0",
|
||||||
"@opentelemetry/sdk-metrics-base": "0.31.0"
|
"@opentelemetry/sdk-metrics": "0.31.0"
|
||||||
},
|
},
|
||||||
"homepage": "https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/opentelemetry-exporter-prometheus"
|
"homepage": "https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/opentelemetry-exporter-prometheus"
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -18,7 +18,7 @@ import { diag } from '@opentelemetry/api';
|
||||||
import {
|
import {
|
||||||
globalErrorHandler,
|
globalErrorHandler,
|
||||||
} from '@opentelemetry/core';
|
} from '@opentelemetry/core';
|
||||||
import { AggregationTemporality, MetricReader } from '@opentelemetry/sdk-metrics-base';
|
import { AggregationTemporality, MetricReader } from '@opentelemetry/sdk-metrics';
|
||||||
import { createServer, IncomingMessage, Server, ServerResponse } from 'http';
|
import { createServer, IncomingMessage, Server, ServerResponse } from 'http';
|
||||||
import { ExporterConfig } from './export/types';
|
import { ExporterConfig } from './export/types';
|
||||||
import { PrometheusSerializer } from './PrometheusSerializer';
|
import { PrometheusSerializer } from './PrometheusSerializer';
|
||||||
|
|
|
||||||
|
|
@ -23,7 +23,7 @@ import {
|
||||||
MetricData,
|
MetricData,
|
||||||
DataPoint,
|
DataPoint,
|
||||||
Histogram,
|
Histogram,
|
||||||
} from '@opentelemetry/sdk-metrics-base';
|
} from '@opentelemetry/sdk-metrics';
|
||||||
import type {
|
import type {
|
||||||
MetricAttributes,
|
MetricAttributes,
|
||||||
MetricAttributeValue
|
MetricAttributeValue
|
||||||
|
|
|
||||||
|
|
@ -17,7 +17,7 @@
|
||||||
import { Meter, ObservableResult } from '@opentelemetry/api-metrics';
|
import { Meter, ObservableResult } from '@opentelemetry/api-metrics';
|
||||||
import {
|
import {
|
||||||
MeterProvider,
|
MeterProvider,
|
||||||
} from '@opentelemetry/sdk-metrics-base';
|
} from '@opentelemetry/sdk-metrics';
|
||||||
import * as assert from 'assert';
|
import * as assert from 'assert';
|
||||||
import * as sinon from 'sinon';
|
import * as sinon from 'sinon';
|
||||||
import * as http from 'http';
|
import * as http from 'http';
|
||||||
|
|
|
||||||
|
|
@ -27,7 +27,7 @@ import {
|
||||||
MetricReader,
|
MetricReader,
|
||||||
SumAggregation,
|
SumAggregation,
|
||||||
View,
|
View,
|
||||||
} from '@opentelemetry/sdk-metrics-base';
|
} from '@opentelemetry/sdk-metrics';
|
||||||
import * as sinon from 'sinon';
|
import * as sinon from 'sinon';
|
||||||
import { PrometheusSerializer } from '../src';
|
import { PrometheusSerializer } from '../src';
|
||||||
import { mockedHrTimeMs, mockHrTime } from './util';
|
import { mockedHrTimeMs, mockHrTime } from './util';
|
||||||
|
|
|
||||||
|
|
@ -16,7 +16,7 @@
|
||||||
"path": "../opentelemetry-api-metrics"
|
"path": "../opentelemetry-api-metrics"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"path": "../opentelemetry-sdk-metrics-base"
|
"path": "../opentelemetry-sdk-metrics"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -13,7 +13,7 @@ It does **not** provide automated instrumentation of known libraries or host env
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm install --save @opentelemetry/api-metrics
|
npm install --save @opentelemetry/api-metrics
|
||||||
npm install --save @opentelemetry/sdk-metrics-base
|
npm install --save @opentelemetry/sdk-metrics
|
||||||
```
|
```
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
@ -22,7 +22,7 @@ The basic setup of the SDK can be seen as followings:
|
||||||
|
|
||||||
```js
|
```js
|
||||||
const opentelemetry = require('@opentelemetry/api-metrics');
|
const opentelemetry = require('@opentelemetry/api-metrics');
|
||||||
const { MeterProvider } = require('@opentelemetry/sdk-metrics-base');
|
const { MeterProvider } = require('@opentelemetry/sdk-metrics');
|
||||||
|
|
||||||
// To create an instrument, you first need to initialize the Meter provider.
|
// To create an instrument, you first need to initialize the Meter provider.
|
||||||
// NOTE: The default OpenTelemetry meter provider does not record any metric instruments.
|
// NOTE: The default OpenTelemetry meter provider does not record any metric instruments.
|
||||||
|
|
@ -88,5 +88,5 @@ Apache 2.0 - See [LICENSE][license-url] for more information.
|
||||||
[discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions
|
[discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions
|
||||||
[license-url]: https://github.com/open-telemetry/opentelemetry-js/blob/main/LICENSE
|
[license-url]: https://github.com/open-telemetry/opentelemetry-js/blob/main/LICENSE
|
||||||
[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat
|
[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat
|
||||||
[npm-url]: https://www.npmjs.com/package/@opentelemetry/sdk-metrics-base
|
[npm-url]: https://www.npmjs.com/package/@opentelemetry/sdk-metrics
|
||||||
[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fmetrics.svg
|
[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fmetrics.svg
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
{
|
{
|
||||||
"name": "@opentelemetry/sdk-metrics-base",
|
"name": "@opentelemetry/sdk-metrics",
|
||||||
"version": "0.31.0",
|
"version": "0.31.0",
|
||||||
"description": "Work in progress OpenTelemetry metrics SDK",
|
"description": "Work in progress OpenTelemetry metrics SDK",
|
||||||
"main": "build/src/index.js",
|
"main": "build/src/index.js",
|
||||||
|
|
@ -82,5 +82,5 @@
|
||||||
"@opentelemetry/resources": "1.5.0",
|
"@opentelemetry/resources": "1.5.0",
|
||||||
"lodash.merge": "4.6.2"
|
"lodash.merge": "4.6.2"
|
||||||
},
|
},
|
||||||
"homepage": "https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/opentelemetry-sdk-metrics-base"
|
"homepage": "https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/opentelemetry-sdk-metrics"
|
||||||
}
|
}
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue