@opentelemetry/exporter-metrics-otlp-grpc 0.33.0 → 0.35.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -17,22 +17,25 @@ npm install --save @opentelemetry/exporter-metrics-otlp-grpc
|
|
|
17
17
|
## Service Name
|
|
18
18
|
|
|
19
19
|
The OpenTelemetry Collector Exporter does not have a service name configuration.
|
|
20
|
-
In order to set the service name, use the `service.name` resource attribute as prescribed in
|
|
21
|
-
|
|
20
|
+
In order to set the service name, use the `service.name` resource attribute as prescribed in
|
|
21
|
+
the [OpenTelemetry Resource Semantic Conventions][semconv-resource-service-name].
|
|
22
|
+
To see sample code and documentation for the traces exporter, as well as instructions for using TLS, visit
|
|
23
|
+
the [Collector Trace Exporter for web and node][trace-exporter-url].
|
|
22
24
|
|
|
23
25
|
## Metrics in Node - GRPC
|
|
24
26
|
|
|
25
|
-
The OTLPMetricsExporter in Node expects the URL to only be the hostname. It will not work with `/v1/metrics`. All
|
|
27
|
+
The OTLPMetricsExporter in Node expects the URL to only be the hostname. It will not work with `/v1/metrics`. All
|
|
28
|
+
options that work with trace also work with metrics.
|
|
26
29
|
|
|
27
30
|
```js
|
|
28
31
|
const { MeterProvider, PeriodicExportingMetricReader } = require('@opentelemetry/sdk-metrics');
|
|
29
|
-
const { OTLPMetricExporter } =
|
|
32
|
+
const { OTLPMetricExporter } = require('@opentelemetry/exporter-metrics-otlp-grpc');
|
|
30
33
|
const collectorOptions = {
|
|
31
34
|
// url is optional and can be omitted - default is http://localhost:4317
|
|
32
35
|
url: 'http://<collector-hostname>:<port>',
|
|
33
36
|
};
|
|
34
37
|
|
|
35
|
-
const
|
|
38
|
+
const metricExporter = new OTLPMetricExporter(collectorOptions);
|
|
36
39
|
const meterProvider = new MeterProvider({});
|
|
37
40
|
|
|
38
41
|
meterProvider.addMetricReader(new PeriodicExportingMetricReader({
|
|
@@ -52,20 +55,24 @@ counter.add(10, { 'key': 'value' });
|
|
|
52
55
|
|
|
53
56
|
## Environment Variable Configuration
|
|
54
57
|
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
58
|
+
In addition to settings passed to the constructor, the exporter also supports configuration via environment variables:
|
|
59
|
+
|
|
60
|
+
| Environment variable | Description |
|
|
61
|
+
|----------------------|-------------|
|
|
62
|
+
| OTEL_EXPORTER_OTLP_ENDPOINT | The endpoint to send metrics to. This will also be used for the traces exporter if `OTEL_EXPORTER_OTLP_TRACES_ENDPOINT` is not configured. By default `localhost:4317` will be used. |
|
|
63
|
+
| OTEL_EXPORTER_OTLP_METRICS_ENDPOINT | The endpoint to send metrics to. By default `localhost:4317` will be used. |
|
|
64
|
+
| OTEL_EXPORTER_OTLP_COMPRESSION | The compression type to use on OTLP trace, metric, and log requests. Options include gzip. By default no compression will be used. |
|
|
65
|
+
| OTEL_EXPORTER_OTLP_METRICS_INSECURE | Whether to enable client transport security for the exporter's gRPC connection for metric requests. This option only applies to OTLP/gRPC when an endpoint is provided without the http or https scheme. Options include true or false. By default insecure is false which creates a secure connection. |
|
|
66
|
+
| OTEL_EXPORTER_OTLP_INSECURE | Whether to enable client transport security for the exporter's gRPC connection for trace, metric and log requests. This option only applies to OTLP/gRPC when an endpoint is provided without the http or https scheme. Options include true or false. By default insecure is false which creates a secure connection. |
|
|
67
|
+
| OTEL_EXPORTER_OTLP_METRICS_CERTIFICATE | The path to the file containing trusted root certificate to use when verifying an OTLP metric server's TLS credentials. By default the host platform's trusted root certificate is used.|
|
|
68
|
+
| OTEL_EXPORTER_OTLP_CERTIFICATE | The path to the file containing trusted root certificate to use when verifying an OTLP trace, metric, or log server's TLS credentials. By default the host platform's trusted root certificate is used. |
|
|
69
|
+
| OTEL_EXPORTER_OTLP_METRICS_CLIENT_KEY | The path to the file containing private client key to use when verifying an OTLP metric client's TLS credentials. Must provide a client certificate/chain when providing a private client key. By default no client key file is used. |
|
|
70
|
+
| OTEL_EXPORTER_OTLP_CLIENT_KEY | The path to the file containing private client key to use when verifying an OTLP trace, metric or log client's TLS credentials. Must provide a client certificate/chain when providing a private client key. By default no client key file is used. |
|
|
71
|
+
| OTEL_EXPORTER_OTLP_METRICS_CLIENT_CERTIFICATE | The path to the file containing trusted client certificate/chain for clients private key to use when verifying an OTLP metric server's TLS credentials. Must provide a private client key when providing a certificate/chain. By default no chain file is used. |
|
|
72
|
+
| OTEL_EXPORTER_OTLP_CLIENT_CERTIFICATE | The path to the file containing trusted client certificate/chain for clients private key to use when verifying an OTLP trace, metric and log server's TLS credentials. Must provide a private client key when providing a certificate/chain. By default no chain file is used. |
|
|
73
|
+
| OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE | The exporters aggregation temporality preference. Valid values are `cumulative`, and `delta`. `cumulative` selects cumulative temporality for all instrument kinds. `delta` selects delta aggregation temporality for Counter, Asynchronous Counter and Histogram instrument kinds, and selects cumulative aggregation for UpDownCounter and Asynchronous UpDownCounter instrument kinds. By default `cumulative` is used. |
|
|
74
|
+
|
|
75
|
+
> Settings configured programmatically take precedence over environment variables. Per-signal environment variables take precedence over non-per-signal environment variables.
|
|
69
76
|
|
|
70
77
|
## Running opentelemetry-collector locally to see the metrics
|
|
71
78
|
|
|
@@ -22,7 +22,7 @@ const core_1 = require("@opentelemetry/core");
|
|
|
22
22
|
const grpc_js_1 = require("@grpc/grpc-js");
|
|
23
23
|
const otlp_transformer_1 = require("@opentelemetry/otlp-transformer");
|
|
24
24
|
class OTLPMetricExporterProxy extends otlp_grpc_exporter_base_1.OTLPGRPCExporterNodeBase {
|
|
25
|
-
constructor(config
|
|
25
|
+
constructor(config) {
|
|
26
26
|
super(config);
|
|
27
27
|
const headers = core_1.baggageUtils.parseKeyPairsIntoRecord((0, core_1.getEnv)().OTEL_EXPORTER_OTLP_METRICS_HEADERS);
|
|
28
28
|
this.metadata || (this.metadata = new grpc_js_1.Metadata());
|
|
@@ -46,16 +46,16 @@ class OTLPMetricExporterProxy extends otlp_grpc_exporter_base_1.OTLPGRPCExporter
|
|
|
46
46
|
if (typeof config.url === 'string') {
|
|
47
47
|
return config.url;
|
|
48
48
|
}
|
|
49
|
-
return (0, core_1.getEnv)().OTEL_EXPORTER_OTLP_METRICS_ENDPOINT ||
|
|
49
|
+
return ((0, core_1.getEnv)().OTEL_EXPORTER_OTLP_METRICS_ENDPOINT ||
|
|
50
50
|
(0, core_1.getEnv)().OTEL_EXPORTER_OTLP_ENDPOINT ||
|
|
51
|
-
otlp_grpc_exporter_base_1.DEFAULT_COLLECTOR_URL;
|
|
51
|
+
otlp_grpc_exporter_base_1.DEFAULT_COLLECTOR_URL);
|
|
52
52
|
}
|
|
53
53
|
}
|
|
54
54
|
/**
|
|
55
55
|
* OTLP-gRPC metric exporter
|
|
56
56
|
*/
|
|
57
57
|
class OTLPMetricExporter extends exporter_metrics_otlp_http_1.OTLPMetricExporterBase {
|
|
58
|
-
constructor(config
|
|
58
|
+
constructor(config) {
|
|
59
59
|
super(new OTLPMetricExporterProxy(config), config);
|
|
60
60
|
}
|
|
61
61
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"OTLPMetricExporter.js","sourceRoot":"","sources":["../../src/OTLPMetricExporter.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH,
|
|
1
|
+
{"version":3,"file":"OTLPMetricExporter.js","sourceRoot":"","sources":["../../src/OTLPMetricExporter.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH,0FAGmD;AAEnD,oFAMgD;AAChD,8CAA2D;AAC3D,2CAAyC;AACzC,sEAGyC;AAEzC,MAAM,uBAAwB,SAAQ,kDAGrC;IACC,YAAY,MAA+D;QACzE,KAAK,CAAC,MAAM,CAAC,CAAC;QACd,MAAM,OAAO,GAAG,mBAAY,CAAC,uBAAuB,CAClD,IAAA,aAAM,GAAE,CAAC,kCAAkC,CAC5C,CAAC;QACF,IAAI,CAAC,QAAQ,KAAb,IAAI,CAAC,QAAQ,GAAK,IAAI,kBAAQ,EAAE,EAAC;QACjC,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;YAC5C,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;SACzB;IACH,CAAC;IAED,mBAAmB;QACjB,OAAO,gEAAgE,CAAC;IAC1E,CAAC;IAED,oBAAoB;QAClB,OAAO,2CAAiB,CAAC,OAAO,CAAC;IACnC,CAAC;IAED,aAAa,CAAC,MAAkC;QAC9C,OAAO,IAAA,iDAAuB,EAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC;IAChE,CAAC;IAED,OAAO,CAAC,OAA0B;QAChC,OAAO,IAAA,oDAAiC,EAAC,OAAO,CAAC,CAAC;IACpD,CAAC;IAED,gBAAgB,CAAC,MAAkC;QACjD,IAAI,OAAO,MAAM,CAAC,GAAG,KAAK,QAAQ,EAAE;YAClC,OAAO,MAAM,CAAC,GAAG,CAAC;SACnB;QAED,OAAO,CACL,IAAA,aAAM,GAAE,CAAC,mCAAmC;YAC5C,IAAA,aAAM,GAAE,CAAC,2BAA2B;YACpC,+CAAqB,CACtB,CAAC;IACJ,CAAC;CACF;AAED;;GAEG;AACH,MAAa,kBAAmB,SAAQ,mDAA+C;IACrF,YAAY,MAA+D;QACzE,KAAK,CAAC,IAAI,uBAAuB,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC;IACrD,CAAC;CACF;AAJD,gDAIC","sourcesContent":["/*\n * Copyright The OpenTelemetry Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n OTLPMetricExporterBase,\n OTLPMetricExporterOptions,\n} from '@opentelemetry/exporter-metrics-otlp-http';\nimport { ResourceMetrics } from '@opentelemetry/sdk-metrics';\nimport {\n OTLPGRPCExporterConfigNode,\n OTLPGRPCExporterNodeBase,\n ServiceClientType,\n validateAndNormalizeUrl,\n DEFAULT_COLLECTOR_URL,\n} from '@opentelemetry/otlp-grpc-exporter-base';\nimport { baggageUtils, getEnv } from '@opentelemetry/core';\nimport { Metadata } from '@grpc/grpc-js';\nimport {\n createExportMetricsServiceRequest,\n IExportMetricsServiceRequest,\n} from '@opentelemetry/otlp-transformer';\n\nclass OTLPMetricExporterProxy extends OTLPGRPCExporterNodeBase<\n ResourceMetrics,\n IExportMetricsServiceRequest\n> {\n constructor(config?: OTLPGRPCExporterConfigNode & OTLPMetricExporterOptions) {\n super(config);\n const headers = baggageUtils.parseKeyPairsIntoRecord(\n getEnv().OTEL_EXPORTER_OTLP_METRICS_HEADERS\n );\n this.metadata ||= new Metadata();\n for (const [k, v] of Object.entries(headers)) {\n this.metadata.set(k, v);\n }\n }\n\n getServiceProtoPath(): string {\n return 'opentelemetry/proto/collector/metrics/v1/metrics_service.proto';\n }\n\n getServiceClientType(): ServiceClientType {\n return ServiceClientType.METRICS;\n }\n\n getDefaultUrl(config: OTLPGRPCExporterConfigNode): string {\n return validateAndNormalizeUrl(this.getUrlFromConfig(config));\n }\n\n convert(metrics: ResourceMetrics[]): IExportMetricsServiceRequest {\n return createExportMetricsServiceRequest(metrics);\n }\n\n getUrlFromConfig(config: OTLPGRPCExporterConfigNode): string {\n if (typeof config.url === 'string') {\n return config.url;\n }\n\n return (\n getEnv().OTEL_EXPORTER_OTLP_METRICS_ENDPOINT ||\n getEnv().OTEL_EXPORTER_OTLP_ENDPOINT ||\n DEFAULT_COLLECTOR_URL\n );\n }\n}\n\n/**\n * OTLP-gRPC metric exporter\n */\nexport class OTLPMetricExporter extends OTLPMetricExporterBase<OTLPMetricExporterProxy> {\n constructor(config?: OTLPGRPCExporterConfigNode & OTLPMetricExporterOptions) {\n super(new OTLPMetricExporterProxy(config), config);\n }\n}\n"]}
|
package/build/src/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const VERSION = "0.
|
|
1
|
+
export declare const VERSION = "0.35.0";
|
|
2
2
|
//# sourceMappingURL=version.d.ts.map
|
package/build/src/version.js
CHANGED
package/build/src/version.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH,4DAA4D;AAC/C,QAAA,OAAO,GAAG,QAAQ,CAAC","sourcesContent":["/*\n * Copyright The OpenTelemetry Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n// this is autogenerated file, see scripts/version-update.js\nexport const VERSION = '0.
|
|
1
|
+
{"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH,4DAA4D;AAC/C,QAAA,OAAO,GAAG,QAAQ,CAAC","sourcesContent":["/*\n * Copyright The OpenTelemetry Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n// this is autogenerated file, see scripts/version-update.js\nexport const VERSION = '0.35.0';\n"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@opentelemetry/exporter-metrics-otlp-grpc",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.35.0",
|
|
4
4
|
"description": "OpenTelemetry Collector Metrics Exporter allows user to send collected metrics to the OpenTelemetry Collector",
|
|
5
5
|
"main": "build/src/index.js",
|
|
6
6
|
"types": "build/src/index.d.ts",
|
|
@@ -48,9 +48,9 @@
|
|
|
48
48
|
},
|
|
49
49
|
"devDependencies": {
|
|
50
50
|
"@babel/core": "7.16.0",
|
|
51
|
-
"@
|
|
52
|
-
"@opentelemetry/api
|
|
53
|
-
"@types/mocha": "
|
|
51
|
+
"@grpc/proto-loader": "^0.7.3",
|
|
52
|
+
"@opentelemetry/api": "^1.3.0",
|
|
53
|
+
"@types/mocha": "10.0.0",
|
|
54
54
|
"@types/node": "18.6.5",
|
|
55
55
|
"@types/sinon": "10.0.13",
|
|
56
56
|
"codecov": "3.8.3",
|
|
@@ -58,24 +58,24 @@
|
|
|
58
58
|
"mocha": "10.0.0",
|
|
59
59
|
"nyc": "15.1.0",
|
|
60
60
|
"rimraf": "3.0.2",
|
|
61
|
-
"sinon": "
|
|
61
|
+
"sinon": "15.0.0",
|
|
62
62
|
"ts-loader": "8.4.0",
|
|
63
63
|
"ts-mocha": "10.0.0",
|
|
64
64
|
"typescript": "4.4.4"
|
|
65
65
|
},
|
|
66
66
|
"peerDependencies": {
|
|
67
|
-
"@opentelemetry/api": "^1.
|
|
67
|
+
"@opentelemetry/api": "^1.3.0"
|
|
68
68
|
},
|
|
69
69
|
"dependencies": {
|
|
70
|
-
"@grpc/grpc-js": "^1.
|
|
71
|
-
"@
|
|
72
|
-
"@opentelemetry/
|
|
73
|
-
"@opentelemetry/
|
|
74
|
-
"@opentelemetry/otlp-
|
|
75
|
-
"@opentelemetry/
|
|
76
|
-
"@opentelemetry/
|
|
77
|
-
"@opentelemetry/sdk-metrics": "0.33.0"
|
|
70
|
+
"@grpc/grpc-js": "^1.7.1",
|
|
71
|
+
"@opentelemetry/core": "1.9.0",
|
|
72
|
+
"@opentelemetry/exporter-metrics-otlp-http": "0.35.0",
|
|
73
|
+
"@opentelemetry/otlp-grpc-exporter-base": "0.35.0",
|
|
74
|
+
"@opentelemetry/otlp-transformer": "0.35.0",
|
|
75
|
+
"@opentelemetry/resources": "1.9.0",
|
|
76
|
+
"@opentelemetry/sdk-metrics": "1.9.0"
|
|
78
77
|
},
|
|
79
78
|
"homepage": "https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/opentelemetry-exporter-metrics-otlp-grpc",
|
|
80
|
-
"
|
|
79
|
+
"sideEffects": false,
|
|
80
|
+
"gitHead": "08f597f3a3d71a4852b0afbba120af15ca038121"
|
|
81
81
|
}
|