Readme and commented code

Author: jeremydvoss

resource/opentelemetry-resource-detector-azure-app-service/README.rst

@@ -8,15 +8,21 @@ OpenTelemetry Resource detectors for Azure App Services
 
 
 This library provides custom resource detector for Azure App Services. OpenTelemetry Python has an experimental feature whereby Resource Detectors can be injected to Resource Attributes. This package includes a resource detector for Azure App Service. This detector fills out the following Resource Attributes:
- * `service.name`
- * `cloud.provider`
- * `cloud.platform`
- * `cloud.resource_id`
- * `cloud.region`
- * `deployment.environment`
- * `host.id`
- * `service.instance.id`
- * `azure.app.service.stamp`
+ * `service.name` set to the value of the WEBSITE_SITE_NAME environment variable.
+ * `cloud.provider` set to the value of the "azure".
+ * `cloud.platform` set to the value of the "azure_app_service".
+ * `cloud.resource_id` set using the WEBSITE_RESOURCE_GROUP WEBSITE_OWNER_NAME and WEBSITE_SITE_NAME environment variables.
+ * `cloud.region` set to the value of the REGION_NAME environment variable.
+ * `deployment.environment` set to the value of the WEBSITE_SLOT_NAME environment variable.
+ * `host.id` set to the value of the WEBSITE_HOSTNAME environment variable.
+ * `service.instance.id` set to the value of the WEBSITE_INSTANCE_ID environment variable.
+ * `azure.app.service.stamp` set to the value of the WEBSITE_HOME_STAMPNAME environment variable.
+
+ ResourceAttributes.CLOUD_REGION: _REGION_NAME,
+    ResourceAttributes.DEPLOYMENT_ENVIRONMENT: _WEBSITE_SLOT_NAME,
+    ResourceAttributes.HOST_ID: _WEBSITE_HOSTNAME,
+    ResourceAttributes.SERVICE_INSTANCE_ID: _WEBSITE_INSTANCE_ID,
+    _AZURE_APP_SERVICE_STAMP_RESOURCE_ATTRIBUTE: _WEBSITE_HOME_STAMPNAME,
 
  For more information, see the Semantic Conventions for Cloud Resource Attributes.
 

resource/opentelemetry-resource-detector-azure-app-service/tests/test_app_service_resource_detector.py

@@ -31,15 +31,6 @@ class TestAzureAppServiceResourceDetector(unittest.TestCase):
     def test_on_app_service(self):
         resource = AzureAppServiceResourceDetector().detect()
         attributes = resource.attributes
-        # self.assertEqual(attributes {
-        #     "service.name": TEST_WEBSITE_SITE_NAME,
-        #     "cloud.provider": ,
-        #     "cloud.platform": ,
-        #     "cloud.resource_id": ,
-        #     "cloud.region": ,
-        #     "deployment.environment": ,
-        #     "deployment.environment": ,
-        # })
         self.assertEqual(attributes["service.name"], TEST_WEBSITE_SITE_NAME)
         self.assertEqual(attributes["cloud.provider"], "azure")
         self.assertEqual(attributes["cloud.platform"], "azure_app_service")