docs(resources): align documentation with current state (open-telemet…

…ry#5486)
MSNev · Feb 19, 2025 · 0cdf9ee · 0cdf9ee
1 parent 1afa8ba
commit 0cdf9ee
Show file tree

Hide file tree

Showing 17 changed files with 34 additions and 34 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml
@@ -67,14 +67,14 @@ body:
         const opentelemetry = require('@opentelemetry/sdk-node');
         const { getNodeAutoInstrumentations } = require('@opentelemetry/auto-instrumentations-node');
         const { ConsoleSpanExporter } = require('@opentelemetry/sdk-trace-base');
-        const { Resource } = require('@opentelemetry/resources');
+        const { resourceFromAttributes } = require('@opentelemetry/resources');
         const { SEMRESATTRS_SERVICE_NAME } = require('@opentelemetry/semantic-conventions');
 
         // configure the SDK to export telemetry data to the console
         // enable all auto-instrumentations from the meta package
         const traceExporter = new ConsoleSpanExporter();
         const sdk = new opentelemetry.NodeSDK({
-          resource: new Resource({
+          resource: resourceFromAttributes({
             [SEMRESATTRS_SERVICE_NAME]: 'my-service',
           }),
           traceExporter,

diff --git a/examples/basic-tracer-node/index.js b/examples/basic-tracer-node/index.js
@@ -1,7 +1,7 @@
 'use strict';
 
 const opentelemetry = require('@opentelemetry/api');
-const { Resource } = require('@opentelemetry/resources');
+const { resourceFromAttributes } = require('@opentelemetry/resources');
 const { SEMRESATTRS_SERVICE_NAME } = require('@opentelemetry/semantic-conventions');
 const { BasicTracerProvider, ConsoleSpanExporter, SimpleSpanProcessor } = require('@opentelemetry/sdk-trace-base');
 const { JaegerExporter } = require('@opentelemetry/exporter-jaeger');
@@ -11,7 +11,7 @@ const exporter = new JaegerExporter({
   endpoint: 'http://localhost:14268/api/traces',
 });
 const provider = new BasicTracerProvider({
-  resource: new Resource({
+  resource: resourceFromAttributes({
     [SEMRESATTRS_SERVICE_NAME]: 'basic-service',
   }),
   spanProcessors: [

diff --git a/examples/esm-http-ts/index.ts b/examples/esm-http-ts/index.ts
@@ -6,7 +6,7 @@ import {
   ConsoleSpanExporter,
   SimpleSpanProcessor,
 } from '@opentelemetry/sdk-trace-base';
-import { Resource } from '@opentelemetry/resources';
+import { resourceFromAttributes } from '@opentelemetry/resources';
 import { SEMRESATTRS_SERVICE_NAME } from '@opentelemetry/semantic-conventions';
 import http from 'http';
 
@@ -15,7 +15,7 @@ const exporter = new ConsoleSpanExporter();
 const processor = new SimpleSpanProcessor(exporter);
 
 const tracerProvider = new NodeTracerProvider({
-  resource: new Resource({
+  resource: resourceFromAttributes({
     [SEMRESATTRS_SERVICE_NAME]: 'esm-http-ts-example',
   }),
   spanProcessors: [processor],

diff --git a/examples/grpc-js/tracer.js b/examples/grpc-js/tracer.js
@@ -3,7 +3,7 @@
 const opentelemetry = require('@opentelemetry/api');
 const { registerInstrumentations } = require('@opentelemetry/instrumentation');
 const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
-const { Resource } = require('@opentelemetry/resources');
+const { resourceFromAttributes } = require('@opentelemetry/resources');
 const { SEMRESATTRS_SERVICE_NAME } = require('@opentelemetry/semantic-conventions');
 const { SimpleSpanProcessor } = require('@opentelemetry/sdk-trace-base');
 const { JaegerExporter } = require('@opentelemetry/exporter-jaeger');
@@ -16,7 +16,7 @@ module.exports = (serviceName) => {
   const useZipkin = EXPORTER.toLowerCase().startsWith('z');
   const exporter = useZipkin ? new ZipkinExporter() : new JaegerExporter();
   const provider = new NodeTracerProvider({
-    resource: new Resource({
+    resource: resourceFromAttributes({
       [SEMRESATTRS_SERVICE_NAME]: serviceName,
     }),
     spanProcessors: [new SimpleSpanProcessor(exporter)]

diff --git a/examples/http/tracer.js b/examples/http/tracer.js
@@ -3,7 +3,7 @@
 const opentelemetry = require('@opentelemetry/api');
 const { registerInstrumentations } = require('@opentelemetry/instrumentation');
 const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
-const { Resource } = require('@opentelemetry/resources');
+const { resourceFromAttributes } = require('@opentelemetry/resources');
 const { SEMRESATTRS_SERVICE_NAME } = require('@opentelemetry/semantic-conventions');
 const { SimpleSpanProcessor } = require('@opentelemetry/sdk-trace-base');
 const { JaegerExporter } = require('@opentelemetry/exporter-jaeger');
@@ -16,12 +16,12 @@ module.exports = (serviceName) => {
   const useZipkin = EXPORTER.toLowerCase().startsWith('z');
   const exporter = useZipkin ? new ZipkinExporter() : new JaegerExporter();
   const provider = new NodeTracerProvider({
-    resource: new Resource({
+    resource: resourceFromAttributes({
       [SEMRESATTRS_SERVICE_NAME]: serviceName,
     }),
     spanProcessors: [new SimpleSpanProcessor(exporter)]
   });
-  
+
   // Initialize the OpenTelemetry APIs to use the NodeTracerProvider bindings
   provider.register();
 

diff --git a/examples/https/tracer.js b/examples/https/tracer.js
@@ -3,7 +3,7 @@
 const opentelemetry = require('@opentelemetry/api');
 const { registerInstrumentations } = require('@opentelemetry/instrumentation');
 const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
-const { Resource } = require('@opentelemetry/resources');
+const { resourceFromAttributes } = require('@opentelemetry/resources');
 const { SEMRESATTRS_SERVICE_NAME } = require('@opentelemetry/semantic-conventions');
 const { SimpleSpanProcessor } = require('@opentelemetry/sdk-trace-base');
 const { JaegerExporter } = require('@opentelemetry/exporter-jaeger');
@@ -17,7 +17,7 @@ module.exports = (serviceName) => {
   const useZipkin = EXPORTER.toLowerCase().startsWith('z');
   const exporter = useZipkin ? new ZipkinExporter() : new JaegerExporter();
   const provider = new NodeTracerProvider({
-    resource: new Resource({
+    resource: resourceFromAttributes({
       [SEMRESATTRS_SERVICE_NAME]: serviceName,
     }),
     spanProcessors: [new SimpleSpanProcessor(exporter)]

diff --git a/examples/opentelemetry-web/examples/fetch-proto/index.js b/examples/opentelemetry-web/examples/fetch-proto/index.js
@@ -6,11 +6,11 @@ const { ZoneContextManager } = require("@opentelemetry/context-zone");
 const { B3Propagator } = require("@opentelemetry/propagator-b3");
 const { registerInstrumentations } = require("@opentelemetry/instrumentation");
 const { OTLPTraceExporter: OTLPTraceExporterProto } = require("@opentelemetry/exporter-trace-otlp-proto");
-const { Resource } = require("@opentelemetry/resources");
+const { resourceFromAttributes } = require("@opentelemetry/resources");
 const { SEMRESATTRS_SERVICE_NAME } = require("@opentelemetry/semantic-conventions");
 
 const provider = new WebTracerProvider({
-  resource: new Resource({
+  resource: resourceFromAttributes({
     [SEMRESATTRS_SERVICE_NAME]: 'fetch-proto-web-service'
   }),
   // Note: For production consider using the "BatchSpanProcessor" to reduce the number of requests

diff --git a/examples/opentelemetry-web/examples/fetch/index.js b/examples/opentelemetry-web/examples/fetch/index.js
@@ -6,11 +6,11 @@ const { FetchInstrumentation } = require( '@opentelemetry/instrumentation-fetch'
 const { ZoneContextManager } = require( '@opentelemetry/context-zone');
 const { B3Propagator } = require( '@opentelemetry/propagator-b3');
 const { registerInstrumentations } = require( '@opentelemetry/instrumentation');
-const { Resource } = require('@opentelemetry/resources');
+const { resourceFromAttributes } = require('@opentelemetry/resources');
 const { SEMRESATTRS_SERVICE_NAME } = require('@opentelemetry/semantic-conventions');
 
 const provider = new WebTracerProvider({
-  resource: new Resource({
+  resource: resourceFromAttributes({
     [SEMRESATTRS_SERVICE_NAME]: 'fetch-web-service'
   }),
   // Note: For production consider using the "BatchSpanProcessor" to reduce the number of requests

diff --git a/examples/opentelemetry-web/examples/fetchXhr/index.js b/examples/opentelemetry-web/examples/fetchXhr/index.js
@@ -6,11 +6,11 @@ const { FetchInstrumentation } = require('@opentelemetry/instrumentation-fetch')
 const { XMLHttpRequestInstrumentation } = require('@opentelemetry/instrumentation-xml-http-request');
 const { ZoneContextManager } = require('@opentelemetry/context-zone');
 const { registerInstrumentations } = require('@opentelemetry/instrumentation');
-const { Resource } = require('@opentelemetry/resources');
+const { resourceFromAttributes } = require('@opentelemetry/resources');
 const { SEMRESATTRS_SERVICE_NAME } = require('@opentelemetry/semantic-conventions');
 
 const provider = new WebTracerProvider({
-  resource: new Resource({
+  resource: resourceFromAttributes({
     [SEMRESATTRS_SERVICE_NAME]: 'fetch-xhr-web-service'
   }),
   // Note: For production consider using the "BatchSpanProcessor" to reduce the number of requests

diff --git a/examples/opentelemetry-web/examples/fetchXhrB3/index.js b/examples/opentelemetry-web/examples/fetchXhrB3/index.js
@@ -7,11 +7,11 @@ const { XMLHttpRequestInstrumentation } = require( '@opentelemetry/instrumentati
 const { ZoneContextManager } = require( '@opentelemetry/context-zone');
 const { B3Propagator } = require( '@opentelemetry/propagator-b3');
 const { registerInstrumentations } = require( '@opentelemetry/instrumentation');
-const { Resource } = require('@opentelemetry/resources');
+const { resourceFromAttributes } = require('@opentelemetry/resources');
 const { SEMRESATTRS_SERVICE_NAME } = require('@opentelemetry/semantic-conventions');
 
 const provider = new WebTracerProvider({
-  resource: new Resource({
+  resource: resourceFromAttributes({
     [SEMRESATTRS_SERVICE_NAME]: 'fetch-xhr-b3-web-service'
   }),
   // Note: For production consider using the "BatchSpanProcessor" to reduce the number of requests

diff --git a/examples/opentelemetry-web/examples/xml-http-request/index.js b/examples/opentelemetry-web/examples/xml-http-request/index.js
@@ -6,11 +6,11 @@ const { ZoneContextManager } = require( '@opentelemetry/context-zone');
 const { OTLPTraceExporter } = require( '@opentelemetry/exporter-trace-otlp-http');
 const { B3Propagator } = require( '@opentelemetry/propagator-b3');
 const { registerInstrumentations } = require( '@opentelemetry/instrumentation');
-const { Resource } = require('@opentelemetry/resources');
+const { resourceFromAttributes } = require('@opentelemetry/resources');
 const { SEMRESATTRS_SERVICE_NAME } = require('@opentelemetry/semantic-conventions');
 
 const providerWithZone = new WebTracerProvider({
-  resource: new Resource({
+  resource: resourceFromAttributes({
     [SEMRESATTRS_SERVICE_NAME]: 'xml-http-web-service'
   }),
   // Note: For production consider using the "BatchSpanProcessor" to reduce the number of requests

diff --git a/examples/opentelemetry-web/examples/zipkin/index.js b/examples/opentelemetry-web/examples/zipkin/index.js
@@ -1,11 +1,11 @@
 const { ConsoleSpanExporter, SimpleSpanProcessor } = require('@opentelemetry/sdk-trace-base');
 const { WebTracerProvider } = require('@opentelemetry/sdk-trace-web');
 const { ZipkinExporter } = require('@opentelemetry/exporter-zipkin');
-const { Resource } = require('@opentelemetry/resources');
+const { resourceFromAttributes } = require('@opentelemetry/resources');
 const { SEMRESATTRS_SERVICE_NAME } = require('@opentelemetry/semantic-conventions');
 
 const provider = new WebTracerProvider({
-  resource: new Resource({
+  resource: resourceFromAttributes({
     [SEMRESATTRS_SERVICE_NAME]: 'zipkin-web-service'
   }),
   // Note: For production consider using the "BatchSpanProcessor" to reduce the number of requests

diff --git a/examples/opentracing-shim/shim.js b/examples/opentracing-shim/shim.js
@@ -1,7 +1,7 @@
 'use strict';
 
 const { SEMRESATTRS_SERVICE_NAME } = require('@opentelemetry/semantic-conventions');
-const { Resource } = require('@opentelemetry/resources');
+const { resourceFromAttributes } = require('@opentelemetry/resources');
 const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
 const { SimpleSpanProcessor } = require('@opentelemetry/sdk-trace-base');
 const { JaegerExporter } = require('@opentelemetry/exporter-jaeger');
@@ -10,7 +10,7 @@ const { TracerShim } = require('@opentelemetry/shim-opentracing');
 
 function shim(serviceName) {
   const provider = new NodeTracerProvider({
-    resource: new Resource({ [SEMRESATTRS_SERVICE_NAME]: serviceName }),
+    resource: resourceFromAttributes({ [SEMRESATTRS_SERVICE_NAME]: serviceName }),
     spanProcessors: [new SimpleSpanProcessor(getExporter(serviceName))],
   });
 

diff --git a/examples/otlp-exporter-node/metrics.js b/examples/otlp-exporter-node/metrics.js
@@ -11,7 +11,7 @@ const {
   PeriodicExportingMetricReader,
   View,
 } = require('@opentelemetry/sdk-metrics');
-const { Resource } = require('@opentelemetry/resources');
+const { resourceFromAttributes } = require('@opentelemetry/resources');
 const {
   SEMRESATTRS_SERVICE_NAME,
 } = require('@opentelemetry/semantic-conventions');
@@ -35,7 +35,7 @@ const expHistogramView = new View({
 
 // Create an instance of the metric provider
 const meterProvider = new MeterProvider({
-  resource: new Resource({
+  resource: resourceFromAttributes({
     [SEMRESATTRS_SERVICE_NAME]: 'basic-metric-service',
   }),
   views: [expHistogramView],

diff --git a/examples/otlp-exporter-node/tracing.js b/examples/otlp-exporter-node/tracing.js
@@ -1,7 +1,7 @@
 'use strict';
 
 const { BasicTracerProvider, ConsoleSpanExporter, SimpleSpanProcessor } = require('@opentelemetry/sdk-trace-base');
-const { Resource } = require('@opentelemetry/resources');
+const { resourceFromAttributes } = require('@opentelemetry/resources');
 const { SEMRESATTRS_SERVICE_NAME } = require('@opentelemetry/semantic-conventions');
 const {
   diag,
@@ -23,7 +23,7 @@ const exporter = new OTLPTraceExporter({
 });
 
 const provider = new BasicTracerProvider({
-  resource: new Resource({
+  resource: resourceFromAttributes({
     [SEMRESATTRS_SERVICE_NAME]: 'basic-service',
   }),
   spanProcessors: [

diff --git a/experimental/examples/opencensus-shim/setup.js b/experimental/examples/opencensus-shim/setup.js
@@ -25,7 +25,7 @@ const {
   OTLPTraceExporter,
 } = require('@opentelemetry/exporter-trace-otlp-grpc');
 const { PrometheusExporter } = require('@opentelemetry/exporter-prometheus');
-const { Resource } = require('@opentelemetry/resources');
+const { resourceFromAttributes } = require('@opentelemetry/resources');
 const {
   SEMRESATTRS_SERVICE_NAME,
 } = require('@opentelemetry/semantic-conventions');
@@ -45,7 +45,7 @@ module.exports = function setup(serviceName) {
   const tracing = new TracingBase(['http']);
   tracing.tracer = new oc.CoreTracer();
 
-  const resource = new Resource({
+  const resource = resourceFromAttributes({
     [SEMRESATTRS_SERVICE_NAME]: serviceName,
   });
   const tracerProvider = new NodeTracerProvider({

diff --git a/experimental/packages/exporter-logs-otlp-proto/README.md b/experimental/packages/exporter-logs-otlp-proto/README.md
@@ -31,7 +31,7 @@ const collectorOptions = {
   }, //an optional object containing custom headers to be sent with each request will only work with http
 };
 
-const logProvider = new LoggerProvider({resource: new Resource({'service.name': 'testApp'})});
+const logProvider = new LoggerProvider({resource: resourceFromAttributes({'service.name': 'testApp'})});
 const logExporter = new OTLPLogExporter(collectorOptions);
 logProvider.addLogRecordProcessor(new SimpleLogRecordProcessor(exporter));