runtime: Correct naming & docs for version checking by charlieegan3 · Pull Request #8191 · open-policy-agent/opa

charlieegan3 · 2026-01-07T18:25:15Z

Rename telemetry functionality to version checking to accurately reflect current behavior following
#7756.

The system only checks GitHub releases for version updates without sending any data about the OPA instance and so the privacy docs have been updated too.

…/opa remove-telemetry-leftovers ✗ go run main.go run -s
{"addrs":["localhost:8181"],"diagnostic-addrs":[],"level":"info","msg":"Initializing server.","time":"2026-01-07T18:23:50Z"}
{"current_version":"1.11.0-dev","download_opa":"https://openpolicyagent.org/downloads/v1.12.2/opa_darwin_arm64_static","latest_version":"1.12.2","level":"info","msg":"OPA is out of date.","release_notes":"https://github.com/open-policy-agent/opa/releases/tag/v1.12.2","time":"2026-01-07T18:23:50Z"}
^C{"level":"info","msg":"Shutting down...","time":"2026-01-07T18:23:53Z"}
{"level":"info","msg":"Server shutdown.","time":"2026-01-07T18:23:53Z"}

…/opa remove-telemetry-leftovers ✗ go run main.go run -s --skip-version-check
{"addrs":["localhost:8181"],"diagnostic-addrs":[],"level":"info","msg":"Initializing server.","time":"2026-01-07T18:23:59Z"}
^C{"level":"info","msg":"Shutting down...","time":"2026-01-07T18:24:01Z"}
{"level":"info","msg":"Server shutdown.","time":"2026-01-07T18:24:01Z"}

Fixes #8093

charlieegan3 · 2026-01-07T18:25:43Z

.github/workflows/post-merge.yaml

        run: make ci-build-windows ci-go-ci-build-linux ci-go-ci-build-linux-static
        timeout-minutes: 30
-        env:
-          TELEMETRY_URL: ${{ secrets.TELEMETRY_URL }}


I understand these are no longer needed since we have a GitHub.com default now.

charlieegan3 · 2026-01-07T18:26:33Z

cmd/run.go

 	tlsCertRefresh       time.Duration
 	ignore               []string
 	serverMode           bool
-	skipVersionCheck     bool // skipVersionCheck is deprecated. Use disableTelemetry instead


This field used to be deprecated before the telemetry feature was originally implemented, back in ~0.20, but I think it makes sense to go back to using this flag now since it's still here and is well named.

charlieegan3 · 2026-01-07T18:27:29Z

cmd/run.go

