feat(resource-util)!: remove deprecated code and features (#817)

before the next release where we are already making some breaking changes

Author: aabmass

packages/opentelemetry-resource-util/__snapshots__/index.test.ts.js

@@ -349,24 +349,6 @@ exports['mapOtelResourceToMonitoredResource should map to aws_ec2_instance" 1']
   }
 }
 
-exports['mapOtelResourceToMonitoredResource should map to cloud_function" 1'] = {
-  "type": "cloud_function",
-  "labels": {
-    "region": "myregion",
-    "function_name": "myfaasname"
-  }
-}
-
-exports['mapOtelResourceToMonitoredResource should map to cloud_run_revision" 1'] = {
-  "type": "cloud_run_revision",
-  "labels": {
-    "location": "myregion",
-    "service_name": "myfaasname",
-    "configuration_name": "myfaasname",
-    "revision_name": "myfaasversion"
-  }
-}
-
 exports['mapOtelResourceToMonitoredResource should map to gae_instance" 1'] = {
   "type": "gae_instance",
   "labels": {

packages/opentelemetry-resource-util/src/detector/detector.ts

@@ -198,16 +198,6 @@ async function makeResource(attrs: GcpResourceAttributes): Promise<Resource> {
   } satisfies GcpResourceAttributes);
 }
 
