Skip to content

Add hook timestamp to telemetry reporting #5

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

Open
rishiy15 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add hook timestamp to telemetry reporting #5

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
22 changes: 19 additions & 3 deletions scripts/lib/telemetry.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,14 +59,24 @@ get_telemetry_dir() {
echo "${HOME}/.config/1Password/data/hook-events"
}

# Emit the `,"ts":<epoch_ms>` JSON fragment stamping when the event was
# produced, or an empty string if the clock is unreadable.
ts_json_fragment() {
local ts
ts=$(current_time_ms)
if [[ "$ts" =~ ^[0-9]+$ ]]; then
printf ',"ts":%s' "$ts"
fi
}

# Check whether the 1Password app has signaled that telemetry is enabled.
# Returns 0 (true) if the signal file exists, 1 (false) otherwise.
telemetry_consent_enabled() {
[[ -f "${HOME}/.config/1Password/telemetry-enabled" ]]
}

# Append a single JSON line to the events.jsonl file.
# Checks consent and enforces a 1MB file size cap.
# Checks consent and enforces a 1MB file size cap (drop-newest).
write_telemetry_event() {
local json_line="$1"
local event_dir
Expand Down Expand Up @@ -142,8 +152,11 @@ write_execution_event() {
local duration_bucket
duration_bucket=$(bucket_duration_ms "$duration_ms")

local ts_field
ts_field=$(ts_json_fragment)

local json_line
json_line="{\"schema\":\"agent_hook_execution\",\"hook_name\":\"${escaped_hook_name}\",\"hook_version\":\"${escaped_hook_version}\",\"client\":\"${escaped_client}\",\"event_type\":\"${escaped_event_type}\",\"decision\":\"${decision}\",\"deny_reason\":${deny_reason_json},\"duration_bucket\":\"${duration_bucket}\",\"mode\":${mode_json},\"mount_count\":${mount_count_json}}"
json_line="{\"schema\":\"agent_hook_execution\",\"hook_name\":\"${escaped_hook_name}\",\"hook_version\":\"${escaped_hook_version}\",\"client\":\"${escaped_client}\",\"event_type\":\"${escaped_event_type}\",\"decision\":\"${decision}\",\"deny_reason\":${deny_reason_json},\"duration_bucket\":\"${duration_bucket}\",\"mode\":${mode_json},\"mount_count\":${mount_count_json}${ts_field}}"

write_telemetry_event "$json_line"
}
Expand All @@ -160,8 +173,11 @@ write_install_event() {
escaped_hook_name=$(escape_json_string "$hook_name")
escaped_hook_version=$(escape_json_string "$hook_version")

local ts_field
ts_field=$(ts_json_fragment)

local json_line
json_line="{\"schema\":\"agent_hook_install\",\"client\":\"${escaped_client}\",\"hook_name\":\"${escaped_hook_name}\",\"hook_version\":\"${escaped_hook_version}\",\"install_method\":\"${install_method}\"}"
json_line="{\"schema\":\"agent_hook_install\",\"client\":\"${escaped_client}\",\"hook_name\":\"${escaped_hook_name}\",\"hook_version\":\"${escaped_hook_version}\",\"install_method\":\"${install_method}\"${ts_field}}"

write_telemetry_event "$json_line"
}
Expand Down