From a1283a157be44edb07108717bf9f29bcb012901e Mon Sep 17 00:00:00 2001 From: Nitzan Hardon Date: Thu, 19 Nov 2026 09:58:11 +0200 Subject: [PATCH] [patch] docs: Describe plugin telemetry in the README The plugin checklist asks the README to describe what the plugin sends. Add a Plugin telemetry section (what is sent, where it goes, how to turn it off) that links docs/plugin-telemetry.md, and bump the patch version as every PR to main requires. Co-Authored-By: Claude Sonnet 5.5 --- .codex-plugin/plugin.json | 2 +- README.md | 31 +++++++++++++++++++++++++++++++ package.json | 2 +- 3 files changed, 33 insertions(+), 2 deletions(-) diff --git a/.codex-plugin/plugin.json b/.codex-plugin/plugin.json index aeaf5bf..7727457 100644 --- a/.codex-plugin/plugin.json +++ b/.codex-plugin/plugin.json @@ -1,6 +1,6 @@ { "name": "jfrog", - "version": "0.1.18", + "version": "0.1.19", "description": "JFrog skills and the JFrog MCP server for Codex \u2014 interact with the JFrog Platform.", "author": { "name": "JFrog", diff --git a/README.md b/README.md index 63d2033..fd0e3b0 100644 --- a/README.md +++ b/README.md @@ -143,6 +143,37 @@ instead. An untrusted SessionStart hook is a `/hooks` step, not an init failure. --- +## Plugin telemetry + +The plugin reports a small lifecycle event so JFrog can count installs per harness and +version. This is separate from JFrog CLI usage reporting; each has its own switch. + +**When it runs.** At session start, from a hidden background process that never delays the +session and prints nothing. At most one event per session: `install` the first time, +`update` after the plugin or hooks version changes, otherwise `active` at most once a day. + +**What it sends.** The event type, a random install ID (one per OS user), the harness, the +plugin and hooks versions (on `update`, also the previous ones), the OS family, how the +JFrog Platform URL was found, and a reason code. When the event goes to the JFrog endpoint +below, it also carries your JFrog Platform's host name (without the port), if there is one. +It does not send prompts, code, file paths, usernames, emails or tokens. + +**Where it goes.** Your JFrog Platform first (`JFROG_URL`, `JF_URL`, the JFrog CLI default +server, or `telemetry.jpdUrl` in `~/.jfrog/agents-conf.json`). If none is found, or your +JFrog Platform can't be reached or turns the event away, it goes to a JFrog endpoint in the +EU (`https://pluginmetrics.jfrog.io`). The anonymous send honors `HTTPS_PROXY` and +`NO_PROXY`. + +**Local files.** `~/.jfrog/telemetry/` (install ID, per-harness receipt and backoff state). + +**Turn it off.** Set any one of `JF_AGENT_TELEMETRY_DISABLE=1`, `DO_NOT_TRACK=1`, or +`"telemetry": { "enabled": false }` in `~/.jfrog/agents-conf.json`. With telemetry off, no +event is sent and no background process starts. + +Full details: [Plugin telemetry](docs/plugin-telemetry.md). + +--- + ## Agent Package Resolution (Preview) > **Preview Notice:** This feature is in preview and licensed under the Apache License 2.0. For clarity: This software is provided "as-is" without warranty of any kind, and without support obligations or service level commitments. Behavior, APIs, conventions, and structure may change without notice between releases. JFrog makes no guarantees of backward compatibility during the preview release cycle. Use in production environments is at your own risk. diff --git a/package.json b/package.json index 92bb8ec..de7efe7 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "codex-plugin", - "version": "0.1.18", + "version": "0.1.19", "private": true, "type": "module", "description": "JFrog skills and MCP server plugin for OpenAI Codex.",