allow to set custom service instance id

README.md

@@ -37,6 +37,13 @@ return [
      */
     'service_name' => env(Variables::OTEL_SERVICE_NAME, \Illuminate\Support\Str::slug((string) env('APP_NAME', 'laravel-app'))),
 
+    /**
+     * Service instance id
+     * Should be unique for each instance of your service.
+     * If not set, a random id will be generated on each request.
+     */
+    'service_instance_id' => env('OTEL_SERVICE_INSTANCE_ID'),
+
     /**
      * Comma separated list of propagators to use.
      * Supports any otel propagator, for example: "tracecontext", "baggage", "b3", "b3multi", "none"

config/opentelemetry.php

@@ -9,6 +9,13 @@
      */
     'service_name' => env(Variables::OTEL_SERVICE_NAME, \Illuminate\Support\Str::slug((string) env('APP_NAME', 'laravel-app'))),
 
+    /**
+     * Service instance id
+     * Should be unique for each instance of your service.
+     * If not set, a random id will be generated on each request.
+     */
+    'service_instance_id' => env('OTEL_SERVICE_INSTANCE_ID'),
+
     /**
      * Comma separated list of propagators to use.
      * Supports any otel propagator, for example: "tracecontext", "baggage", "b3", "b3multi", "none"

phpstan-baseline.neon

@@ -2,9 +2,18 @@ parameters:
 	ignoreErrors:
 		-
 			message: '''
-				#^Fetching class constant SCHEMA_URL of deprecated interface OpenTelemetry\\SemConv\\TraceAttributes\:
+				#^Fetching class constant SCHEMA_URL of deprecated interface OpenTelemetry\\SemConv\\ResourceAttributes\:
 				Use \{@see OpenTelemetry\\SemConv\\Attributes\}\\\* or \{@see OpenTelemetry\\SemConv\\Unstable\\Attributes\}\\\* instead\.$#
 			'''
 			identifier: classConstant.deprecatedInterface
 			count: 1
 			path: src/LaravelOpenTelemetryServiceProvider.php
+
+		-
+			message: '''
+				#^Fetching class constant SERVICE_INSTANCE_ID of deprecated interface OpenTelemetry\\SemConv\\ResourceAttributes\:
+				Use \{@see OpenTelemetry\\SemConv\\Attributes\}\\\* or \{@see OpenTelemetry\\SemConv\\Unstable\\Attributes\}\\\* instead\.$#
+			'''
+			identifier: classConstant.deprecatedInterface
+			count: 1
+			path: src/Support/ResourceBuilder.php

phpstan.neon

@@ -1,3 +1,6 @@
+includes:
+    - ./phpstan-baseline.neon
+
 parameters:
     level: 8
     paths:

src/LaravelOpenTelemetryServiceProvider.php

@@ -16,6 +16,7 @@
 use Keepsuit\LaravelOpenTelemetry\Support\CarbonClock;
 use Keepsuit\LaravelOpenTelemetry\Support\OpenTelemetryMonologHandler;
 use Keepsuit\LaravelOpenTelemetry\Support\PropagatorBuilder;
+use Keepsuit\LaravelOpenTelemetry\Support\ResourceBuilder;
 use Keepsuit\LaravelOpenTelemetry\Support\SamplerBuilder;
 use OpenTelemetry\API\Common\Time\Clock;
 use OpenTelemetry\API\Instrumentation\CachedInstrumentation;
@@ -33,7 +34,6 @@
 use OpenTelemetry\Contrib\Otlp\OtlpUtil;
 use OpenTelemetry\Contrib\Otlp\SpanExporter as OtlpSpanExporter;
 use OpenTelemetry\Contrib\Zipkin\Exporter as ZipkinExporter;
-use OpenTelemetry\SDK\Common\Attribute\Attributes;
 use OpenTelemetry\SDK\Common\Configuration\Parser\MapParser;
 use OpenTelemetry\SDK\Common\Configuration\Variables as OTELVariables;
 use OpenTelemetry\SDK\Common\Export\Http\PsrTransportFactory;
@@ -49,16 +49,13 @@
 use OpenTelemetry\SDK\Metrics\MetricExporterInterface;
 use OpenTelemetry\SDK\Metrics\MetricReader\ExportingReader;
 use OpenTelemetry\SDK\Metrics\MetricReaderInterface;
-use OpenTelemetry\SDK\Resource\ResourceInfo;
-use OpenTelemetry\SDK\Resource\ResourceInfoFactory;
 use OpenTelemetry\SDK\Sdk;
 use OpenTelemetry\SDK\Trace\SpanExporter\ConsoleSpanExporterFactory;
 use OpenTelemetry\SDK\Trace\SpanExporter\InMemorySpanExporterFactory;
 use OpenTelemetry\SDK\Trace\SpanExporterInterface;
 use OpenTelemetry\SDK\Trace\SpanProcessor\BatchSpanProcessorBuilder;
 use OpenTelemetry\SDK\Trace\TracerProvider;
-use OpenTelemetry\SemConv\Attributes\ServiceAttributes;
-use OpenTelemetry\SemConv\TraceAttributes;
+use OpenTelemetry\SemConv\ResourceAttributes;
 use Spatie\LaravelPackageTools\Package;
 use Spatie\LaravelPackageTools\PackageServiceProvider;
 use Throwable;
@@ -88,11 +85,7 @@ protected function init(): void
     {
         Clock::setDefault(new CarbonClock);
 
-        $resource = ResourceInfoFactory::defaultResource()->merge(
-            ResourceInfo::create(Attributes::create([
-                ServiceAttributes::SERVICE_NAME => config('opentelemetry.service_name'),
-            ]))
-        );
+        $resource = ResourceBuilder::build();
 
         $propagator = PropagatorBuilder::new()->build(config('opentelemetry.propagators'));
         $this->app->bind(TextMapPropagatorInterface::class, fn () => $propagator);
@@ -156,8 +149,7 @@ protected function init(): void
         $instrumentation = new CachedInstrumentation(
             name: 'laravel-opentelemetry',
             version: class_exists(InstalledVersions::class) ? InstalledVersions::getPrettyVersion('keepsuit/laravel-opentelemetry') : null,
-            // @phpstan-ignore-next-line
-            schemaUrl: TraceAttributes::SCHEMA_URL,
+            schemaUrl: ResourceAttributes::SCHEMA_URL,
         );
 
         $this->app->bind(MeterInterface::class, fn () => $instrumentation->meter());

src/Support/ResourceBuilder.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace Keepsuit\LaravelOpenTelemetry\Support;
+
+use OpenTelemetry\SDK\Common\Attribute\Attributes;
+use OpenTelemetry\SDK\Resource\ResourceInfo;
+use OpenTelemetry\SDK\Resource\ResourceInfoFactory;
+use OpenTelemetry\SemConv\Attributes\ServiceAttributes;
+use OpenTelemetry\SemConv\ResourceAttributes;
+
+/**
+ * @internal
+ */
+class ResourceBuilder
+{
+    public static function build(): ResourceInfo
+    {
+        return ResourceInfoFactory::defaultResource()->merge(
+            ResourceInfo::create(Attributes::create([
+                ServiceAttributes::SERVICE_NAME => config('opentelemetry.service_name'),
+                ResourceAttributes::SERVICE_INSTANCE_ID => config('opentelemetry.service_instance_id'),
+            ]))
+        );
+    }
+}

tests/Sdk/ServiceTest.php

@@ -0,0 +1,20 @@
+<?php
+
+use Keepsuit\LaravelOpenTelemetry\Support\ResourceBuilder;
+
+test('service resource attributes', function () {
+    $resource = ResourceBuilder::build();
+
+    expect($resource->getAttributes())
+        ->get('service.name')->toBe('laravel-app')
+        ->get('service.instance.id')->toBeUuid();
+});
+
+test('custom instance id', function () {
+    config()->set('opentelemetry.service_instance_id', 'custom-id-1234');
+
+    $resource = ResourceBuilder::build();
+
+    expect($resource->getAttributes())
+        ->get('service.instance.id')->toBe('custom-id-1234');
+});