-	// For backwards compatibility, check if `--skip-version-check` flag set.
-	if params.skipVersionCheck {
+	// For backwards compatibility, check if deprecated `--disable-telemetry` flag set.
+	if params.disableTelemetry {


I think we need to support this path for some time as this same commit deprecates the flag.

charlieegan3 · 2026-01-07T18:28:02Z

docs/docs/contrib-development.md

 | DOCKER_USER                | Docker username for uploading release images. Will be used with `docker login`. Optional -- If not provided the image push steps are skipped.                   |
 | DOCKER_PASSWORD            | Docker password or API token for the configured `DOCKER_USER`. Will be used with `docker login`. Optional -- If not provided the image push steps are skipped.  |
 | SLACK_NOTIFICATION_WEBHOOK | Slack webhook for sending notifications. Optional -- If not provided the notification steps are skipped.                                                        |
-| TELEMETRY_URL              | URL to inject at build-time for OPA version reporting. Optional -- If not provided the default value in OPA's source is used.                                   |


This is still set in GH, but I not used and should be removed after merge.

netlify · 2026-01-07T18:28:17Z

✅ Deploy Preview for openpolicyagent ready!

Name	Link
🔨 Latest commit	`a0ba825`
🔍 Latest deploy log	https://app.netlify.com/projects/openpolicyagent/deploys/695f83dda394c30008004733
😎 Deploy Preview	https://deploy-preview-8191--openpolicyagent.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

charlieegan3 · 2026-01-07T18:28:27Z

docs/docs/privacy.md

-User-Agent: "Open Policy Agent/v0.12.3 (darwin, amd64)"
+GET /repos/open-policy-agent/opa/releases/latest HTTP/1.1
+Host: api.github.com
+User-Agent: OPA-Version-Checker


I have updated the code to use a custom user agent with no version info.

charlieegan3 · 2026-01-07T18:32:23Z

plugins/plugins.go


-// WithTelemetryGatherers allows registration of telemetry gatherers which enable injection of additional data in the
-// telemetry report
-func WithTelemetryGatherers(gs map[string]report.Gatherer) func(*Manager) {


I removed this since it's based on an internal type. I was unsure what to do otherwise.

I thought I remembered EOPA using this, but we have ripped it all out since then. IIRC, you could provide a map[string]func(context.Context) (any, error) and it would work, regardless of the report.Gatherer type.

Ahh yeah that makes much more sense. I have made some updates in d19852e

charlieegan3 · 2026-01-07T19:48:03Z

v1/plugins/plugins.go

 		}
-		m.reporter = reporter
-
-		m.reporter.RegisterGatherer("min_compatible_version", func(_ context.Context) (any, error) {


This was used for telemetry but is no longer used as far as I can see.

srenatus

Nice cleanup, thanks a lot. And it makes so much more sense to call it "versioncheck" these days. 👍

srenatus · 2026-01-07T20:03:04Z

plugins/plugins.go


-// WithTelemetryGatherers allows registration of telemetry gatherers which enable injection of additional data in the
-// telemetry report
-func WithTelemetryGatherers(gs map[string]report.Gatherer) func(*Manager) {


I thought I remembered EOPA using this, but we have ripped it all out since then. IIRC, you could provide a map[string]func(context.Context) (any, error) and it would work, regardless of the report.Gatherer type.

srenatus · 2026-01-07T20:05:56Z

docs/src/data/cli.json

Huh, what was that about? 🤔 Ah, the change in CLI parameters. Nevermind.

srenatus

LGTM

Rename telemetry functionality to version checking to accurately reflect current behavior following open-policy-agent#7756. The system only checks GitHub releases for version updates without sending any data about the OPA instance and so the privacy docs have been updated too. Signed-off-by: Charlie Egan <charlie_egan@apple.com>

Deprecate WithTelemetryGatherers since telemetry gathering has been removed. The function now returns a no-op to maintain API compatibility without breaking existing code that might uses it. Signed-off-by: Charlie Egan <charlie_egan@apple.com>

charlieegan3 · 2026-01-08T10:16:06Z

Thanks for the review Stephan!

…t#8191) * runtime: Correct naming of version checking code Rename telemetry functionality to version checking to accurately reflect current behavior following open-policy-agent#7756. The system only checks GitHub releases for version updates without sending any data about the OPA instance and so the privacy docs have been updated too. Signed-off-by: Charlie Egan <charlie_egan@apple.com> * Make WithTelemetryGatherers a no-op Deprecate WithTelemetryGatherers since telemetry gathering has been removed. The function now returns a no-op to maintain API compatibility without breaking existing code that might uses it. Signed-off-by: Charlie Egan <charlie_egan@apple.com> --------- Signed-off-by: Charlie Egan <charlie_egan@apple.com>

charlieegan3 added the runtime label Jan 7, 2026

charlieegan3 commented Jan 7, 2026

View reviewed changes

charlieegan3 marked this pull request as draft January 7, 2026 18:32

charlieegan3 force-pushed the remove-telemetry-leftovers branch 2 times, most recently from ca9b573 to ef6110a Compare January 7, 2026 19:41

charlieegan3 changed the title ~~runtime: Correct naming of version checking code~~ runtime: Correct naming & docs for version checking Jan 7, 2026

charlieegan3 commented Jan 7, 2026

View reviewed changes

charlieegan3 force-pushed the remove-telemetry-leftovers branch 2 times, most recently from 9d303a1 to 510def7 Compare January 7, 2026 19:50

srenatus approved these changes Jan 7, 2026

View reviewed changes

charlieegan3 force-pushed the remove-telemetry-leftovers branch from 510def7 to 326d4ac Compare January 7, 2026 20:04

srenatus reviewed Jan 7, 2026

View reviewed changes

charlieegan3 force-pushed the remove-telemetry-leftovers branch from 326d4ac to f7e6e1a Compare January 7, 2026 20:06

charlieegan3 marked this pull request as ready for review January 7, 2026 20:17

srenatus approved these changes Jan 8, 2026

View reviewed changes

charlieegan3 added 2 commits January 8, 2026 10:15

Make WithTelemetryGatherers a no-op

a0ba825

Deprecate WithTelemetryGatherers since telemetry gathering has been removed. The function now returns a no-op to maintain API compatibility without breaking existing code that might uses it. Signed-off-by: Charlie Egan <charlie_egan@apple.com>

charlieegan3 enabled auto-merge (squash) January 8, 2026 10:15

charlieegan3 force-pushed the remove-telemetry-leftovers branch from d19852e to a0ba825 Compare January 8, 2026 10:15

charlieegan3 merged commit 6601188 into open-policy-agent:main Jan 8, 2026
31 checks passed

BrewTestBot mentioned this pull request Jan 29, 2026

opa 1.13.0 Homebrew/homebrew-core#265049

Merged

Conversation

charlieegan3 commented Jan 7, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

netlify bot commented Jan 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for openpolicyagent ready!

Uh oh!

charlieegan3 Jan 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

srenatus left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

srenatus Jan 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

srenatus left a comment

Choose a reason for hiding this comment

Uh oh!

charlieegan3 commented Jan 8, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

netlify bot commented Jan 7, 2026 •

edited

Loading

charlieegan3 Jan 7, 2026 •

edited

Loading

srenatus Jan 7, 2026 •

edited

Loading