diff --git a/.github/workflows/php.yml b/.github/workflows/php.yml index 601a3f5d0..8673a2b46 100644 --- a/.github/workflows/php.yml +++ b/.github/workflows/php.yml @@ -47,6 +47,7 @@ jobs: 'Instrumentation/Symfony', 'Instrumentation/Yii', 'Logs/Monolog', + 'Propagation/Instana', 'Propagation/ServerTiming', 'Propagation/TraceResponse', 'ResourceDetectors/Azure', diff --git a/.gitsplit.yml b/.gitsplit.yml index 072982784..1fecd3e90 100644 --- a/.gitsplit.yml +++ b/.gitsplit.yml @@ -66,6 +66,8 @@ splits: target: "https://${GH_TOKEN}@github.com/opentelemetry-php/contrib-instrumentation-installer.git" - prefix: "src/Logs/Monolog" target: "https://${GH_TOKEN}@github.com/opentelemetry-php/contrib-logger-monolog.git" + - prefix: "src/Propagation/Instana" + target: "https://${GH_TOKEN}@github.com/opentelemetry-php/contrib-propagator-instana.git" - prefix: "src/Propagation/ServerTiming" target: "https://${GH_TOKEN}@github.com/opentelemetry-php/contrib-propagator-server-timing.git" - prefix: "src/Propagation/TraceResponse" diff --git a/composer.json b/composer.json index 363615182..7de6fc64d 100644 --- a/composer.json +++ b/composer.json @@ -34,6 +34,7 @@ "OpenTelemetry\\Contrib\\Instrumentation\\Wordpress\\": "src/Instrumentation/Wordpress/src", "OpenTelemetry\\Contrib\\Instrumentation\\CakePHP\\": "src/Instrumentation/CakePHP/src", "OpenTelemetry\\Contrib\\Logs\\Monolog\\": "src/Logs/Monolog/src", + "OpenTelemetry\\Contrib\\Propagation\\Instana\\": "src/Propagation/Instana/src", "OpenTelemetry\\Contrib\\Propagation\\ServerTiming\\": "src/Propagation/ServerTiming/src", "OpenTelemetry\\Contrib\\Propagation\\TraceResponse\\": "src/Propagation/TraceResponse/src", "OpenTelemetry\\Contrib\\Resource\\Detector\\Container\\": "src/ResourceDetectors/Container/src", @@ -82,6 +83,7 @@ "open-telemetry/opentelemetry-auto-slim": "self.version", "open-telemetry/opentelemetry-auto-symfony": "self.version", "open-telemetry/opentelemetry-auto-wordpress": "self.version", + "open-telemetry/opentelemetry-propagation-instana": "self.version", "open-telemetry/opentelemetry-propagation-server-timing": "self.version", "open-telemetry/opentelemetry-propagation-traceresponse": "self.version", "open-telemetry/opentelemetry-logger-monolog": "self.version", diff --git a/src/Propagation/Instana/.gitattributes b/src/Propagation/Instana/.gitattributes new file mode 100644 index 000000000..1676cf825 --- /dev/null +++ b/src/Propagation/Instana/.gitattributes @@ -0,0 +1,12 @@ +* text=auto + +*.md diff=markdown +*.php diff=php + +/.gitattributes export-ignore +/.gitignore export-ignore +/.php-cs-fixer.php export-ignore +/phpstan.neon.dist export-ignore +/phpunit.xml.dist export-ignore +/psalm.xml.dist export-ignore +/tests export-ignore diff --git a/src/Propagation/Instana/.gitignore b/src/Propagation/Instana/.gitignore new file mode 100644 index 000000000..57872d0f1 --- /dev/null +++ b/src/Propagation/Instana/.gitignore @@ -0,0 +1 @@ +/vendor/ diff --git a/src/Propagation/Instana/.phan/config.php b/src/Propagation/Instana/.phan/config.php new file mode 100644 index 000000000..da2ac2d99 --- /dev/null +++ b/src/Propagation/Instana/.phan/config.php @@ -0,0 +1,371 @@ + '8.0', + + // If enabled, missing properties will be created when + // they are first seen. If false, we'll report an + // error message if there is an attempt to write + // to a class property that wasn't explicitly + // defined. + 'allow_missing_properties' => false, + + // If enabled, null can be cast to any type and any + // type can be cast to null. Setting this to true + // will cut down on false positives. + 'null_casts_as_any_type' => false, + + // If enabled, allow null to be cast as any array-like type. + // + // This is an incremental step in migrating away from `null_casts_as_any_type`. + // If `null_casts_as_any_type` is true, this has no effect. + 'null_casts_as_array' => true, + + // If enabled, allow any array-like type to be cast to null. + // This is an incremental step in migrating away from `null_casts_as_any_type`. + // If `null_casts_as_any_type` is true, this has no effect. + 'array_casts_as_null' => true, + + // If enabled, scalars (int, float, bool, string, null) + // are treated as if they can cast to each other. + // This does not affect checks of array keys. See `scalar_array_key_cast`. + 'scalar_implicit_cast' => false, + + // If enabled, any scalar array keys (int, string) + // are treated as if they can cast to each other. + // E.g. `array` can cast to `array` and vice versa. + // Normally, a scalar type such as int could only cast to/from int and mixed. + 'scalar_array_key_cast' => true, + + // If this has entries, scalars (int, float, bool, string, null) + // are allowed to perform the casts listed. + // + // E.g. `['int' => ['float', 'string'], 'float' => ['int'], 'string' => ['int'], 'null' => ['string']]` + // allows casting null to a string, but not vice versa. + // (subset of `scalar_implicit_cast`) + 'scalar_implicit_partial' => [], + + // If enabled, Phan will warn if **any** type in a method invocation's object + // is definitely not an object, + // or if **any** type in an invoked expression is not a callable. + // Setting this to true will introduce numerous false positives + // (and reveal some bugs). + 'strict_method_checking' => false, + + // If enabled, Phan will warn if **any** type of the object expression for a property access + // does not contain that property. + 'strict_object_checking' => false, + + // If enabled, Phan will warn if **any** type in the argument's union type + // cannot be cast to a type in the parameter's expected union type. + // Setting this to true will introduce numerous false positives + // (and reveal some bugs). + 'strict_param_checking' => false, + + // If enabled, Phan will warn if **any** type in a property assignment's union type + // cannot be cast to a type in the property's declared union type. + // Setting this to true will introduce numerous false positives + // (and reveal some bugs). + 'strict_property_checking' => false, + + // If enabled, Phan will warn if **any** type in a returned value's union type + // cannot be cast to the declared return type. + // Setting this to true will introduce numerous false positives + // (and reveal some bugs). + 'strict_return_checking' => false, + + // If true, seemingly undeclared variables in the global + // scope will be ignored. + // + // This is useful for projects with complicated cross-file + // globals that you have no hope of fixing. + 'ignore_undeclared_variables_in_global_scope' => true, + + // Set this to false to emit `PhanUndeclaredFunction` issues for internal functions that Phan has signatures for, + // but aren't available in the codebase, or from Reflection. + // (may lead to false positives if an extension isn't loaded) + // + // If this is true(default), then Phan will not warn. + // + // Even when this is false, Phan will still infer return values and check parameters of internal functions + // if Phan has the signatures. + 'ignore_undeclared_functions_with_known_signatures' => true, + + // Backwards Compatibility Checking. This is slow + // and expensive, but you should consider running + // it before upgrading your version of PHP to a + // new version that has backward compatibility + // breaks. + // + // If you are migrating from PHP 5 to PHP 7, + // you should also look into using + // [php7cc (no longer maintained)](https://github.com/sstalle/php7cc) + // and [php7mar](https://github.com/Alexia/php7mar), + // which have different backwards compatibility checks. + 'backward_compatibility_checks' => false, + + // If true, check to make sure the return type declared + // in the doc-block (if any) matches the return type + // declared in the method signature. + 'check_docblock_signature_return_type_match' => false, + + // If true, make narrowed types from phpdoc params override + // the real types from the signature, when real types exist. + // (E.g. allows specifying desired lists of subclasses, + // or to indicate a preference for non-nullable types over nullable types) + // + // Affects analysis of the body of the method and the param types passed in by callers. + // + // (*Requires `check_docblock_signature_param_type_match` to be true*) + 'prefer_narrowed_phpdoc_param_type' => true, + + // (*Requires `check_docblock_signature_return_type_match` to be true*) + // + // If true, make narrowed types from phpdoc returns override + // the real types from the signature, when real types exist. + // + // (E.g. allows specifying desired lists of subclasses, + // or to indicate a preference for non-nullable types over nullable types) + // + // This setting affects the analysis of return statements in the body of the method and the return types passed in by callers. + 'prefer_narrowed_phpdoc_return_type' => true, + + // If enabled, check all methods that override a + // parent method to make sure its signature is + // compatible with the parent's. + // + // This check can add quite a bit of time to the analysis. + // + // This will also check if final methods are overridden, etc. + 'analyze_signature_compatibility' => true, + + // This setting maps case-insensitive strings to union types. + // + // This is useful if a project uses phpdoc that differs from the phpdoc2 standard. + // + // If the corresponding value is the empty string, + // then Phan will ignore that union type (E.g. can ignore 'the' in `@return the value`) + // + // If the corresponding value is not empty, + // then Phan will act as though it saw the corresponding UnionTypes(s) + // when the keys show up in a UnionType of `@param`, `@return`, `@var`, `@property`, etc. + // + // This matches the **entire string**, not parts of the string. + // (E.g. `@return the|null` will still look for a class with the name `the`, but `@return the` will be ignored with the below setting) + // + // (These are not aliases, this setting is ignored outside of doc comments). + // (Phan does not check if classes with these names exist) + // + // Example setting: `['unknown' => '', 'number' => 'int|float', 'char' => 'string', 'long' => 'int', 'the' => '']` + 'phpdoc_type_mapping' => [], + + // Set to true in order to attempt to detect dead + // (unreferenced) code. Keep in mind that the + // results will only be a guess given that classes, + // properties, constants and methods can be referenced + // as variables (like `$class->$property` or + // `$class->$method()`) in ways that we're unable + // to make sense of. + 'dead_code_detection' => false, + + // Set to true in order to attempt to detect unused variables. + // `dead_code_detection` will also enable unused variable detection. + // + // This has a few known false positives, e.g. for loops or branches. + 'unused_variable_detection' => false, + + // Set to true in order to attempt to detect redundant and impossible conditions. + // + // This has some false positives involving loops, + // variables set in branches of loops, and global variables. + 'redundant_condition_detection' => false, + + // If enabled, Phan will act as though it's certain of real return types of a subset of internal functions, + // even if those return types aren't available in reflection (real types were taken from php 7.3 or 8.0-dev, depending on target_php_version). + // + // Note that with php 7 and earlier, php would return null or false for many internal functions if the argument types or counts were incorrect. + // As a result, enabling this setting with target_php_version 8.0 may result in false positives for `--redundant-condition-detection` when codebases also support php 7.x. + 'assume_real_types_for_internal_functions' => false, + + // If true, this runs a quick version of checks that takes less + // time at the cost of not running as thorough + // of an analysis. You should consider setting this + // to true only when you wish you had more **undiagnosed** issues + // to fix in your code base. + // + // In quick-mode the scanner doesn't rescan a function + // or a method's code block every time a call is seen. + // This means that the problem here won't be detected: + // + // ```php + // false, + + // Enable or disable support for generic templated + // class types. + 'generic_types_enabled' => true, + + // Override to hardcode existence and types of (non-builtin) globals in the global scope. + // Class names should be prefixed with `\`. + // + // (E.g. `['_FOO' => '\FooClass', 'page' => '\PageClass', 'userId' => 'int']`) + 'globals_type_map' => [], + + // The minimum severity level to report on. This can be + // set to `Issue::SEVERITY_LOW`, `Issue::SEVERITY_NORMAL` or + // `Issue::SEVERITY_CRITICAL`. Setting it to only + // critical issues is a good place to start on a big + // sloppy mature code base. + 'minimum_severity' => Issue::SEVERITY_LOW, + + // Add any issue types (such as `'PhanUndeclaredMethod'`) + // to this deny-list to inhibit them from being reported. + 'suppress_issue_types' => [], + + // A regular expression to match files to be excluded + // from parsing and analysis and will not be read at all. + // + // This is useful for excluding groups of test or example + // directories/files, unanalyzable files, or files that + // can't be removed for whatever reason. + // (e.g. `'@Test\.php$@'`, or `'@vendor/.*/(tests|Tests)/@'`) + 'exclude_file_regex' => '@^vendor/.*/(tests?|Tests?)/@', + + // A list of files that will be excluded from parsing and analysis + // and will not be read at all. + // + // This is useful for excluding hopelessly unanalyzable + // files that can't be removed for whatever reason. + 'exclude_file_list' => [ + 'vendor/composer/composer/src/Composer/InstalledVersions.php' + ], + + // A directory list that defines files that will be excluded + // from static analysis, but whose class and method + // information should be included. + // + // Generally, you'll want to include the directories for + // third-party code (such as "vendor/") in this list. + // + // n.b.: If you'd like to parse but not analyze 3rd + // party code, directories containing that code + // should be added to the `directory_list` as well as + // to `exclude_analysis_directory_list`. + 'exclude_analysis_directory_list' => [ + 'vendor/', + 'proto/', + 'thrift/' + ], + + // Enable this to enable checks of require/include statements referring to valid paths. + 'enable_include_path_checks' => true, + + // The number of processes to fork off during the analysis + // phase. + 'processes' => 1, + + // List of case-insensitive file extensions supported by Phan. + // (e.g. `['php', 'html', 'htm']`) + 'analyzed_file_extensions' => [ + 'php', + ], + + // You can put paths to stubs of internal extensions in this config option. + // If the corresponding extension is **not** loaded, then Phan will use the stubs instead. + // Phan will continue using its detailed type annotations, + // but load the constants, classes, functions, and classes (and their Reflection types) + // from these stub files (doubling as valid php files). + // Use a different extension from php to avoid accidentally loading these. + // The `tools/make_stubs` script can be used to generate your own stubs (compatible with php 7.0+ right now) + // + // (e.g. `['xdebug' => '.phan/internal_stubs/xdebug.phan_php']`) + 'autoload_internal_extension_signatures' => [], + + // A list of plugin files to execute. + // + // Plugins which are bundled with Phan can be added here by providing their name (e.g. `'AlwaysReturnPlugin'`) + // + // Documentation about available bundled plugins can be found [here](https://github.com/phan/phan/tree/master/.phan/plugins). + // + // Alternately, you can pass in the full path to a PHP file with the plugin's implementation (e.g. `'vendor/phan/phan/.phan/plugins/AlwaysReturnPlugin.php'`) + 'plugins' => [ + 'AlwaysReturnPlugin', + 'PregRegexCheckerPlugin', + 'UnreachableCodePlugin', + ], + + // A list of directories that should be parsed for class and + // method information. After excluding the directories + // defined in `exclude_analysis_directory_list`, the remaining + // files will be statically analyzed for errors. + // + // Thus, both first-party and third-party code being used by + // your application should be included in this list. + 'directory_list' => [ + 'src', + 'vendor' + ], + + // A list of individual files to include in analysis + // with a path relative to the root directory of the + // project. + 'file_list' => [], +]; diff --git a/src/Propagation/Instana/.php-cs-fixer.php b/src/Propagation/Instana/.php-cs-fixer.php new file mode 100644 index 000000000..e35fa078c --- /dev/null +++ b/src/Propagation/Instana/.php-cs-fixer.php @@ -0,0 +1,43 @@ +exclude('vendor') + ->exclude('var/cache') + ->in(__DIR__); + +$config = new PhpCsFixer\Config(); +return $config->setRules([ + 'concat_space' => ['spacing' => 'one'], + 'declare_equal_normalize' => ['space' => 'none'], + 'is_null' => true, + 'modernize_types_casting' => true, + 'ordered_imports' => true, + 'php_unit_construct' => true, + 'single_line_comment_style' => true, + 'yoda_style' => false, + '@PSR2' => true, + 'array_syntax' => ['syntax' => 'short'], + 'blank_line_after_opening_tag' => true, + 'blank_line_before_statement' => true, + 'cast_spaces' => true, + 'declare_strict_types' => true, + 'type_declaration_spaces' => true, + 'include' => true, + 'lowercase_cast' => true, + 'new_with_parentheses' => true, + 'no_extra_blank_lines' => true, + 'no_leading_import_slash' => true, + 'echo_tag_syntax' => true, + 'no_unused_imports' => true, + 'no_useless_else' => true, + 'no_useless_return' => true, + 'phpdoc_order' => true, + 'phpdoc_scalar' => true, + 'phpdoc_types' => true, + 'short_scalar_cast' => true, + 'blank_lines_before_namespace' => true, + 'single_quote' => true, + 'trailing_comma_in_multiline' => true, + ]) + ->setRiskyAllowed(true) + ->setFinder($finder); + diff --git a/src/Propagation/Instana/README.md b/src/Propagation/Instana/README.md new file mode 100644 index 000000000..c3acb6ea6 --- /dev/null +++ b/src/Propagation/Instana/README.md @@ -0,0 +1,64 @@ +OpenTelemetry Instana Propagator + +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`. + + +## Installation + +```sh +composer require open-telemetry/opentelemetry-propagation-instana +``` + +## Usage + +``` +$propagator = InstanaMultiPropagator::getInstance(); +``` + +Both of the above have extract and inject methods available to extract and inject respectively into the header. + +## Propagator Details + +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). + +Example header triplet: + +* `X-INSTANA-T: 80f198ee56343ba864fe8b2a57d3eff7`, +* `X-INSTANA-S: e457b5a2e4d86bd1`, +* `X-INSTANA-L: 1`. + +A short summary for each of the headers is provided below. More details are available at . + +### 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. + +### X-INSTANA-S -- parent span ID + +* 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). + +### X-INSTANA-L - sampling level + +* 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). + +## Useful links + +* For more information on Instana, visit and [Instana' documentation](https://www.ibm.com/docs/en/obi/current). +* For more information on OpenTelemetry, visit: + +## Installing dependencies and executing tests + +From Instana subdirectory: + +``` sh +$ composer install +$ ./vendor/bin/phpunit tests +``` diff --git a/src/Propagation/Instana/_register.php b/src/Propagation/Instana/_register.php new file mode 100644 index 000000000..15b0f1425 --- /dev/null +++ b/src/Propagation/Instana/_register.php @@ -0,0 +1,13 @@ + + + + + + + src + + + + + + + + + + + + + tests/Unit + + + + diff --git a/src/Propagation/Instana/psalm.xml.dist b/src/Propagation/Instana/psalm.xml.dist new file mode 100644 index 000000000..155711712 --- /dev/null +++ b/src/Propagation/Instana/psalm.xml.dist @@ -0,0 +1,15 @@ + + + + + + + + + + diff --git a/src/Propagation/Instana/src/InstanaMultiPropagator.php b/src/Propagation/Instana/src/InstanaMultiPropagator.php new file mode 100644 index 000000000..ddae29c40 --- /dev/null +++ b/src/Propagation/Instana/src/InstanaMultiPropagator.php @@ -0,0 +1,173 @@ +getContext(); + + if (!$spanContext->isValid()) { + return; + } + + // Inject multiple Instana headers + $setter->set($carrier, self::INSTANA_TRACE_ID_HEADER, $spanContext->getTraceId()); + $setter->set($carrier, self::INSTANA_SPAN_ID_HEADER, $spanContext->getSpanId()); + $setter->set($carrier, self::INSTANA_LEVEL_HEADER, $spanContext->isSampled() ? self::IS_SAMPLED : self::IS_NOT_SAMPLED); + } + + /** + * @suppress PhanUndeclaredClassAttribute + */ + #[\Override] + public function extract($carrier, ?PropagationGetterInterface $getter = null, ?ContextInterface $context = null): ContextInterface + { + $getter ??= ArrayAccessGetterSetter::getInstance(); + $context ??= Context::getCurrent(); + + $traceId = self::readHeader($carrier, $getter, self::INSTANA_TRACE_ID_HEADER); + $spanId = self::readHeader($carrier, $getter, self::INSTANA_SPAN_ID_HEADER); + $level = self::getSampledValue($carrier, $getter); + + $spanContext = self::extractImpl($carrier, $getter); + + if (($traceId === '' && $spanId === '') && $level !== null) { + return (new NonRecordingSpan($spanContext)) + ->storeInContext($context); + + } elseif (!$spanContext->isValid()) { + return $context; + } + + return $context->withContextValue(Span::wrap($spanContext)); + } + + private static function readHeader($carrier, PropagationGetterInterface $getter, string $key): string + { + $header = $getter->get($carrier, $key) ?: ''; + + // Return the header or an empty string if not found + return $header; + } + + private static function getSampledValue($carrier, PropagationGetterInterface $getter): ?int + { + $value = $getter->get($carrier, self::INSTANA_LEVEL_HEADER); + + if ($value === null) { + return null; + } + + if (in_array(strtolower($value), self::VALID_SAMPLED)) { + return (int) self::IS_SAMPLED; + } + + if (in_array(strtolower($value), self::VALID_NON_SAMPLED)) { + return (int) self::IS_NOT_SAMPLED; + } + + return null; + } + + private static function extractImpl($carrier, PropagationGetterInterface $getter): SpanContextInterface + { + $traceId = self::readHeader($carrier, $getter, self::INSTANA_TRACE_ID_HEADER); + $spanId = self::readHeader($carrier, $getter, self::INSTANA_SPAN_ID_HEADER); + $level = self::getSampledValue($carrier, $getter); + + if ($traceId && strlen($traceId) < 32) { + $traceId = str_pad($traceId, 32, '0', STR_PAD_LEFT); + } + + if ($spanId && strlen($spanId) < 16) { + $spanId = str_pad($spanId, 16, '0', STR_PAD_LEFT); + } + + return SpanContext::createFromRemoteParent( + $traceId, + $spanId, + $level ? TraceFlags::SAMPLED : TraceFlags::DEFAULT + ); + } +} diff --git a/src/Propagation/Instana/tests/Unit/InstanaMultiPropagatorTest.php b/src/Propagation/Instana/tests/Unit/InstanaMultiPropagatorTest.php new file mode 100644 index 000000000..a7324cef8 --- /dev/null +++ b/src/Propagation/Instana/tests/Unit/InstanaMultiPropagatorTest.php @@ -0,0 +1,419 @@ +instanaMultiPropagator = InstanaMultiPropagator::getInstance(); + $instanaMultiFields = $this->instanaMultiPropagator->fields(); + $this->TRACE_ID = $instanaMultiFields[0]; + $this->SPAN_ID = $instanaMultiFields[1]; + $this->SAMPLED = $instanaMultiFields[2]; + } + + public function test_fields(): void + { + $this->assertSame( + ['X-INSTANA-T', 'X-INSTANA-S', 'X-INSTANA-L'], + $this->instanaMultiPropagator->fields() + ); + } + + public function test_inject_empty(): void + { + $carrier = []; + $this->instanaMultiPropagator->inject($carrier); + $this->assertEmpty($carrier); + } + + public function test_inject_invalid_context(): void + { + $carrier = []; + $this + ->instanaMultiPropagator + ->inject( + $carrier, + null, + $this->withSpanContext( + SpanContext::create( + SpanContextValidator::INVALID_TRACE, + SpanContextValidator::INVALID_SPAN, + TraceFlags::SAMPLED + ), + Context::getCurrent() + ) + ); + $this->assertEmpty($carrier); + } + + public function test_inject_sampled_context(): void + { + $carrier = []; + $this + ->instanaMultiPropagator + ->inject( + $carrier, + null, + $this->withSpanContext( + SpanContext::create(self::X_INSTANA_T, self::X_INSTANA_S, TraceFlags::SAMPLED), + Context::getCurrent() + ) + ); + + $this->assertSame( + [ + $this->TRACE_ID => self::X_INSTANA_T, + $this->SPAN_ID => self::X_INSTANA_S, + $this->SAMPLED => self::IS_SAMPLED, + ], + $carrier + ); + } + + public function test_inject_non_sampled_context(): void + { + $carrier = []; + $this + ->instanaMultiPropagator + ->inject( + $carrier, + null, + $this->withSpanContext( + SpanContext::create(self::X_INSTANA_T, self::X_INSTANA_S), + Context::getCurrent() + ) + ); + + $this->assertSame( + [ + $this->TRACE_ID => self::X_INSTANA_T, + $this->SPAN_ID => self::X_INSTANA_S, + $this->SAMPLED => self::IS_NOT_SAMPLED, + ], + $carrier + ); + } + + public function test_inject_sampled_context_when_other_traceflags_set(): void + { + $carrier = []; + $this + ->instanaMultiPropagator + ->inject( + $carrier, + null, + $this->withSpanContext( + SpanContext::create(self::X_INSTANA_T, self::X_INSTANA_S, traceFlags: 81), + Context::getCurrent() + ) + ); + + $this->assertSame( + [ + $this->TRACE_ID => self::X_INSTANA_T, + $this->SPAN_ID => self::X_INSTANA_S, + $this->SAMPLED => self::IS_SAMPLED, + ], + $carrier + ); + } + + public function test_extract_context_with_lowercase_headers(): void + { + $carrier = [ + 'x-instana-t' => self::X_INSTANA_T, + 'x-instana-s' => self::X_INSTANA_S, + 'x-instana-l' => '1', + ]; + + $this->assertEquals( + SpanContext::createFromRemoteParent(self::X_INSTANA_T, self::X_INSTANA_S, TraceFlags::SAMPLED), + $this->getSpanContext($this->instanaMultiPropagator->extract($carrier)) + ); + } + + public function test_extract_context_with_no_span_headers(): void + { + $this->assertInvalid( + [ + $this->TRACE_ID => self::X_INSTANA_T, + $this->SAMPLED => self::IS_SAMPLED, + ] + ); + } + + /** + * @dataProvider sampledValueProvider + */ + public function test_extract_sampled_context($sampledValue): void + { + $carrier = [ + $this->TRACE_ID => self::X_INSTANA_T, + $this->SPAN_ID => self::X_INSTANA_S, + $this->SAMPLED => $sampledValue, + ]; + + $this->assertEquals( + SpanContext::createFromRemoteParent(self::X_INSTANA_T, self::X_INSTANA_S, TraceFlags::SAMPLED), + $this->getSpanContext($this->instanaMultiPropagator->extract($carrier)) + ); + } + + public static function sampledValueProvider(): array + { + return [ + 'String sampled value' => ['1'], + 'Boolean(lower string) sampled value' => ['true'], + 'Boolean(upper string) sampled value' => ['TRUE'], + 'Boolean(camel string) sampled value' => ['True'], + ]; + } + + /** + * @dataProvider notSampledValueProvider + */ + public function test_extract_non_sampled_context($sampledValue): void + { + $carrier = [ + $this->TRACE_ID => self::X_INSTANA_T, + $this->SPAN_ID => self::X_INSTANA_S, + $this->SAMPLED => $sampledValue, + ]; + + $this->assertEquals( + SpanContext::createFromRemoteParent(self::X_INSTANA_T, self::X_INSTANA_S), + $this->getSpanContext($this->instanaMultiPropagator->extract($carrier)) + ); + } + + public static function notSampledValueProvider(): array + { + return [ + 'String sampled value' => ['0'], + 'Boolean(lower string) sampled value' => ['false'], + 'Boolean(upper string) sampled value' => ['FALSE'], + 'Boolean(camel string) sampled value' => ['False'], + ]; + } + + /** + * @dataProvider DefaultSampledValueProvider + */ + public function test_extract_default_sampled_context($sampledValue): void + { + $carrier = [ + $this->TRACE_ID => self::X_INSTANA_T, + $this->SPAN_ID => self::X_INSTANA_S, + $this->SAMPLED => $sampledValue, + ]; + + $this->assertEquals( + SpanContext::createFromRemoteParent(self::X_INSTANA_T, self::X_INSTANA_S, TraceFlags::DEFAULT), + $this->getSpanContext($this->instanaMultiPropagator->extract($carrier)) + ); + } + + public static function DefaultSampledValueProvider(): array + { + return [ + 'null sampled value' => [null], + 'empty sampled value' => [[]], + ]; + } + + /** + * @dataProvider InvalidSampledValueProvider + */ + public function test_extract_invalid_sampled_context($sampledValue): void + { + $carrier = [ + $this->TRACE_ID => self::X_INSTANA_T, + $this->SPAN_ID => self::X_INSTANA_S, + $this->SAMPLED => $sampledValue, + ]; + + $this->assertEquals( + SpanContext::createFromRemoteParent(self::X_INSTANA_T, self::X_INSTANA_S), + $this->getSpanContext($this->instanaMultiPropagator->extract($carrier)) + ); + } + + public static function InvalidSampledValueProvider(): array + { + return [ + 'wrong sampled value 1' => ['wrong'], + 'wrong sampled value 2' => ['abcd'], + ]; + } + + public function test_extract_context_with_sampled_no_trace_and_span_headers(): void + { + $carrier = [ + 'X-INSTANA-L' => '1', + ]; + + $this->assertEquals( + SpanContext::createFromRemoteParent( + '00000000000000000000000000000000', + '0000000000000000', + TraceFlags::SAMPLED + ), + $this->getSpanContext($this->instanaMultiPropagator->extract($carrier)) + ); + } + + public function test_extract_context_with_no_trace_and_span_headers(): void + { + $carrier = [ + 'X-INSTANA-L' => '0', + ]; + + $this->assertEquals( + SpanContext::createFromRemoteParent( + '00000000000000000000000000000000', + '0000000000000000', + TraceFlags::DEFAULT + ), + $this->getSpanContext($this->instanaMultiPropagator->extract($carrier)) + ); + } + + public function test_extract_and_inject(): void + { + $extractCarrier = [ + $this->TRACE_ID => self::X_INSTANA_T, + $this->SPAN_ID => self::X_INSTANA_S, + $this->SAMPLED => self::IS_SAMPLED, + ]; + $context = $this->instanaMultiPropagator->extract($extractCarrier); + $injectCarrier = []; + $this->instanaMultiPropagator->inject($injectCarrier, null, $context); + $this->assertSame($injectCarrier, $extractCarrier); + } + + public function test_extract_empty_trace_id(): void + { + $this->assertInvalid( + [ + $this->TRACE_ID => '', + $this->SPAN_ID => self::X_INSTANA_S, + $this->SAMPLED => self::IS_SAMPLED, + ] + ); + } + + public function test_extract_leftpad_spand_id(): void + { + $carrier = [ + $this->TRACE_ID => '4aaba1a52cf8ee09', + $this->SPAN_ID => '7b5a2e4d86bd1', + $this->SAMPLED => '1', + ]; + + $this->assertEquals( + SpanContext::createFromRemoteParent('00000000000000004aaba1a52cf8ee09', '0007b5a2e4d86bd1', TraceFlags::SAMPLED), + $this->getSpanContext($this->instanaMultiPropagator->extract($carrier)) + ); + } + + public function test_invalid_trace_id(): void + { + $this->assertInvalid( + [ + $this->TRACE_ID => 'abcdefghijklmnopabcdefghijklmnop', + $this->SPAN_ID => self::X_INSTANA_S, + $this->SAMPLED => self::IS_SAMPLED, + ] + ); + } + + public function test_invalid_trace_id_size(): void + { + $this->assertInvalid( + [ + $this->TRACE_ID => self::X_INSTANA_T . '00', + $this->SPAN_ID => self::X_INSTANA_S, + $this->SAMPLED => self::IS_SAMPLED, + ] + ); + } + + public function test_extract_empty_span_id(): void + { + $this->assertInvalid( + [ + $this->TRACE_ID => self::X_INSTANA_T, + $this->SPAN_ID => '', + $this->SAMPLED => self::IS_SAMPLED, + ] + ); + } + + public function test_invalid_span_id(): void + { + $this->assertInvalid( + [ + $this->TRACE_ID => self::X_INSTANA_T, + $this->SPAN_ID => 'abcdefghijklmnop', + $this->SAMPLED => self::IS_SAMPLED, + ] + ); + } + + public function test_invalid_span_id_size(): void + { + $this->assertInvalid( + [ + $this->TRACE_ID => self::X_INSTANA_T, + $this->SPAN_ID => self::X_INSTANA_S . '00', + $this->SAMPLED => self::IS_SAMPLED, + ] + ); + } + + private function assertInvalid(array $carrier): void + { + $this->assertSame( + Context::getCurrent(), + $this->instanaMultiPropagator->extract($carrier), + ); + } + + private function getSpanContext(ContextInterface $context): SpanContextInterface + { + return Span::fromContext($context)->getContext(); + } + + private function withSpanContext(SpanContextInterface $spanContext, ContextInterface $context): ContextInterface + { + return $context->withContextValue(Span::wrap($spanContext)); + } +}