Updated Readme and composer.json

Author: HeenaBansal20

src/Exporter/Instana/README.md

@@ -1,64 +1,76 @@
-OpenTelemetry Instana Propagator
+[![Releases](https://img.shields.io/badge/releases-purple)](https://github.com/opentelemetry-php/contrib-instana-exporter/releases)
+[![Issues](https://img.shields.io/badge/issues-pink)](https://www.ibm.com/support/pages/instana-support)
+[![Source](https://img.shields.io/badge/source-contrib-green)](https://github.com/open-telemetry/opentelemetry-php-contrib/tree/main/src/Exporter/Instana)
+[![Mirror](https://img.shields.io/badge/mirror-opentelemetry--php--contrib-blue)](https://github.com/opentelemetry-php/contrib-instana-exporter)
+[![Latest Version](http://poser.pugx.org/open-telemetry/opentelemetry-instana-exporter/v/unstable)](https://packagist.org/packages/open-telemetry/opentelemetry-instana-exporter/)
+[![Stable](http://poser.pugx.org/open-telemetry/opentelemetry-instana-exporter/v/stable)](https://packagist.org/packages/open-telemetry/opentelemetry-instana-exporter/)
 
-The OpenTelemetry Propagator for Instana provides HTTP header propagation for systems that are using IBM Observability by Instana.
-This propagator translates the Instana trace correlation headers (`X-INSTANA-T/X-INSTANA-S/X-INSTANA-L`) into the OpenTelemetry `SpanContext`, and vice versa.
-It does not handle `TraceState`.
+This is a read-only subtree split of https://github.com/open-telemetry/opentelemetry-php-contrib.
 
+# Instana OpenTelemetry PHP Exporter
 
-## Installation
+Instana exporter for OpenTelemetry.
 
-```sh
-composer require open-telemetry/opentelemetry-propagation-instana
-```
-
-## Usage
+## Documentation
 
-```
-$propagator = InstanaMultiPropagator::getInstance();
-```
+https://www.ibm.com/docs/en/instana-observability/current?topic=php-opentelemetry-exporter
 
-Both of the above have extract and inject methods available to extract and inject respectively into the header.
+## Installing via Composer
 
-## Propagator Details
+Install Composer in a common location or in your project
 
-There are three headers that the propagator handles: `X-INSTANA-T` (the trace ID), `X-INSTANA-S` (the parent span ID), and `X-INSTANA-L` (the sampling level).
+```bash
+curl -s https://getcomposer.org/installer | php
+```
 
-Example header triplet:
+Install via Composer
 
-* `X-INSTANA-T: 80f198ee56343ba864fe8b2a57d3eff7`,
-* `X-INSTANA-S: e457b5a2e4d86bd1`,
-* `X-INSTANA-L: 1`.
+```bash
+composer require instana/contrib-instana-exporter
+```
 
-A short summary for each of the headers is provided below. More details are available at <https://www.ibm.com/docs/en/obi/current?topic=monitoring-traces#tracing-headers>.
+## Usage
 
-### X-INSTANA-T -- trace ID
 
-* A string of either 16 or 32 characters from the alphabet `0-9a-f`, representing either a 64 bit or 128 bit ID.
-* This header corresponds to the [OpenTelemetry TraceId](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/overview.md#spancontext).
-* If the propagator receives an X-INSTANA-T header value that is shorter than 32 characters when _extracting_ headers into the OpenTelemetry span context, it will left-pad the string with the character "0" to length 32.
-* No length transformation is applied when _injecting_ the span context into headers.
+Utilizing the OpenTelemetry PHP SDK, we can send spans natively to Instana, by providing an OpenTelemetry span processor our `SpanExporterInterface`.
 
-### X-INSTANA-S -- parent span ID
+This can be manually constructed, or created from the `SpanExporterFactory`. See the factory implementation for how to manually construct the `SpanExporter`. The factory reads from two environment variables which can be set according, else will fallback onto the following defaults
 
-* Format: A string of 16 characters from the alphabet `0-9a-f`, representing a 64 bit ID.
-* This header corresponds to the [OpenTelemetry SpanId](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/overview.md#spancontext).
+```bash
+INSTANA_AGENT_HOST=127.0.0.1
+INSTANA_AGENT_PORT=42699
+```
 
-### X-INSTANA-L - sampling level
+The service name that is visible in the Instana UI can be configured with the following environment variables. OpenTelemetry provides `OTEL_SERVICE_NAME` (see documentation [here](https://opentelemetry.io/docs/languages/sdk-configuration/general/#otel_service_name)) as a way to customize this within the SDK. We also provide `INSTANA_SERVICE_NAME` which will be taken as the highest precedence.
 
-* The only two valid values are `1` and `0`.
-* A level of `1` means that this request is to be sampled, a level of `0` means that the request should not be sampled.
-* This header corresponds to the sampling bit of the [OpenTelemetry TraceFlags](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/overview.md#spancontext).
+```bash
+INSTANA_SERVICE_NAME=custom-service-name
+```
 
-## Useful links
+## Example
 
-* For more information on Instana, visit <https://www.instana.com/> and [Instana' documentation](https://www.ibm.com/docs/en/obi/current).
-* For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
+```php
+use OpenTelemetry\SDK\Trace\SpanProcessor\SimpleSpanProcessor;
+use OpenTelemetry\SDK\Trace\TracerProvider;
 
-## Installing dependencies and executing tests
+$tracerProvider = new TracerProvider(
+    new SimpleSpanProcessor(
+        Registry::spanExporterFactory("instana")->create()
+    )
+);
+$tracer = $tracerProvider->getTracer('io.instana.opentelemetry.php');
 
-From Instana subdirectory:
+$span = $tracer->spanBuilder('root')->startSpan();
+$span->setAttribute('remote_ip', '1.2.3.4')
+    ->setAttribute('country', 'CAN');
+$span->addEvent('generated_session', [
+    'id' => md5((string) microtime(true)),
+]);
+$span->end();
 
-``` sh
-$ composer install
-$ ./vendor/bin/phpunit tests
+$tracerProvider->shutdown();
 ```
+
+## Contributions
+
+This repo is maintained by IBM Instana and is read-only. Issues and other contributions should be reported as part of standard [Instana product support](https://www.ibm.com/support/pages/instana-support).

src/Exporter/Instana/composer.json

@@ -11,17 +11,10 @@
     ],
     "type": "library",
     "support": {
-        "issues": "https://github.com/instana/opentelemetry-php-exporter/issues",
-        "source": "https://github.com/instana/opentelemetry-php-exporter",
+        "issues": "https://www.ibm.com/support/pages/instana-support",
+        "source": "https://github.com/open-telemetry/opentelemetry-php-contrib/main/src/Exporter/Instana",
         "docs": "https://www.ibm.com/docs/en/instana-observability/current?topic=opentelemetry-php-exporter"
     },
-    "license": "Apache-2.0",
-    "authors": [
-        {
-            "name": "Instana contributors",
-            "homepage": "https://github.com/instana/opentelemetry-php-exporter/graphs/contributors"
-        }
-    ],
     "require": {
         "php": "^8.1",
         "open-telemetry/api": "^1.1",

src/Exporter/Instana/src/InstanaTransport.php

@@ -35,14 +35,18 @@ class InstanaTransport implements TransportInterface
     private Client $client;
     private ?string $agent_uuid = null;
     private ?int $pid = null;
+    
+    // @phpstan-ignore property.onlyWritten
     private array $secrets = [];
+    // @phpstan-ignore property.onlyWritten
     private array $tracing = [];
 
     private bool $closed = true;
     private array $headers = [];
 
     public function __construct(
         private readonly string $endpoint,
+        // @phpstan-ignore property.onlyWritten
         private readonly float $timeout = 0.0
     ) {
         $this->headers += ['Content-Type' => self::CONTENT_TYPE];

src/Exporter/Instana/src/SpanConverter.php

@@ -157,6 +157,7 @@ private function convertSpan(SpanDataInterface $span): array
                     !in_array($matches[2], $extraResponseHeaders);
             }, ARRAY_FILTER_USE_KEY);
 
+            // @phpstan-ignore-next-line
             foreach ($keys as $k => $_v) {
                 unset($instanaSpan['data']['sdk']['custom']['tags']['attributes'][$k]);
             }