-/**
- * Async Google Cloud resource detector which populates attributes based the on environment
- * this process is running in. If not on GCP, returns an empty resource.
- *
- * @deprecated Async resource detectors are deprecated. Please use {@link GcpDetectorSync} instead.
- */
-export class GcpDetector {
-  detect = detect;
-}
-
 /**
  * Google Cloud resource detector which populates attributes based on the environment this
  * process is running in. If not on GCP, returns an empty resource.

packages/opentelemetry-resource-util/src/index.ts

@@ -17,8 +17,6 @@ import {Resource} from '@opentelemetry/resources';
 import {
   CLOUDPLATFORMVALUES_AWS_EC2,
   CLOUDPLATFORMVALUES_GCP_APP_ENGINE,
-  CLOUDPLATFORMVALUES_GCP_CLOUD_FUNCTIONS,
-  CLOUDPLATFORMVALUES_GCP_CLOUD_RUN,
   CLOUDPLATFORMVALUES_GCP_COMPUTE_ENGINE,
   SEMRESATTRS_CLOUD_ACCOUNT_ID,
   SEMRESATTRS_CLOUD_AVAILABILITY_ZONE,
@@ -230,21 +228,6 @@ export interface MonitoredResource {
  */
 export function mapOtelResourceToMonitoredResource(
   resource: Resource,
-): MonitoredResource;
-/**
- * @deprecated This overload is deprecated, do not pass the includeUnsupportedResources boolean
- * parameter. It will be removed in the next major version release.
- *
- * @param resource the OTel Resource
- * @returns the corresponding GCM MonitoredResource
- */
-export function mapOtelResourceToMonitoredResource(
-  resource: Resource,
-  includeUnsupportedResources: boolean | undefined,
-): MonitoredResource;
-export function mapOtelResourceToMonitoredResource(
-  resource: Resource,
-  includeUnsupportedResources = false,
 ): MonitoredResource {
   const attrs = resource.attributes;
   const platform = attrs[SEMRESATTRS_CLOUD_PLATFORM];
@@ -256,18 +239,6 @@ export function mapOtelResourceToMonitoredResource(
     mr = createMonitoredResource(GAE_INSTANCE, attrs);
   } else if (platform === CLOUDPLATFORMVALUES_AWS_EC2) {
     mr = createMonitoredResource(AWS_EC2_INSTANCE, attrs);
-  }
-  // Cloud Run and Cloud Functions are not writeable for custom metrics yet
-  else if (
-    includeUnsupportedResources &&
-    platform === CLOUDPLATFORMVALUES_GCP_CLOUD_RUN
-  ) {
-    mr = createMonitoredResource(CLOUD_RUN_REVISION, attrs);
-  } else if (
-    includeUnsupportedResources &&
-    platform === CLOUDPLATFORMVALUES_GCP_CLOUD_FUNCTIONS
-  ) {
-    mr = createMonitoredResource(CLOUD_FUNCTION, attrs);
   } else if (SEMRESATTRS_K8S_CLUSTER_NAME in attrs) {
     // if k8s.cluster.name is set, pattern match for various k8s resources.
     // this will also match non-cloud k8s platforms like minikube.
@@ -341,4 +312,4 @@ function createMonitoredResource(
   };
 }
 
-export {GcpDetector, GcpDetectorSync} from './detector/detector';
+export {GcpDetectorSync} from './detector/detector';

packages/opentelemetry-resource-util/test/detector/detector.test.ts

@@ -15,7 +15,7 @@
 import * as sinon from 'sinon';
 import * as metadata from 'gcp-metadata';
 
-import {GcpDetector, GcpDetectorSync} from '../../src/detector/detector';
+import {GcpDetectorSync} from '../../src/detector/detector';
 import {
   detectResources,
   ResourceDetector,
@@ -29,196 +29,6 @@ async function detectAndWait(detector: ResourceDetector): Promise<Resource> {
   return resource;
 }
 
-describe('GcpDetector', () => {
-  let metadataStub: sinon.SinonStubbedInstance<typeof metadata>;
-  let envStub: NodeJS.ProcessEnv;
-  beforeEach(() => {
-    metadataStub = sinon.stub(metadata);
-    metadataStub.isAvailable.resolves(true);
-    metadataStub.project.withArgs('project-id').resolves('fake-project-id');
-
-    envStub = sinon.replace(process, 'env', {});
-  });
-
-  afterEach(() => {
-    sinon.restore();
-  });
-
-  it('returns empty resource when metadata server is not available', async () => {
-    metadataStub.isAvailable.resolves(false);
-    const resource = await new GcpDetector().detect();
-    assert.deepStrictEqual(resource.attributes, {});
-  });
-
-  describe('detects a GKE resource', () => {
-    beforeEach(() => {
-      envStub.KUBERNETES_SERVICE_HOST = 'fake-service-host';
-      metadataStub.instance
-        .withArgs('id')
-        .resolves(12345)
-
-        .withArgs('attributes/cluster-name')
-        .resolves('fake-cluster-name');
-    });
-
-    it('zonal', async () => {
-      metadataStub.instance
-        .withArgs('attributes/cluster-location')
-        .resolves('us-east4-b');
-      const resource = await new GcpDetector().detect();
-      assert.deepStrictEqual(resource.attributes, {
-        'cloud.account.id': 'fake-project-id',
-        'cloud.availability_zone': 'us-east4-b',
-        'cloud.platform': 'gcp_kubernetes_engine',
-        'cloud.provider': 'gcp',
-        'host.id': '12345',
-        'k8s.cluster.name': 'fake-cluster-name',
-      });
-    });
-
-    it('regional', async () => {
-      metadataStub.instance
-        .withArgs('attributes/cluster-location')
-        .resolves('us-east4');
-      const resource = await new GcpDetector().detect();
-      assert.deepStrictEqual(resource.attributes, {
-        'cloud.account.id': 'fake-project-id',
-        'cloud.platform': 'gcp_kubernetes_engine',
-        'cloud.provider': 'gcp',
-        'cloud.region': 'us-east4',
-        'host.id': '12345',
-        'k8s.cluster.name': 'fake-cluster-name',
-      });
-    });
-  });
-
-  it('detects a GCE resource', async () => {
-    metadataStub.instance
-      .withArgs('id')
-      .resolves(12345)
-
-      .withArgs('machine-type')
-      .resolves('fake-machine-type')
-
-      .withArgs('name')
-      .resolves('fake-name')
-
-      .withArgs('zone')
-      .resolves('projects/233510669999/zones/us-east4-b');
-
-    const resource = await new GcpDetector().detect();
-    assert.deepStrictEqual(resource.attributes, {
-      'cloud.account.id': 'fake-project-id',
-      'cloud.availability_zone': 'us-east4-b',
-      'cloud.platform': 'gcp_compute_engine',
-      'cloud.provider': 'gcp',
-      'cloud.region': 'us-east4',
-      'host.id': '12345',
-      'host.name': 'fake-name',
-      'host.type': 'fake-machine-type',
-    });
-  });
-
-  it('detects a Cloud Run resource', async () => {
-    envStub.K_CONFIGURATION = 'fake-configuration';
-    envStub.K_SERVICE = 'fake-service';
-    envStub.K_REVISION = 'fake-revision';
-    metadataStub.instance
-      .withArgs('id')
-      .resolves(12345)
-
-      .withArgs('region')
-      .resolves('projects/233510669999/regions/us-east4');
-
-    const resource = await new GcpDetector().detect();
-    assert.deepStrictEqual(resource.attributes, {
-      'cloud.account.id': 'fake-project-id',
-      'cloud.platform': 'gcp_cloud_run',
-      'cloud.provider': 'gcp',
-      'cloud.region': 'us-east4',
-      'faas.instance': '12345',
-      'faas.name': 'fake-service',
-      'faas.version': 'fake-revision',
-    });
-  });
-
-  it('detects a Cloud Functions resource', async () => {
-    envStub.FUNCTION_TARGET = 'fake-function-target';
-    envStub.K_SERVICE = 'fake-service';
-    envStub.K_REVISION = 'fake-revision';
-    metadataStub.instance
-      .withArgs('id')
-      .resolves(12345)
-
-      .withArgs('region')
-      .resolves('projects/233510669999/regions/us-east4');
-
-    const resource = await new GcpDetector().detect();
-    assert.deepStrictEqual(resource.attributes, {
-      'cloud.account.id': 'fake-project-id',
-      'cloud.platform': 'gcp_cloud_functions',
-      'cloud.provider': 'gcp',
-      'cloud.region': 'us-east4',
-      'faas.instance': '12345',
-      'faas.name': 'fake-service',
-      'faas.version': 'fake-revision',
-    });
-  });
-
-  it('detects a App Engine Standard resource', async () => {
-    envStub.GAE_ENV = 'standard';
-    envStub.GAE_SERVICE = 'fake-service';
-    envStub.GAE_VERSION = 'fake-version';
-    envStub.GAE_INSTANCE = 'fake-instance';
-    metadataStub.instance.withArgs('zone').resolves('us-east4-b');
-    metadataStub.instance
-      .withArgs('region')
-      .resolves('projects/233510669999/regions/us-east4');
-
-    const resource = await new GcpDetector().detect();
-    assert.deepStrictEqual(resource.attributes, {
-      'cloud.account.id': 'fake-project-id',
-      'cloud.availability_zone': 'us-east4-b',
-      'cloud.platform': 'gcp_app_engine',
-      'cloud.provider': 'gcp',
-      'cloud.region': 'us-east4',
-      'faas.instance': 'fake-instance',
-      'faas.name': 'fake-service',
-      'faas.version': 'fake-version',
-    });
-  });
-
-  it('detects a App Engine Flex resource', async () => {
-    envStub.GAE_SERVICE = 'fake-service';
-    envStub.GAE_VERSION = 'fake-version';
-    envStub.GAE_INSTANCE = 'fake-instance';
-    metadataStub.instance
-      .withArgs('zone')
-      .resolves('projects/233510669999/zones/us-east4-b');
-
-    const resource = await new GcpDetector().detect();
-    assert.deepStrictEqual(resource.attributes, {
-      'cloud.account.id': 'fake-project-id',
-      'cloud.availability_zone': 'us-east4-b',
-      'cloud.platform': 'gcp_app_engine',
-      'cloud.provider': 'gcp',
-      'cloud.region': 'us-east4',
-      'faas.instance': 'fake-instance',
-      'faas.name': 'fake-service',
-      'faas.version': 'fake-version',
-    });
-  });
-
-  it('detects empty resource when nothing else can be detected', async () => {
-    // gcp-metadata throws when it can't access the metadata server
-    metadataStub.instance.rejects();
-    metadataStub.project.rejects();
-
-    const resource = await new GcpDetector().detect();
-    assert.deepStrictEqual(resource.attributes, {});
-  });
-});
-
 describe('GcpDetectorSync', () => {
   let metadataStub: sinon.SinonStubbedInstance<typeof metadata>;
   let envStub: NodeJS.ProcessEnv;

packages/opentelemetry-resource-util/test/index.test.ts

@@ -55,20 +55,6 @@ describe('mapOtelResourceToMonitoredResource', () => {
         'cloud.account.id': 'myawsaccount',
       },
     },
-
-    {
-      title: 'should map to cloud_run_revision"',
-      otelAttributes: {
-        'cloud.platform': 'gcp_cloud_run',
-        'cloud.region': 'myregion',
-        'faas.instance': 'myfaasinstance',
-        'faas.name': 'myfaasname',
-        'faas.version': 'myfaasversion',
-        'service.name': 'servicename',
-        'service.instance.id': 'serviceinstanceid',
-      },
-      includeUnsupportedResources: true,
-    },
     {
       title:
         'should map cloud_run_revision to generic_task when not including unsupported resources"',
@@ -82,22 +68,8 @@ describe('mapOtelResourceToMonitoredResource', () => {
         'service.namespace': 'servicens',
         'service.instance.id': 'serviceinstanceid',
       },
-      includeUnsupportedResources: false,
     },
 
-    {
-      title: 'should map to cloud_function"',
-      otelAttributes: {
-        'cloud.platform': 'gcp_cloud_functions',
-        'cloud.region': 'myregion',
-        'faas.instance': 'myfaasinstance',
-        'faas.name': 'myfaasname',
-        'faas.version': 'myfaasversion',
-        'service.name': 'servicename',
-        'service.instance.id': 'serviceinstanceid',
-      },
-      includeUnsupportedResources: true,
-    },
     {
       title:
         'should map cloud_function to generic_task when not including unsupported resources"',
@@ -111,7 +83,6 @@ describe('mapOtelResourceToMonitoredResource', () => {
         'service.namespace': 'servicens',
         'service.instance.id': 'serviceinstanceid',
       },
-      includeUnsupportedResources: false,
     },
 
     {
@@ -238,13 +209,10 @@ describe('mapOtelResourceToMonitoredResource', () => {
       title: 'should map empty resource to generic_node',
       otelAttributes: {foo: 'bar', 'no.useful': 'resourceattribs'},
     },
-  ].forEach(({title, otelAttributes, includeUnsupportedResources}) => {
+  ].forEach(({title, otelAttributes}) => {
     it(title, () => {
       const resource = resourceFromAttributes(otelAttributes);
-      const actual = mapOtelResourceToMonitoredResource(
-        resource,
-        includeUnsupportedResources,
-      );
+      const actual = mapOtelResourceToMonitoredResource(resource);
       snapshot(actual);
     });
   });