File configuration

.gitsplit.yml

@@ -16,6 +16,8 @@ splits:
     target: "https://${GH_TOKEN}@github.com/opentelemetry-php/api.git"
   - prefix: "src/SDK"
     target: "https://${GH_TOKEN}@github.com/opentelemetry-php/sdk.git"
+  - prefix: "src/Config/SDK"
+    target: "https://${GH_TOKEN}@github.com/opentelemetry-php/config-sdk.git"
   - prefix: "src/Contrib/Otlp"
     target: "https://${GH_TOKEN}@github.com/opentelemetry-php/exporter-otlp.git"
   - prefix: "src/Contrib/Grpc"

.phan/config.php

@@ -319,6 +319,7 @@
     'exclude_analysis_directory_list' => [
         'vendor/',
         'proto/',
+        'src/Config/SDK',
     ],
 
     // Enable this to enable checks of require/include statements referring to valid paths.

composer.json

@@ -16,14 +16,17 @@
         "psr/http-message": "^1.0.1|^2.0",
         "psr/log": "^1.1|^2.0|^3.0",
         "symfony/polyfill-mbstring": "^1.23",
-        "symfony/polyfill-php82": "^1.26"
+        "symfony/polyfill-php82": "^1.26",
+        "tbachert/otel-sdk-configuration": "^0.1",
+        "tbachert/spi": "^0.2"
     },
     "config": {
         "sort-packages": true,
         "allow-plugins": {
             "composer/package-versions-deprecated": true,
             "php-http/discovery": true,
-            "symfony/runtime": true
+            "symfony/runtime": true,
+            "tbachert/spi": true
         }
     },
     "authors": [
@@ -33,12 +36,17 @@
         }
     ],
     "replace": {
-        "open-telemetry/api": "self.version",
-        "open-telemetry/context": "self.version",
-        "open-telemetry/gen-otlp-protobuf": "self.version",
-        "open-telemetry/sdk": "self.version",
-        "open-telemetry/sdk-contrib": "self.version",
-        "open-telemetry/sem-conv": "self.version"
+        "open-telemetry/api": "1.0.x-dev",
+        "open-telemetry/context": "1.0.x-dev",
+        "open-telemetry/exporter-otlp": "1.0.x-dev",
+        "open-telemetry/exporter-zipkin": "1.0.x-dev",
+        "open-telemetry/extension-propagator-b3": "1.0.x-dev",
+        "open-telemetry/extension-propagator-jaeger": "0.0.2",
+        "open-telemetry/gen-otlp-protobuf": "1.0.x-dev",
+        "open-telemetry/sdk": "1.0.x-dev",
+        "open-telemetry/sdk-configuration": "0.1.x-dev",
+        "open-telemetry/sdk-contrib": "1.0.x-dev",
+        "open-telemetry/sem-conv": "1.0.x-dev"
     },
     "autoload": {
         "psr-4": {
@@ -108,5 +116,37 @@
         "ext-gmp": "To support unlimited number of synchronous metric readers",
         "ext-grpc": "To use the OTLP GRPC Exporter",
         "ext-protobuf": "For more performant protobuf/grpc exporting"
+    },
+    "extra": {
+        "spi": {
+            "Nevay\\OTelSDK\\Configuration\\ComponentProvider": [
+                "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Propagator\\TextMapPropagatorB3",
+                "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Propagator\\TextMapPropagatorB3Multi",
+                "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Propagator\\TextMapPropagatorBaggage",
+                "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Propagator\\TextMapPropagatorComposite",
+                "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Propagator\\TextMapPropagatorJaeger",
+                "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Propagator\\TextMapPropagatorTraceContext",
+
+                "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Trace\\SamplerAlwaysOff",
+                "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Trace\\SamplerAlwaysOn",
+                "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Trace\\SamplerParentBased",
+                "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Trace\\SamplerTraceIdRatioBased",
+                "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Trace\\SpanExporterConsole",
+                "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Trace\\SpanExporterOtlp",
+                "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Trace\\SpanExporterZipkin",
+                "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Trace\\SpanProcessorBatch",
+                "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Trace\\SpanProcessorSimple",
+
+                "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Metrics\\AggregationResolverDefault",
+                "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Metrics\\MetricExporterConsole",
+                "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Metrics\\MetricExporterOtlp",
+                "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Metrics\\MetricReaderPeriodic",
+
+                "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Logs\\LogRecordExporterConsole",
+                "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Logs\\LogRecordExporterOtlp",
+                "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Logs\\LogRecordProcessorBatch",
+                "OpenTelemetry\\Config\\SDK\\ComponentProvider\\Logs\\LogRecordProcessorSimple"
+            ]
+        }
     }
 }

