Refactor resource util to match specs. (#485)

* Refactor resource util to match specs.

* add check for AWS_EC2_INSTANCE type

Author: mayurkale22

packages/opencensus-exporter-stackdriver/src/common-utils.ts

@@ -16,10 +16,14 @@
 
 import {Labels} from '@opencensus/core';
 import * as resource from '@opencensus/resource-util';
+import {CLOUD_RESOURCE, CONTAINER_RESOURCE, HOST_RESOURCE, K8S_RESOURCE} from '@opencensus/resource-util';
 import {MonitoredResource} from './types';
 
 const STACKDRIVER_PROJECT_ID_KEY = 'project_id';
 const AWS_REGION_VALUE_PREFIX = 'aws:';
+const K8S_CONTAINER = 'k8s_container';
+const GCP_GCE_INSTANCE = 'gce_instance';
+const AWS_EC2_INSTANCE = 'aws_ec2_instance';
 
 /* Return a self-configured StackDriver monitored resource. */
 export async function getDefaultResource(projectId: string):
@@ -29,7 +33,8 @@ export async function getDefaultResource(projectId: string):
   const [type, mappings] = getTypeAndMappings(autoDetectedResource.type);
   Object.keys(mappings).forEach((key) => {
     if (autoDetectedResource.labels[mappings[key]]) {
-      if (mappings[key] === resource.AWS_REGION_KEY) {
+      if (type === AWS_EC2_INSTANCE &&
+          mappings[key] === CLOUD_RESOURCE.REGION_KEY) {
         labels[key] = `${AWS_REGION_VALUE_PREFIX}${
             autoDetectedResource.labels[mappings[key]]}`;
       } else {
@@ -45,32 +50,32 @@ function getTypeAndMappings(resourceType: string|null): [string, Labels] {
     case resource.GCP_GCE_INSTANCE_TYPE:
       // https://cloud.google.com/monitoring/api/resources#tag_gce_instance
       return [
-        'gce_instance', {
+        GCP_GCE_INSTANCE, {
           'project_id': STACKDRIVER_PROJECT_ID_KEY,
-          'instance_id': resource.GCP_INSTANCE_ID_KEY,
-          'zone': resource.GCP_ZONE_KEY
+          'instance_id': HOST_RESOURCE.ID_KEY,
+          'zone': CLOUD_RESOURCE.ZONE_KEY
         }
       ];
     case resource.K8S_CONTAINER_TYPE:
       // https://cloud.google.com/monitoring/api/resources#tag_k8s_container
       return [
-        'k8s_container', {
+        K8S_CONTAINER, {
           'project_id': STACKDRIVER_PROJECT_ID_KEY,
-          'location': resource.GCP_ZONE_KEY,
-          'cluster_name': resource.K8S_CLUSTER_NAME_KEY,
-          'namespace_name': resource.K8S_NAMESPACE_NAME_KEY,
-          'pod_name': resource.K8S_POD_NAME_KEY,
-          'container_name': resource.K8S_CONTAINER_NAME_KEY
+          'location': CLOUD_RESOURCE.ZONE_KEY,
+          'cluster_name': K8S_RESOURCE.CLUSTER_NAME_KEY,
+          'namespace_name': K8S_RESOURCE.NAMESPACE_NAME_KEY,
+          'pod_name': K8S_RESOURCE.POD_NAME_KEY,
+          'container_name': CONTAINER_RESOURCE.NAME_KEY
         }
       ];
     case resource.AWS_EC2_INSTANCE_TYPE:
       // https://cloud.google.com/monitoring/api/resources#tag_aws_ec2_instance
       return [
-        'aws_ec2_instance', {
+        AWS_EC2_INSTANCE, {
           'project_id': STACKDRIVER_PROJECT_ID_KEY,
-          'instance_id': resource.AWS_INSTANCE_ID_KEY,
-          'region': resource.AWS_REGION_KEY,
-          'aws_account': resource.AWS_ACCOUNT_KEY
+          'instance_id': HOST_RESOURCE.ID_KEY,
+          'region': CLOUD_RESOURCE.REGION_KEY,
+          'aws_account': CLOUD_RESOURCE.ACCOUNT_ID_KEY
         }
       ];
     default:

packages/opencensus-exporter-stackdriver/test/test-stackdriver-monitoring-utils.ts

@@ -466,9 +466,9 @@ describe('Stackdriver Stats Exporter Utils', () => {
 
     it('should return a k8s MonitoredResource', async () => {
       process.env.OC_RESOURCE_TYPE = 'k8s.io/container';
-      process.env.OC_RESOURCE_LABELS = 'k8s.io/pod/name=pod-xyz-123,' +
-          'k8s.io/container/name=c1,k8s.io/namespace/name=default,' +
-          'cloud.google.com/gce/zone=zone1';
+      process.env.OC_RESOURCE_LABELS = 'k8s.pod.name=pod-xyz-123,' +
+          'container.name=c1,k8s.namespace.name=default,' +
+          'cloud.zone=zone1';
       CoreResource.setup();
       const monitoredResource = await getDefaultResource('my-project-id');
       const {type, labels} = monitoredResource;
@@ -486,8 +486,7 @@ describe('Stackdriver Stats Exporter Utils', () => {
 
     it('should return a gce MonitoredResource', async () => {
       process.env.OC_RESOURCE_TYPE = 'cloud.google.com/gce/instance';
-      process.env.OC_RESOURCE_LABELS = 'cloud.google.com/gce/instance_id=id1,' +
-          'cloud.google.com/gce/zone=zone1';
+      process.env.OC_RESOURCE_LABELS = 'host.id=id1,cloud.zone=zone1';
       CoreResource.setup();
       const monitoredResource = await getDefaultResource('my-project-id');
       const {type, labels} = monitoredResource;
@@ -503,8 +502,8 @@ describe('Stackdriver Stats Exporter Utils', () => {
 
     it('should return a aws MonitoredResource', async () => {
       process.env.OC_RESOURCE_TYPE = 'aws.com/ec2/instance';
-      process.env.OC_RESOURCE_LABELS = 'aws.com/ec2/account_id=id1,' +
-          'aws.com/ec2/instance_id=instance1,aws.com/ec2/region=region1';
+      process.env.OC_RESOURCE_LABELS = 'cloud.account.id=id1,' +
+          'host.id=instance1,cloud.region=region1';
       CoreResource.setup();
       const monitoredResource = await getDefaultResource('my-project-id');
       const {type, labels} = monitoredResource;

packages/opencensus-resource-util/src/constants.ts

@@ -0,0 +1,103 @@
+/**
+ * Copyright 2019, OpenCensus Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/** Constants for Cloud Resource environment. */
+export const CLOUD_RESOURCE = {
+  /** The type of the Resource. */
+  TYPE: 'cloud',
+
+  /**
+   * Key for the name of the cloud provider. Example values are aws, azure,
+   * gcp.
+   */
+  PROVIDER_KEY: 'cloud.provider',
+
+  /** The value of the provider when running in AWS. */
+  PROVIDER_AWS: 'aws',
+
+  /** The value of the provider when running in AZURE. */
+  PROVIDER_AZURE: 'azure',
+
+  /** The value of the provider when running in GCP. */
+  PROVIDER_GCP: 'gcp',
+
+  /** Key for the region in which entities are running. */
+  REGION_KEY: 'cloud.region',
+
+  /** Key for the cloud account id used to identify different entities. */
+  ACCOUNT_ID_KEY: 'cloud.account.id',
+
+  /** Key for the zone in which entities are running. */
+  ZONE_KEY: 'cloud.zone'
+};
+
+/** Constants for K8S container Resource. */
+export const CONTAINER_RESOURCE = {
+  /** Kubernetes resources key that represents a type of the resource. */
+  TYPE: 'container',
+
+  /** Key for the container name. */
+  NAME_KEY: 'container.name',
+
+  /** Key for the container image name. */
+  IMAGE_NAME_KEY: 'container.image.name',
+
+  /** Key for the container image tag. */
+  IMAGE_TAG_KEY: 'container.image.tag'
+};
+
+/**
+ * Constants for Host Resource. A host is defined as a general computing
+ * instance.
+ */
+export const HOST_RESOURCE = {
+  /** The type of the Resource. */
+  TYPE: 'host',
+
+  /**
+   * Key for the hostname of the host.
+   * It contains what the `hostname` command returns on the host machine.
+   */
+  HOSTNAME_KEY: 'host.hostname',
+
+  /**
+   * Key for the name of the host.
+   * It may contain what `hostname` returns on Unix systems, the fully
+   * qualified, or a name specified by the user.
+   */
+  NAME_KEY: 'host.name',
+
+  /** Key for the unique host id (instance id in Cloud). */
+  ID_KEY: 'host.id',
+
+  /** Key for the type of the host (machine type). */
+  TYPE_KEY: 'host.type'
+};
+
+/** Constants for Kubernetes deployment service Resource. */
+export const K8S_RESOURCE = {
+  /** The type of the Resource. */
+  TYPE: 'k8s',
+
+  /** Key for the name of the cluster. */
+  CLUSTER_NAME_KEY: 'k8s.cluster.name',
+
+  /** Key for the name of the namespace. */
+  NAMESPACE_NAME_KEY: 'k8s.namespace.name',
+
+  /** Key for the name of the pod. */
+  POD_NAME_KEY: 'k8s.pod.name'
+};

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

@@ -15,4 +15,5 @@
  */
 
 export * from './resource-labels';
+export * from './constants';
 export * from './detect-resource';

packages/opencensus-resource-util/src/resource-labels.ts

@@ -19,50 +19,8 @@
 /** AWS key that represents a type of the resource. */
 export const AWS_EC2_INSTANCE_TYPE = 'aws.com/ec2/instance';
 
-/** AWS key that represents a region for the VM. */
-export const AWS_REGION_KEY = 'aws.com/ec2/region';
-
-/** AWS key that represents the AWS account number for the VM. */
-export const AWS_ACCOUNT_KEY = 'aws.com/ec2/account_id';
-
-/** AWS key that represents the VM instance identifier assigned by AWS. */
-export const AWS_INSTANCE_ID_KEY = 'aws.com/ec2/instance_id';
-
 /** GCP GCE key that represents a type of the resource. */
 export const GCP_GCE_INSTANCE_TYPE = 'cloud.google.com/gce/instance';
 
-/** GCP GCE key that represents the GCP account number for the instance. */
-export const GCP_ACCOUNT_ID_KEY = 'cloud.google.com/gce/project_id';
-
-/**
- * GCP GCE key that represents the numeric VM instance identifier assigned by
- * GCE.
- */
-export const GCP_INSTANCE_ID_KEY = 'cloud.google.com/gce/instance_id';
-
-/** GCP GCE key that represents the GCE zone in which the VM is running. */
-export const GCP_ZONE_KEY = 'cloud.google.com/gce/zone';
-
 /** Kubernetes resources key that represents a type of the resource. */
 export const K8S_CONTAINER_TYPE = 'k8s.io/container';
-
-/**
- * Kubernetes resources key that represents the name for the cluster the
- * container is running in.
- */
-export const K8S_CLUSTER_NAME_KEY = 'k8s.io/cluster/name';
-
-/** Kubernetes resources key that represents the name of the container. */
-export const K8S_CONTAINER_NAME_KEY = 'k8s.io/container/name';
-
-/**
- * Kubernetes resources key that represents the identifier for the GCE
- * instance the container is running in.
- */
-export const K8S_NAMESPACE_NAME_KEY = 'k8s.io/namespace/name';
-
-/**
- * Kubernetes resources key that represents the identifier for the pod the
- * container is running in.
- */
-export const K8S_POD_NAME_KEY = 'k8s.io/pod/name';

packages/opencensus-resource-util/src/resource-utils.ts

@@ -23,6 +23,7 @@ import {Labels, Resource} from '@opencensus/core';
 import * as gcpMetadata from 'gcp-metadata';
 import * as http from 'http';
 import * as os from 'os';
+import {CLOUD_RESOURCE, CONTAINER_RESOURCE, HOST_RESOURCE, K8S_RESOURCE} from './constants';
 import * as constants from './resource-labels';
 
 export const AWS_INSTANCE_IDENTITY_DOCUMENT_URI =
@@ -70,11 +71,10 @@ async function isRunningOnComputeEngine() {
 async function isRunningOnAwsEc2() {
   try {
     const awsIdentityDocument: Labels = await awsMetadataAccessor();
-    awsResourceLabels[constants.AWS_ACCOUNT_KEY] =
+    awsResourceLabels[CLOUD_RESOURCE.ACCOUNT_ID_KEY] =
         awsIdentityDocument.accountId;
-    awsResourceLabels[constants.AWS_REGION_KEY] = awsIdentityDocument.region;
-    awsResourceLabels[constants.AWS_INSTANCE_ID_KEY] =
-        awsIdentityDocument.instanceId;
+    awsResourceLabels[CLOUD_RESOURCE.REGION_KEY] = awsIdentityDocument.region;
+    awsResourceLabels[HOST_RESOURCE.ID_KEY] = awsIdentityDocument.instanceId;
     return true;
   } catch {
     return false;
@@ -86,9 +86,9 @@ export async function getComputerEngineResource(): Promise<Resource> {
   if (Object.keys(gceResourceLabels).length === 0) {
     const [projectId, instanceId, zoneId] =
         await Promise.all([getProjectId(), getInstanceId(), getZone()]);
-    gceResourceLabels[constants.GCP_ACCOUNT_ID_KEY] = projectId;
-    gceResourceLabels[constants.GCP_INSTANCE_ID_KEY] = instanceId;
-    gceResourceLabels[constants.GCP_ZONE_KEY] = zoneId;
+    gceResourceLabels[CLOUD_RESOURCE.ACCOUNT_ID_KEY] = projectId;
+    gceResourceLabels[HOST_RESOURCE.ID_KEY] = instanceId;
+    gceResourceLabels[CLOUD_RESOURCE.ZONE_KEY] = zoneId;
   }
   return {type: constants.GCP_GCE_INSTANCE_TYPE, labels: gceResourceLabels};
 }
@@ -98,13 +98,13 @@ export async function getKubernetesEngineResource(): Promise<Resource> {
   if (Object.keys(gkeResourceLabels).length === 0) {
     const [projectId, zoneId, clusterName, hostname] = await Promise.all(
         [getProjectId(), getZone(), getClusterName(), getHostname()]);
-    gkeResourceLabels[constants.GCP_ACCOUNT_ID_KEY] = projectId;
-    gkeResourceLabels[constants.GCP_ZONE_KEY] = zoneId;
-    gkeResourceLabels[constants.K8S_CLUSTER_NAME_KEY] = clusterName;
-    gkeResourceLabels[constants.K8S_NAMESPACE_NAME_KEY] =
+    gkeResourceLabels[CLOUD_RESOURCE.ACCOUNT_ID_KEY] = projectId;
+    gkeResourceLabels[CLOUD_RESOURCE.ZONE_KEY] = zoneId;
+    gkeResourceLabels[K8S_RESOURCE.CLUSTER_NAME_KEY] = clusterName;
+    gkeResourceLabels[K8S_RESOURCE.NAMESPACE_NAME_KEY] =
         process.env.NAMESPACE || '';
-    gkeResourceLabels[constants.K8S_POD_NAME_KEY] = hostname;
-    gkeResourceLabels[constants.K8S_CONTAINER_NAME_KEY] =
+    gkeResourceLabels[K8S_RESOURCE.POD_NAME_KEY] = hostname;
+    gkeResourceLabels[CONTAINER_RESOURCE.NAME_KEY] =
         process.env.CONTAINER_NAME || '';
   }
   return {type: constants.K8S_CONTAINER_TYPE, labels: gkeResourceLabels};