mirror of
https://github.com/lukaszraczylo/traefik-llmgateway.git
synced 2026-10-12 04:54:45 +00:00
lukaszraczylo
9dc67dedbb
Release builds send one anonymous "plugin loaded" ping per process, so the project can see roughly how many installs exist and which versions are in use. The payload is project name, version and timestamp. Nothing else leaves the pod: no identifiers, no hostname, no configuration, no provider names, no keys, no request data. Three things keep it from firing when it should not. Builds from source carry the devPluginVersion sentinel and stay silent, so developer checkouts and every test run never phone home. The ping is sent only after the plugin constructs successfully, so a rejected configuration is never counted as an install. A sync.Once holds it to one per process, because Traefik calls New once per route and oss-telemetry does not deduplicate on the client side. Operators of a release build opt out with DO_NOT_TRACK=1, OSS_TELEMETRY_DISABLED=1, or TRAEFIK_LLMGATEWAY_DISABLE_TELEMETRY=1. README.md documents the full payload and the opt-out; a plugin that phones home without saying so in its own README would be indefensible. oss-telemetry is the plugin's first non-stdlib RUNTIME dependency, which has consequences for the Yaegi gate: - vendor/ is no longer excluded from yaegi-check's GOPATH copy. It was excluded on the reasoning that it held only test-only testify and _test.go files are never interpreted. That reasoning no longer holds: leaving vendor out would make the interpreted copy fail to resolve an import the real plugin tree resolves fine, so the gate would stop representing production. - yaegi-check now stamps a fake release version into its GOPATH copy so New's telemetry gate is PASSED rather than short-circuited, and the vendored package is actually called under the interpreter. Import resolution alone is not coverage; a cross-package call into interpreted third-party code is its own risk. Telemetry is suppressed by env vars set before anything is interpreted, so the gate never emits a real ping. - A new assertion reads the version back through GET /admin/api/overview. Without it a silently failed stamp would leave the dev sentinel in place and the harness would still print OK while covering nothing. Verified by disabling the stamp and watching the gate fail. shouldSendTelemetry is split out from sendStartupTelemetry so the decision is table-testable without a network, since oss-telemetry's endpoint is deliberately not overridable from consuming code. Also brings the version-gated documentation up to date, since the same README edit touches it. The latest release is v1.0.3, so the pre-1.0 experimental warning has met its own stated condition and is replaced by a semver stability statement in README.md and dropped from .traefik.yml's catalog summary. The catalog now serves the released tags (verified: the v1.0.3 download endpoint returns 200), so the "not yet published" and "analyzer has not been run" claims are corrected, the catalog form of the static config is documented as usable, and examples/kubernetes.yaml pins v1.0.3 instead of v0.1.0.
27 lines
1.4 KiB
Go
27 lines
1.4 KiB
Go
package traefikllmgateway
|
|
|
|
// devPluginVersion is the placeholder carried by source-tree, local and
|
|
// test builds. Anonymous usage telemetry is suppressed while pluginVersion
|
|
// still reports this sentinel, so only stamped release builds emit a
|
|
// "plugin loaded" ping — a developer running the test suite, or an
|
|
// operator building from a checkout, never phones home.
|
|
const devPluginVersion = "0.0.0-dev"
|
|
|
|
// pluginVersion is the released version of this plugin. It is stamped at
|
|
// release time by ./workflow-prepare.sh (invoked by the shared go-release
|
|
// workflow before GoReleaser builds and tags), which rewrites the string
|
|
// below to the computed semver.
|
|
//
|
|
// Traefik runs this plugin under Yaegi, where the version cannot be
|
|
// resolved from build info at runtime (debug.ReadBuildInfo sees Traefik's
|
|
// build graph, not the interpreted plugin). This build-stamped constant is
|
|
// therefore the single source of truth for the version surfaced read-only
|
|
// in GET /admin/api/overview (spec §4, v0.2) and reported by anonymous
|
|
// usage telemetry (llmgateway.go). Local/dev/test builds carry the
|
|
// devPluginVersion sentinel above, since nothing has stamped them.
|
|
//
|
|
// The literal below must stay byte-identical to devPluginVersion:
|
|
// workflow-prepare.sh rewrites THIS line by name, and telemetry compares
|
|
// the two constants to decide whether the build was stamped.
|
|
const pluginVersion = "0.0.0-dev"
|