Skip to content

Commit 057e7d1

Browse files
AsakerMohdAsakerMohd
authored
Merge branch 'open-telemetry:main' into main
2 parents 28a512e + 1a723de commit 057e7d1

File tree

7 files changed

+201
-5
lines changed

7 files changed

+201
-5
lines changed

‎.github/workflows/dependabot-auto-approve.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ jobs:
1111
steps:
1212
- name: Dependabot metadata
1313
id: metadata
14-
uses: dependabot/fetch-metadata@d7267f607e9d3fb96fc2fbe83e0af444713e90b7
14+
uses: dependabot/fetch-metadata@08eff52bf64351f401fb50d4972fa95b9f2c2d1b
1515
with:
1616
github-token: "${{ secrets.GITHUB_TOKEN }}"
1717
- name: Approve a PR

‎.github/workflows/ossf-scorecard.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,6 @@ jobs:
4242
# Upload the results to GitHub's code scanning dashboard (optional).
4343
# Commenting out will disable upload of results to your repo's Code Scanning dashboard
4444
- name: "Upload to code-scanning"
45-
uses: github/codeql-action/upload-sarif@45775bd8235c68ba998cffa5171334d58593da47 # v3.28.15
45+
uses: github/codeql-action/upload-sarif@60168efe1c415ce0f5521ea06d5c2062adbeed1b # v3.28.17
4646
with:
4747
sarif_file: results.sarif

