Skip to content

fix(logs): guard pii in logs #2076

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Litarnus merged 1 commit into from
Apr 28, 2026
+47 −13
Merged

fix(logs): guard pii in logs #2076

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 15 additions & 13 deletions src/Logs/LogsAggregator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,20 +90,22 @@ public function add(
$log->setAttribute('sentry.sdk.version', $client->getSdkVersion());
}

$hub->configureScope(static function (Scope $scope) use ($log) {
$user = $scope->getUser();
if ($user !== null) {
if ($user->getId() !== null) {
$log->setAttribute('user.id', $user->getId());
if ($options->shouldSendDefaultPii()) {
$hub->configureScope(static function (Scope $scope) use ($log) {
$user = $scope->getUser();
if ($user !== null) {
if ($user->getId() !== null) {
$log->setAttribute('user.id', $user->getId());
}
if ($user->getEmail() !== null) {
$log->setAttribute('user.email', $user->getEmail());
}
if ($user->getUsername() !== null) {
$log->setAttribute('user.name', $user->getUsername());
}
}
if ($user->getEmail() !== null) {
$log->setAttribute('user.email', $user->getEmail());
}
if ($user->getUsername() !== null) {
$log->setAttribute('user.name', $user->getUsername());
}
}
});
});
}

if (\count($values)) {
$log->setAttribute('sentry.message.template', $message);
Expand Down
32 changes: 32 additions & 0 deletions tests/Logs/LogsAggregatorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,7 @@ public function testAttributesAreAddedToLogMessage(): void
{
$client = ClientBuilder::create([
'enable_logs' => true,
'send_default_pii' => true,
'release' => '1.0.0',
'environment' => 'production',
'server_name' => 'web-server-01',
Expand Down Expand Up @@ -210,6 +211,37 @@ public function testAttributesAreAddedToLogMessage(): void
$this->assertSame('my_user', $attributes->get('user.name')->getValue());
}

public function testUserAttributesAreNotAddedToLogMessageWhenSendDefaultPiiIsDisabled(): void
{
$client = ClientBuilder::create([
'enable_logs' => true,
'send_default_pii' => false,
])->getClient();

$hub = new Hub($client);
SentrySdk::setCurrentHub($hub);

$hub->configureScope(static function (Scope $scope) {
$userDataBag = new UserDataBag();
$userDataBag->setId('unique_id');
$userDataBag->setEmail('foo@example.com');
$userDataBag->setUsername('my_user');
$scope->setUser($userDataBag);
});

$aggregator = new LogsAggregator();
$aggregator->add(LogLevel::info(), 'User performed action');

$logs = $aggregator->all();
$this->assertCount(1, $logs);

$attributes = $logs[0]->attributes();

$this->assertNull($attributes->get('user.id'));
$this->assertNull($attributes->get('user.email'));
$this->assertNull($attributes->get('user.name'));
}

public function testFlushesImmediatelyWhenThresholdIsReached(): void
{
StubTransport::$events = [];
Expand Down
Loading