Files

T

NageshbansalandGitHub 0e4e752a19 feat: introduce ledger and version (#87 )

#### Features

- Introduce ledger for gathering analytics abt usage of foundryctl
- Adds version command

Related: https://github.com/SigNoz/platform-pod/issues/1910

2026-03-30 16:07:37 +05:30

1.8 KiB

Raw Blame History

Ledger

Foundryctl maintains an anonymous usage ledger to help the SigNoz team understand how the tool is used, identify common errors, and prioritize improvements. No personally identifiable information (PII) is collected.

What is collected

Each command execution sends a single foundryctl event with the following properties:

Property	Description	Example
`command`	The command that was run	`forge`, `cast`
`platform`	Deployment platform from casting.yaml	`aws`, `docker`, `linux`
`mode`	Deployment mode	`docker`, `systemd`, `kubernetes`
`flavor`	Deployment flavor	`compose`, `binary`, `helm`
`patches_configured`	Whether patches are defined	`true` / `false`
`patch_count`	Number of patch entries	`0`, `2`
`infrastructure_enabled`	Whether IaC generation is enabled	`true` / `false`
`metastore_kind`	MetaStore backend type	`postgres`, `sqlite`
`telemetry_store_kind`	TelemetryStore backend type	`clickhouse`
`telemetry_keeper_kind`	TelemetryKeeper backend type	`clickhousekeeper`
`success`	Whether the command succeeded	`true` / `false`
`error`	Error message (on failure only)	`missing tool: docker`
`os`	Operating system	`linux`, `darwin`
`arch`	CPU architecture	`amd64`, `arm64`
`foundry_version`	foundryctl version	`0.1.0`

Identity

Events are attributed to the machine hostname as an anonymous identifier. No usernames, emails, IP addresses, or file contents are sent.

Tracked commands

All commands send the same foundryctl event, differentiated by the command property:

gauge
forge
cast
gen.examples
gen.schemas
catalog

How to disable the ledger

Per-command

Use the --no-ledger flag on any command:

foundryctl forge --no-ledger
foundryctl --no-ledger cast

1.8 KiB Raw Blame History