‎src/Instrumentation/MongoDB/composer.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"license": "Apache-2.0",
99
"require": {
1010
"php": ">=8.1",
11-
"ext-mongodb": "^1.13 | ^2.0",
11+
"ext-mongodb": "^1.13 || ^2.0",
1212
"ext-json": "*",
1313
"mongodb/mongodb": "^1.15 || ^2.0",
1414
"open-telemetry/api": "^1.0",

‎src/Instrumentation/Psr3/composer.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@
3636
"cakephp/log": "*",
3737
"monolog/monolog": "*",
3838
"symfony/console": "*",
39+
"symfony/uid": "*",
3940
"yiisoft/log": "*",
4041
"friendsofphp/php-cs-fixer": "^3",
4142
"phan/phan": "^5.0",

‎src/Instrumentation/Psr3/src/Formatter.php‎

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,52 @@
44

55
namespace OpenTelemetry\Contrib\Instrumentation\Psr3;
66

7+
use JsonSerializable;
8+
use OpenTelemetry\API\Behavior\LogsMessagesTrait;
9+
use Stringable;
710
use Throwable;
811

912
class Formatter
1013
{
14+
15+
use LogsMessagesTrait;
16+
1117
public static function format(array $context): array
1218
{
1319
$formatted = [];
1420
foreach ($context as $key => $value) {
1521
if ($key === 'exception' && $value instanceof Throwable) {
1622
$formatted[$key] = self::formatThrowable($value);
1723
} else {
18-
$formatted[$key] = json_decode(json_encode($value) ?: '');
24+
switch (gettype($value)) {
25+
case 'integer':
26+
case 'double':
27+
case 'boolean':
28+
$formatted[$key] = $value;
29+
30+
break;
31+
case 'string':
32+
case 'array':
33+
// Handle UTF-8 encoding issues
34+
$encoded = json_encode($value, JSON_INVALID_UTF8_SUBSTITUTE);
35+
if ($encoded === false) {
36+
self::logWarning('Failed to encode value: ' . json_last_error_msg());
37+
} else {
38+
$formatted[$key] = json_decode($encoded);
39+
}
40+
41+
break;
42+
case 'object':
43+
if ($value instanceof Stringable) {
44+
$formatted[$key] = (string) $value;
45+
} elseif ($value instanceof JsonSerializable) {
46+
$formatted[$key] = $value->jsonSerialize();
47+
}
48+
49+
break;
50+
default:
51+
//do nothing
52+
}
1953
}
2054
}
2155

‎src/Instrumentation/Psr3/tests/Unit/FormatterTest.php‎

Lines changed: 52 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,74 @@
44

55
namespace OpenTelemetry\Contrib\Psr3\tests\Unit;
66

7+
use Exception;
8+
use JsonSerializable;
9+
use OpenTelemetry\API\Behavior\Internal\Logging;
10+
use OpenTelemetry\API\Behavior\Internal\LogWriter\LogWriterInterface;
711
use OpenTelemetry\Contrib\Instrumentation\Psr3\Formatter;
12+
use PHPUnit\Framework\MockObject\MockObject;
813
use PHPUnit\Framework\TestCase;
14+
use Stringable;
915

1016
class FormatterTest extends TestCase
1117
{
18+
/** @var LogWriterInterface&MockObject */
19+
private LogWriterInterface $logWriter;
20+
21+
public function setUp(): void
22+
{
23+
$this->logWriter = $this->createMock(LogWriterInterface::class);
24+
Logging::setLogWriter($this->logWriter);
25+
}
26+
27+
public function tearDown(): void
28+
{
29+
Logging::reset();
30+
}
31+
1232
public function test_format(): void
1333
{
1434
$context = [
1535
0 => 'zero',
1636
'foo' => 'bar',
17-
'exception' => new \Exception('foo', 500, new \RuntimeException('bar')),
37+
'exception' => new Exception('foo', 500, new \RuntimeException('bar')),
38+
'j' => new class() implements JsonSerializable {
39+
public function jsonSerialize(): array
40+
{
41+
return ['foo' => 'bar'];
42+
}
43+
},
44+
's' => new class() implements Stringable {
45+
public function __toString(): string
46+
{
47+
return 'string_value';
48+
}
49+
},
50+
'b' => true,
1851
];
1952
$formatted = Formatter::format($context);
2053
$this->assertSame('bar', $formatted['foo']);
2154
$this->assertArrayHasKey('exception', $formatted);
2255
$this->assertSame('foo', $formatted['exception']['message']);
2356
$this->assertSame(500, $formatted['exception']['code']);
2457
$this->assertSame('bar', $formatted['exception']['previous']['message']);
58+
$this->assertSame('string_value', $formatted['s']);
59+
$this->assertSame(['foo' => 'bar'], $formatted['j']);
60+
$this->assertTrue($formatted['b']);
61+
}
62+
63+
public function test_invalid_input_logs_warning(): void
64+
{
65+
$this->logWriter->expects($this->once())->method('write')->with(
66+
$this->equalTo('warning'),
67+
$this->stringContains('Failed to encode value'),
68+
);
69+
$context = [
70+
'good' => 'foo',
71+
'bad' => [fopen('php://memory', 'r+')], //resource cannot be encoded
72+
];
73+
$formatted = Formatter::format($context);
74+
$this->assertSame('foo', $formatted['good']);
75+
$this->assertArrayNotHasKey('bad', $formatted);
2576
}
2677
}

‎src/Instrumentation/Psr3/tests/phpt/export_context.phpt‎

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
--TEST--
2+
Test generating otel LogRecord with complex message context
3+
--FILE--
4+
5+
<?php
6+
use OpenTelemetry\API\Globals;
7+
use Psr\Log\LoggerInterface;
8+
use Psr\Log\LoggerTrait;
9+
10+
putenv('OTEL_PHP_AUTOLOAD_ENABLED=true');
11+
putenv('OTEL_LOGS_EXPORTER=console');
12+
putenv('OTEL_TRACES_EXPORTER=none');
13+
putenv('OTEL_METRICS_EXPORTER=none');
14+
putenv('OTEL_PHP_DETECTORS=none');
15+
putenv('OTEL_PHP_PSR3_MODE=export');
16+
17+
require dirname(__DIR__, 2) . '/vendor/autoload.php';
18+
19+
$logger = new class implements LoggerInterface{
20+
use LoggerTrait;
21+
public function log($level, string|\Stringable $message, array $context = []): void {}
22+
};
23+
24+
$span = Globals::tracerProvider()->getTracer('demo')->spanBuilder('root')->startSpan();
25+
$scope = $span->activate();
26+
27+
$context = [
28+
's' => 'string',
29+
'i' => 1234,
30+
'l' => 3.14159,
31+
't' => true,
32+
'f' => false,
33+
'stringable' => new class() implements \Stringable {
34+
public function __toString(): string
35+
{
36+
return 'some_string';
37+
}
38+
},
39+
'j' => new class() implements JsonSerializable {
40+
public function jsonSerialize(): array
41+
{
42+
return ['key' => 'value'];
43+
}
44+
},
45+
'array' => ['a', 'b', 'c'],
46+
'exception' => new \Exception('my_exception'),
47+
'bin' => \Symfony\Component\Uid\Uuid::v4()->toBinary(),
48+
];
49+
50+
51+
$logger->info('test message', $context);
52+
53+
$scope->detach();
54+
$span->end();
55+
?>
56+
57+
--EXPECTF--
58+
{
59+
"resource": {
60+
"attributes": [],
61+
"dropped_attributes_count": 0
62+
},
63+
"scopes": [
64+
{
65+
"name": "io.opentelemetry.contrib.php.psr3",
66+
"version": null,
67+
"attributes": [],
68+
"dropped_attributes_count": 0,
69+
"schema_url": "https:\/\/opentelemetry.io\/schemas\/%s",
70+
"logs": [
71+
{
72+
"timestamp": null,
73+
"observed_timestamp": %d,
74+
"severity_number": %d,
75+
"severity_text": null,
76+
"body": "test message",
77+
"trace_id": "%s",
78+
"span_id": "%s",
79+
"trace_flags": 1,
80+
"attributes": {
81+
"s": "string",
82+
"i": 1234,
83+
"l": 3.14159,
84+
"t": true,
85+
"f": false,
86+
"stringable": "some_string",
87+
"j": {
88+
"key": "value"
89+
},
90+
"array": [
91+
"a",
92+
"b",
93+
"c"
94+
],
95+
"exception": {
96+
"message": "my_exception",
97+
"code": 0,
98+
"file": "Standard input code",
99+
"line": %d,
100+
"trace": [],
101+
"previous": []
102+
},
103+
"bin": "%s"
104+
},
105+
"dropped_attributes_count": 0
106+
}
107+
]
108+
}
109+
]
110+
}

0 commit comments

Comments
 (0)