examples/load_config.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+use OpenTelemetry\API\Logs\EventLogger;
+use OpenTelemetry\API\Logs\LogRecord;
+use OpenTelemetry\Config\SDK\Configuration;
+
+require __DIR__ . '/../vendor/autoload.php';
+
+echo 'load config SDK example starting...' . PHP_EOL;
+
+$config = Configuration::parseFile(__DIR__ . '/load_config.yaml');
+$sdk = $config
+    ->create()
+    ->setAutoShutdown(true)
+    ->build();
+
+$tracer = $sdk->getTracerProvider()->getTracer('demo');
+$meter = $sdk->getMeterProvider()->getMeter('demo');
+$logger = $sdk->getLoggerProvider()->getLogger('demo');
+
+$tracer->spanBuilder('root')->startSpan()->end();
+$meter->createCounter('cnt')->add(1);
+
+$eventLogger = new EventLogger($logger, 'my-domain');
+$eventLogger->logEvent('foo', new LogRecord('hello, otel'));
+
+echo 'Finished!' . PHP_EOL;

examples/load_config.yaml

@@ -0,0 +1,44 @@
+file_format: '0.1'
+
+resource:
+  attributes:
+    service.name: opentelemetry-demo
+
+propagators:
+  composite: [ tracecontext, baggage ]
+
+exporters:
+  otlp: &otlp-exporter
+    protocol: http/protobuf
+    endpoint: http://collector:4318
+
+tracer_provider:
+  sampler:
+    parent_based:
+      root:
+        always_on: {}
+  processors:
+    - simple:
+        exporter:
+          console: {}
+    - batch:
+        exporter:
+          otlp: *otlp-exporter
+meter_provider:
+  readers:
+    - periodic:
+        exporter:
+          console: {}
+    - periodic:
+        exporter:
+          otlp:
+            <<: *otlp-exporter
+            temporality_preference: lowmemory
+logger_provider:
+  processors:
+    - simple:
+        exporter:
+          console: {}
+    - batch:
+        exporter:
+          otlp: *otlp-exporter

examples/load_config_env.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+use OpenTelemetry\API\Logs\EventLogger;
+use OpenTelemetry\API\Logs\LogRecord;
+use OpenTelemetry\Config\SDK\Configuration;
+
+require __DIR__ . '/../vendor/autoload.php';
+
+echo 'load config SDK example starting...' . PHP_EOL;
+
+$_SERVER['OTEL_SERVICE_NAME'] = 'opentelemetry-demo';
+$_SERVER['OTEL_EXPORTER_OTLP_PROTOCOL'] = 'http/protobuf';
+$_SERVER['OTEL_EXPORTER_OTLP_ENDPOINT'] = 'http://collector:4318';
+$_SERVER['OTEL_TRACES_SAMPLER_ARG'] = '0.5';
+
+$config = Configuration::parseFile(__DIR__ . '/load_config_env.yaml');
+$sdk = $config
+    ->create()
+    ->setAutoShutdown(true)
+    ->build();
+
+$tracer = $sdk->getTracerProvider()->getTracer('demo');
+$meter = $sdk->getMeterProvider()->getMeter('demo');
+$logger = $sdk->getLoggerProvider()->getLogger('demo');
+
+$tracer->spanBuilder('root')->startSpan()->end();
+$meter->createCounter('cnt')->add(1);
+
+$eventLogger = new EventLogger($logger, 'my-domain');
+$eventLogger->logEvent('foo', new LogRecord('hello, otel'));
+
+echo 'Finished!' . PHP_EOL;

examples/load_config_env.yaml

