update resource detectors to align with spec changes (#1573)

PR open-telemetry/opentelemetry-specification#4461 clarifies that some
attributes (service.name, telemetry.*) are mandatory. It also reserves a couple of well-known
detectors names (container, host, process, service) and the attributes they should populate.
Consolidate some of our resource detectors into the built-in ones:
- process-runtime into process, and deprecate
- os into host, and deprecate
- sdk-provided into sdk, and deprecate
- service.name attribute from environment into service detector

Add "mandatory attributes", which is currently service.name, and initially set this to "unknown_service:php"
similar to Java's implementation. Ensure that the composite detector starts with mandatory attributes.

Ensure that "sdk" and "service" detectors are always included from ResourceInfoFactory.

The deprecated detectors are still available, but do not do anything.

Author: brettmc

Resource/Detectors/Composer.php

@@ -12,6 +12,9 @@
 use OpenTelemetry\SDK\Resource\ResourceInfoFactory;
 use OpenTelemetry\SemConv\ResourceAttributes;
 
+/**
+ * Detect service name and version of root package. Not included in `all` detectors.
+ */
 final class Composer implements ResourceDetectorInterface
 {
     public function getResource(): ResourceInfo

Resource/Detectors/Composite.php

@@ -19,7 +19,7 @@ public function __construct(private readonly iterable $resourceDetectors)
 
     public function getResource(): ResourceInfo
     {
-        $resource = ResourceInfoFactory::emptyResource();
+        $resource = ResourceInfoFactory::mandatoryResource();
         foreach ($this->resourceDetectors as $resourceDetector) {
             $resource = $resource->merge($resourceDetector->getResource());
         }

Resource/Detectors/Environment.php

@@ -22,14 +22,6 @@ public function getResource(): ResourceInfo
             ? self::decode(Configuration::getMap(Variables::OTEL_RESOURCE_ATTRIBUTES, []))
             : [];
 
-        //@see https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/configuration/sdk-environment-variables.md#general-sdk-configuration
-        $serviceName = Configuration::has(Variables::OTEL_SERVICE_NAME)
-            ? Configuration::getString(Variables::OTEL_SERVICE_NAME)
-            : null;
-        if ($serviceName) {
-            $attributes[ResourceAttributes::SERVICE_NAME] = $serviceName;
-        }
-
         return ResourceInfo::create(Attributes::create($attributes), ResourceAttributes::SCHEMA_URL);
     }
 

Resource/Detectors/Host.php

@@ -8,10 +8,14 @@
 use OpenTelemetry\SDK\Resource\ResourceDetectorInterface;
 use OpenTelemetry\SDK\Resource\ResourceInfo;
 use OpenTelemetry\SemConv\ResourceAttributes;
+use const PHP_OS;
+use const PHP_OS_FAMILY;
 use function php_uname;
+use function strtolower;
 
 /**
  * @see https://github.com/open-telemetry/opentelemetry-specification/blob/v1.8.0/specification/resource/semantic_conventions/host.md#host
+ * @see https://github.com/open-telemetry/opentelemetry-specification/blob/v1.8.0/specification/resource/semantic_conventions/os.md
  */
 final class Host implements ResourceDetectorInterface
 {
@@ -31,6 +35,10 @@ public function getResource(): ResourceInfo
             ResourceAttributes::HOST_NAME => php_uname('n'),
             ResourceAttributes::HOST_ARCH => php_uname('m'),
             ResourceAttributes::HOST_ID => $this->getMachineId(),
+            ResourceAttributes::OS_TYPE => strtolower(PHP_OS_FAMILY),
+            ResourceAttributes::OS_DESCRIPTION => php_uname('r'),
+            ResourceAttributes::OS_NAME => PHP_OS,
+            ResourceAttributes::OS_VERSION => php_uname('v'),
         ];
 
         return ResourceInfo::create(Attributes::create($attributes), ResourceAttributes::SCHEMA_URL);

Resource/Detectors/OperatingSystem.php

@@ -4,29 +4,16 @@
 
 namespace OpenTelemetry\SDK\Resource\Detectors;
 
-use OpenTelemetry\SDK\Common\Attribute\Attributes;
 use OpenTelemetry\SDK\Resource\ResourceDetectorInterface;
 use OpenTelemetry\SDK\Resource\ResourceInfo;
-use OpenTelemetry\SemConv\ResourceAttributes;
-use const PHP_OS;
-use const PHP_OS_FAMILY;
-use function php_uname;
-use function strtolower;
 
 /**
- * @see https://github.com/open-telemetry/opentelemetry-specification/blob/v1.8.0/specification/resource/semantic_conventions/os.md
+ * @deprecated Use Host detector instead.
  */
 final class OperatingSystem implements ResourceDetectorInterface
 {
     public function getResource(): ResourceInfo
     {
-        $attributes = [
-            ResourceAttributes::OS_TYPE => strtolower(PHP_OS_FAMILY),
-            ResourceAttributes::OS_DESCRIPTION => php_uname('r'),
-            ResourceAttributes::OS_NAME => PHP_OS,
-            ResourceAttributes::OS_VERSION => php_uname('v'),
-        ];
-
-        return ResourceInfo::create(Attributes::create($attributes), ResourceAttributes::SCHEMA_URL);
+        return ResourceInfo::emptyResource();
     }
 }

Resource/Detectors/Process.php

@@ -11,9 +11,12 @@
 use OpenTelemetry\SDK\Resource\ResourceInfo;
 use OpenTelemetry\SemConv\ResourceAttributes;
 use const PHP_BINARY;
+use function php_sapi_name;
+use const PHP_VERSION;
 
 /**
  * @see https://github.com/open-telemetry/opentelemetry-specification/blob/v1.8.0/specification/resource/semantic_conventions/process.md#process
+ * @see https://github.com/open-telemetry/opentelemetry-specification/blob/v1.8.0/specification/resource/semantic_conventions/process.md#process-runtimes
  */
 final class Process implements ResourceDetectorInterface
 {
@@ -22,9 +25,13 @@ final class Process implements ResourceDetectorInterface
      */
     public function getResource(): ResourceInfo
     {
-        $attributes = [];
-        $attributes[ResourceAttributes::PROCESS_PID] = getmypid();
-        $attributes[ResourceAttributes::PROCESS_EXECUTABLE_PATH] = PHP_BINARY;
+        $attributes = [
+            ResourceAttributes::PROCESS_RUNTIME_NAME => php_sapi_name(),
+            ResourceAttributes::PROCESS_RUNTIME_VERSION => PHP_VERSION,
+            ResourceAttributes::PROCESS_PID => getmypid(),
+            ResourceAttributes::PROCESS_EXECUTABLE_PATH => PHP_BINARY,
+        ];
+
         /**
          * @psalm-suppress PossiblyUndefinedArrayOffset
          */

Resource/Detectors/ProcessRuntime.php

@@ -4,25 +4,16 @@
 
 namespace OpenTelemetry\SDK\Resource\Detectors;
 
-use OpenTelemetry\SDK\Common\Attribute\Attributes;
 use OpenTelemetry\SDK\Resource\ResourceDetectorInterface;
 use OpenTelemetry\SDK\Resource\ResourceInfo;
-use OpenTelemetry\SemConv\ResourceAttributes;
-use function php_sapi_name;
-use const PHP_VERSION;
 
 /**
- * @see https://github.com/open-telemetry/opentelemetry-specification/blob/v1.8.0/specification/resource/semantic_conventions/process.md#process-runtimes
+ * @deprecated Use Process detector instead.
  */
 final class ProcessRuntime implements ResourceDetectorInterface
 {
     public function getResource(): ResourceInfo
     {
-        $attributes = [
-            ResourceAttributes::PROCESS_RUNTIME_NAME => php_sapi_name(),
-            ResourceAttributes::PROCESS_RUNTIME_VERSION => PHP_VERSION,
-        ];
-
-        return ResourceInfo::create(Attributes::create($attributes), ResourceAttributes::SCHEMA_URL);
+        return ResourceInfo::emptyResource();
     }
 }

Resource/Detectors/Sdk.php

@@ -12,7 +12,8 @@
 use OpenTelemetry\SemConv\ResourceAttributes;
 
 /**
- * @see https://github.com/open-telemetry/opentelemetry-specification/blob/v1.8.0/specification/resource/semantic_conventions/README.md#telemetry-sdk
+ * The SDK MUST provide access to a Resource with at least the attributes listed
+ * at {@see https://github.com/open-telemetry/semantic-conventions/blob/v1.32.0/docs/resource/README.md#semantic-attributes-with-sdk-provided-default-value}
  */
 final class Sdk implements ResourceDetectorInterface
 {

Resource/Detectors/SdkProvided.php

@@ -4,22 +4,16 @@
 
 namespace OpenTelemetry\SDK\Resource\Detectors;
 
-use OpenTelemetry\SDK\Common\Attribute\Attributes;
 use OpenTelemetry\SDK\Resource\ResourceDetectorInterface;
 use OpenTelemetry\SDK\Resource\ResourceInfo;
-use OpenTelemetry\SemConv\ResourceAttributes;
 
 /**
- * @see https://github.com/open-telemetry/semantic-conventions/blob/main/docs/resource/README.md#semantic-attributes-with-sdk-provided-default-value
+ * @deprecated Use Service detector instead.
  */
 final class SdkProvided implements ResourceDetectorInterface
 {
     public function getResource(): ResourceInfo
     {
-        $attributes = [
-            ResourceAttributes::SERVICE_NAME => 'unknown_service:php',
-        ];
-
-        return ResourceInfo::create(Attributes::create($attributes), ResourceAttributes::SCHEMA_URL);
+        return ResourceInfo::emptyResource();
     }
 }

Resource/Detectors/Service.php

@@ -5,6 +5,8 @@
 namespace OpenTelemetry\SDK\Resource\Detectors;
 
 use OpenTelemetry\SDK\Common\Attribute\Attributes;
+use OpenTelemetry\SDK\Common\Configuration\Configuration;
+use OpenTelemetry\SDK\Common\Configuration\Variables;
 use OpenTelemetry\SDK\Resource\ResourceDetectorInterface;
 use OpenTelemetry\SDK\Resource\ResourceInfo;
 use OpenTelemetry\SemConv\ResourceAttributes;
@@ -19,10 +21,16 @@ public function getResource(): ResourceInfo
     {
         static $serviceInstanceId;
         $serviceInstanceId ??= Uuid::uuid4()->toString();
+        $serviceName = Configuration::has(Variables::OTEL_SERVICE_NAME)
+            ? Configuration::getString(Variables::OTEL_SERVICE_NAME)
+            : null;
 
         $attributes = [
             ResourceAttributes::SERVICE_INSTANCE_ID => $serviceInstanceId,
         ];
+        if ($serviceName !== null) {
+            $attributes[ResourceAttributes::SERVICE_NAME] = $serviceName;
+        }
 
         return ResourceInfo::create(Attributes::create($attributes), ResourceAttributes::SCHEMA_URL);
     }