Skip to content

PIR: V1 observability pixels #7102

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
karlenDimla merged 8 commits into from
Nov 17, 2025
Merged

PIR: V1 observability pixels #7102

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c6164f9
Add pixel definition for Opt-out submission success rate
karlenDimla Nov 7, 2025
2205f6b
Add new pixels and remove old one
karlenDimla Nov 7, 2025
d449999
Integrate new pixels for Opt-out submission success rate
karlenDimla Nov 10, 2025
a508940
Use attemptCount for tries
karlenDimla Nov 10, 2025
dc8a445
Pass correct email pattern
karlenDimla Nov 10, 2025
937917c
Fix tests
karlenDimla Nov 10, 2025
09cf67d
Change pixel prefix to dbp
karlenDimla Nov 10, 2025
3cab8ea
PIR: Implement OptOut custom stats (#7103)
karlenDimla Nov 17, 2025
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
264 changes: 264 additions & 0 deletions PixelDefinitions/pixels/personal_information_removal.json5
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,264 @@
{
"dbp_optout_process_submit-success": {
"description": "Fired when an opt-out submission succeeds.",
"owners": ["karlenDimla", "landomen"],
"triggers": ["other"],
"suffixes": ["form_factor"],
"parameters": [
"appVersion",
{
"key": "data_broker",
"description": "The URL of the data broker that this opt-out attempt targets",
"type": "string"
},
{
"key": "parent",
"description": "The parent data broker of the one this opt-out attempt targets",
"type": "string"
},
{
"key": "attempt_id",
"description": "Client-generated ID of the opt-out attempt",
"type": "string"
},
{
"key": "duration",
"description": "Total duration of the opt-out attempt in milliseconds",
"type": "string"
},
{
"key": "tries",
"description": "The number of tries it took to submit successfully",
"type": "string"
},
{
"key": "pattern",
"description": "Email pattern used during submission, when available",
"type": "string"
},
{
"key": "vpn_connection_state",
"description": "Reported VPN connection state when the submission succeeded",
"type": "string"
},
{
"key": "vpn_bypass",
"description": "VPN bypass status when the submission succeeded",
"type": "string",
"enum": ["on", "off", "unsupported"]
}
]
},
"dbp_optout_process_failure": {
"description": "Fired when an opt-out attempt fails.",
"owners": ["karlenDimla", "landomen"],
"triggers": ["other"],
"suffixes": ["form_factor"],
"parameters": [
"appVersion",
{
"key": "data_broker",
"description": "The URL of the data broker that this opt-out attempt targets",
"type": "string"
},
{
"key": "parent",
"description": "The parent data broker of the one this opt-out attempt targets",
"type": "string"
},
{
"key": "broker_version",
"description": "The version of the broker JSON file",
"type": "string"
},
{
"key": "attempt_id",
"description": "Client-generated ID of the opt-out attempt",
"type": "string"
},
{
"key": "duration",
"description": "Total duration of the opt-out attempt in milliseconds",
"type": "string"
},
{
"key": "stage",
"description": "The stage where the failure occurred",
"type": "string"
},
{
"key": "tries",
"description": "The number of tries recorded when the failure happened",
"type": "string"
},
{
"key": "pattern",
"description": "Email pattern used during the attempt, when available",
"type": "string"
},
{
"key": "action_id",
"description": "Predefined identifier of the broker action that failed",
"type": "string"
},
{
"key": "action_type",
"description": "Type of action that failed",
"type": "string",
"enum": [
"extract",
"navigate",
"fillForm",
"click",
"expectation",
"emailConfirmation",
"getCaptchaInfo",
"solveCaptcha",
"condition"
]
},
{
"key": "vpn_connection_state",
"description": "Reported VPN connection state when the failure happened",
"type": "string"
},
{
"key": "vpn_bypass",
"description": "VPN bypass status when the failure happened",
"type": "string",
"enum": ["on", "off", "unsupported"]
}
]
},
"dbp_databroker_custom_stats_optoutsubmit": {
"description": "Pixel that contains a broker's opt-out 24h submission success rate.",
"owners": ["karlenDimla", "landomen"],
"triggers": ["other"],
"suffixes": ["form_factor"],
"parameters": [
"appVersion",
{
"key": "data_broker",
"description": "The URL of the data broker that this opt-out attempt targets",
"type": "string"
},
{
"key": "optout_submit_success_rate",
"description": "The success rate of how many opt-out jobs successfully requested within 24 hours of creation",
"type": "string"
}
]
},
"dbp_optoutjob_at-7-days_confirmed": {
"description": "Pixel that contains if any submitted opt-out has been confirmed 7 days after submission.",
"owners": ["karlenDimla", "landomen"],
"triggers": ["other"],
"suffixes": ["form_factor"],
"parameters": [
"appVersion",
{
"key": "data_broker",
"description": "The URL of the data broker that has a confirmed opt-out after 7 days",
"type": "string"
}
]
},
"dbp_optoutjob_at-7-days_unconfirmed": {
"description": "Pixel that contains if any submitted opt-out are still unconfirmed 7 days after submission.",
"owners": ["karlenDimla", "landomen"],
"triggers": ["other"],
"suffixes": ["form_factor"],
"parameters": [
"appVersion",
{
"key": "data_broker",
"description": "The URL of the data broker that has an unconfirmed opt-out after 7 days",
"type": "string"
}
]
},
"dbp_optoutjob_at-14-days_confirmed": {
"description": "Pixel that contains if any submitted opt-out has been confirmed 14 days after submission.",
"owners": ["karlenDimla", "landomen"],
"triggers": ["other"],
"suffixes": ["form_factor"],
"parameters": [
"appVersion",
{
"key": "data_broker",
"description": "The URL of the data broker that has a confirmed opt-out after 14 days",
"type": "string"
}
]
},
"dbp_optoutjob_at-14-days_unconfirmed": {
"description": "Pixel that contains if any submitted opt-out are still unconfirmed 14 days after submission.",
"owners": ["karlenDimla", "landomen"],
"triggers": ["other"],
"suffixes": ["form_factor"],
"parameters": [
"appVersion",
{
"key": "data_broker",
"description": "The URL of the data broker that has an unconfirmed opt-out after 14 days",
"type": "string"
}
]
},
"dbp_optoutjob_at-21-days_confirmed": {
"description": "Pixel that contains if any submitted opt-out has been confirmed 21 days after submission.",
"owners": ["karlenDimla", "landomen"],
"triggers": ["other"],
"suffixes": ["form_factor"],
"parameters": [
"appVersion",
{
"key": "data_broker",
"description": "The URL of the data broker that has a confirmed opt-out after 21 days",
"type": "string"
}
]
},
"dbp_optoutjob_at-21-days_unconfirmed": {
"description": "Pixel that contains if any submitted opt-out are still unconfirmed 21 days after submission.",
"owners": ["karlenDimla", "landomen"],
"triggers": ["other"],
"suffixes": ["form_factor"],
"parameters": [
"appVersion",
{
"key": "data_broker",
"description": "The URL of the data broker that has an unconfirmed opt-out after 21 days",
"type": "string"
}
]
},
"dbp_optoutjob_at-42-days_confirmed": {
"description": "Pixel that contains if any submitted opt-out has been confirmed 42 days after submission.",
"owners": ["karlenDimla", "landomen"],
"triggers": ["other"],
"suffixes": ["form_factor"],
"parameters": [
"appVersion",
{
"key": "data_broker",
"description": "The URL of the data broker that has a confirmed opt-out after 42 days",
"type": "string"
}
]
},
"dbp_optoutjob_at-42-days_unconfirmed": {
"description": "Pixel that contains if any submitted opt-out are still unconfirmed 42 days after submission.",
"owners": ["karlenDimla", "landomen"],
"triggers": ["other"],
"suffixes": ["form_factor"],
"parameters": [
"appVersion",
{
"key": "data_broker",
"description": "The URL of the data broker that has an unconfirmed opt-out after 42 days",
"type": "string"
}
]
}
}
1 change: 1 addition & 0 deletions pir/pir-impl/build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ dependencies {
testImplementation AndroidX.test.ext.junit
testImplementation Testing.robolectric
testImplementation "androidx.lifecycle:lifecycle-runtime-testing:_"
testImplementation AndroidX.work.testing
testImplementation(KotlinX.coroutines.test) {
// https://github.com/Kotlin/kotlinx.coroutines/issues/2023
// conflicts with mockito due to direct inclusion of byte buddy
Expand Down
Loading
Loading