@@ -0,0 +1,49 @@
+file_format: '0.1'
+
+disabled: ${OTEL_SDK_DISABLED}
+
+resource:
+  attributes:
+    service.name: ${OTEL_SERVICE_NAME}
+
+propagators:
+  composite: [ tracecontext, baggage ]
+
+attribute_limits:
+  attribute_value_length_limit: ${OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT}
+  attribute_count_limit: ${OTEL_ATTRIBUTE_COUNT_LIMIT}
+
+exporters:
+  otlp: &otlp-exporter
+    protocol: ${OTEL_EXPORTER_OTLP_PROTOCOL}
+    endpoint: ${OTEL_EXPORTER_OTLP_ENDPOINT}
+    certificate: ${OTEL_EXPORTER_OTLP_CERTIFICATE}
+    client_key: ${OTEL_EXPORTER_OTLP_CLIENT_KEY}
+    client_certificate: ${OTEL_EXPORTER_OTLP_CLIENT_CERTIFICATE}
+    compression: ${OTEL_EXPORTER_OTLP_COMPRESSION}
+    timeout: ${OTEL_EXPORTER_OTLP_TIMEOUT}
+
+tracer_provider:
+  sampler:
+    parent_based:
+      root:
+        trace_id_ratio_based:
+          ratio: ${OTEL_TRACES_SAMPLER_ARG}
+  limits:
+    attribute_value_length_limit: ${OTEL_SPAN_ATTRIBUTE_VALUE_LENGTH_LIMIT}
+    attribute_count_limit: ${OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT}
+    event_count_limit: ${OTEL_SPAN_EVENT_COUNT_LIMIT}
+    link_count_limit: ${OTEL_SPAN_LINK_COUNT_LIMIT}
+    event_attribute_count_limit: ${OTEL_EVENT_ATTRIBUTE_COUNT_LIMIT}
+    link_attribute_count_limit: ${OTEL_LINK_ATTRIBUTE_COUNT_LIMIT}
+  processors:
+    - simple:
+        exporter:
+          console: {}
+    - batch:
+        schedule_delay: ${OTEL_BSP_SCHEDULE_DELAY}
+        export_timeout: ${OTEL_BSP_EXPORT_TIMEOUT}
+        max_queue_size: ${OTEL_BSP_MAX_QUEUE_SIZE}
+        max_export_batch_size: ${OTEL_BSP_MAX_EXPORT_BATCH_SIZE}
+        exporter:
+          otlp: *otlp-exporter

phpstan.neon.dist

@@ -32,4 +32,8 @@ parameters:
         -
             message: "#Call to an undefined method .*:expects.*#"
             paths:
-                - tests
+                - tests
+        -
+            message: "#Call to an undefined method Symfony\\\\Component\\\\Config\\\\Definition\\\\Builder\\\\NodeParentInterface::.*#"
+            paths:
+                - src/Config/SDK

psalm.xml.dist

@@ -23,13 +23,33 @@
     <issueHandlers>
         <UndefinedClass>
             <errorLevel type="suppress">
-              <referencedClass name="GMP" />
+                <referencedClass name="GMP"/>
             </errorLevel>
-          </UndefinedClass>
-          <ArgumentTypeCoercion>
+        </UndefinedClass>
+        <ArgumentTypeCoercion>
             <errorLevel type="suppress">
-              <directory name="./examples" />
+                <directory name="./examples"/>
             </errorLevel>
-          </ArgumentTypeCoercion>
+        </ArgumentTypeCoercion>
+        <UndefinedInterfaceMethod>
+            <errorLevel type="suppress">
+                <directory name="src/Config/SDK/ComponentProvider"/>
+            </errorLevel>
+        </UndefinedInterfaceMethod>
+        <PossiblyNullReference>
+            <errorLevel type="suppress">
+                <directory name="src/Config/SDK/ComponentProvider"/>
+            </errorLevel>
+        </PossiblyNullReference>
+        <MoreSpecificImplementedParamType>
+            <errorLevel type="suppress">
+                <directory name="src/Config/SDK/ComponentProvider"/>
+            </errorLevel>
+        </MoreSpecificImplementedParamType>
+        <InvalidDocblock>
+            <errorLevel type="suppress">
+                <directory name="src/Config/SDK/ComponentProvider"/>
+            </errorLevel>
+        </InvalidDocblock>
     </issueHandlers>
 </psalm>

src/Config/SDK/ComponentProvider/Logs/LogRecordExporterConsole.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenTelemetry\Config\SDK\ComponentProvider\Logs;
+
+use Nevay\OTelSDK\Configuration\ComponentProvider;
+use Nevay\OTelSDK\Configuration\ComponentProviderRegistry;
+use Nevay\OTelSDK\Configuration\Context;
+use OpenTelemetry\SDK\Logs\Exporter\ConsoleExporter;
+use OpenTelemetry\SDK\Logs\LogRecordExporterInterface;
+use OpenTelemetry\SDK\Registry;
+use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
+
+/**
+ * @implements ComponentProvider<LogRecordExporterInterface>
+ */
+final class LogRecordExporterConsole implements ComponentProvider
+{
+
+    /**
+     * @param array{} $properties
+     */
+    public function createPlugin(array $properties, Context $context): LogRecordExporterInterface
+    {
+        return new ConsoleExporter(Registry::transportFactory('stream')->create(
+            endpoint: 'php://stdout',
+            contentType: 'application/json',
+        ));
+    }
+
+    public function getConfig(ComponentProviderRegistry $registry): ArrayNodeDefinition
+    {
+        return new ArrayNodeDefinition('console');
+    }
+}