Šķîþ ţö ḿàîñ çöñţéñţ

Ţéļéḿéţŕý

Ŕéļéàšé ƃüîļđš öƒ ţĥé kapi ÇĻÎ çöļļéçţ à šḿàļļ àḿöüñţ öƒ àñöñýḿöüš üšàĝé ţéļéḿéţŕý (ŵĥîçĥ ƃüîļţ-îñ çöḿḿàñđš àŕé ŕüñ, ĥöŵ ļöñĝ ţĥéý ţàķé, îñ çöàŕšé ƃüçķéţš, àñđ ŵĥéţĥéŕ ţĥéý šüççééđ) ţö ĝüîđé đéṽéļöþḿéñţ þŕîöŕîţîéš. Ţĥîš þàĝé îš ţĥé çöḿþļéţé îñṽéñţöŕý: éṽéŕý éṽéñţ, éṽéŕý þŕöþéŕţý, ţĥé þŕîṽàçý îñṽàŕîàñţš, àñđ éṽéŕý ḿéçĥàñîšḿ ƒöŕ ţüŕñîñĝ îţ öƒƒ.

Ţéļéḿéţŕý îš öþţ-öüţ: îţ îš éñàƃļéđ ƃý đéƒàüļţ îñ öƒƒîçîàļ ŕéļéàšé ƃîñàŕîéš, đîšçļöšéđ ƃý à öñé-ţîḿé ñöţîçé öñ ƒîŕšţ üšé, àñđ đîšàƃļéđ ƃý àñý öƒ ţĥé šŵîţçĥéš ƃéļöŵ. Ƃüîļđš ýöü çöḿþîļé ýöüŕšéļƒ çàŕŕý ñö ŕéþöŕţîñĝ ķéý àñđ šéñđ ñöţĥîñĝ.

Ŵĥàţ îš çöļļéçţéđ

Ţŵö éṽéñţš éẋîšţ. Ţĥéŕé àŕé ñö öţĥéŕš.

ÉṽéñţŴĥéñÞŕöþéŕţîéš
cli_first_runÖñçé, àţ ţĥé ḿöḿéñţ ţĥé ƒîŕšţ-ŕüñ ñöţîçé îš þŕîñţéđçöḿḿöñ þŕöþéŕţîéš öñļý
cli_command_runÀƒţéŕ à ţöþ-ļéṽéļ çöḿḿàñđ çöḿþļéţéšcommand, duration_bucket, exit_class, þļüš ţĥé çöḿḿöñ þŕöþéŕţîéš

Çöḿḿöñ þŕöþéŕţîéš öñ éṽéŕý éṽéñţ: app_version (ţĥé kapi ṽéŕšîöñ), os (é.ĝ. darwin), arch (é.ĝ. arm64), àñđ surface (cli).

Þŕöþéŕţý ṽàļüéš àŕé ŕéšţŕîçţéđ ţö ƒîẋéđ ṽöçàƃüļàŕîéš:

  • command: ţĥé ñàḿé öƒ ţĥé çöḿḿàñđ ţĥàţ ŕàñ, ƃüţ öñļý ƒöŕ kapi'š ƃüîļţ-îñ ṽéŕƃš (ƒöŕ šüƃçöḿḿàñđš, ţĥé đöţţéđ þàţĥ, é.ĝ. memory.import). À çöḿḿàñđ çöñţŕîƃüţéđ ƃý à þļüĝîñ îš ŕéþöŕţéđ àš ţĥé ļîţéŕàļ šţŕîñĝ plugin; à ṽéŕƃ ţĥàţ ḿàţçĥéđ ñöţĥîñĝ îš ŕéþöŕţéđ àš other; à ƃàŕé kapi îñṽöçàţîöñ îš ŕéþöŕţéđ àš root. Þļüĝîñ àñđ üñķñöŵñ ṽéŕƃ ñàḿéš àŕé ñéṽéŕ ţŕàñšḿîţţéđ.
  • duration_bucket: öñé öƒ <100ms, <1s, <10s, <60s, >=60s. Ţĥé éẋàçţ đüŕàţîöñ îš ñöţ ŕéþöŕţéđ.
  • exit_class: ok, error, öŕ usage.

Éṽéñţš àŕé ķéýéđ ƃý à šîñĝļé îđéñţîƒîéŕ: à ŕàñđöḿ ÜÜÎĐ ĝéñéŕàţéđ öñ ţĥé ḿàçĥîñé ţĥé ƒîŕšţ ţîḿé ţéļéḿéţŕý îš éļîĝîƃļé ţö ŕüñ, šţöŕéđ üñđéŕ ţĥé telemetry.machine_id ķéý îñ ţĥé àþþ çöñƒîĝüŕàţîöñ ƒîļé (kapi.yaml îñ ţĥé üšéŕ çöñƒîĝ đîŕéçţöŕý (~/.config/kapi öñ Ļîñüẋ, ~/Library/Application Support/kapi öñ ḿàçÖŠ). kapi config path þŕîñţš ţĥé ŕéšöļṽéđ ļöçàţîöñ. Îţ éñçöđéš ñöţĥîñĝ (ñéîţĥéŕ ţĥé ĥöšţñàḿé, ţĥé üšéŕñàḿé, ñöŕ àñý ĥàŕđŵàŕé îđéñţîƒîéŕ), àñđ đéļéţîñĝ îţ çàüšéš à ñéŵ ŕàñđöḿ öñé ţö ƃé ĝéñéŕàţéđ.

kapi telemetry status þŕîñţš ţĥé çüŕŕéñţ šţàţé, ţĥé ŕéàšöñ ŵĥéñ đîšàƃļéđ, àñđ ţĥîš þàýļöàđ šĥàþé.

Ŵĥàţ îš ñéṽéŕ çöļļéçţéđ

Üñđéŕ ñö çîŕçüḿšţàñçéš đö éṽéñţš çöñţàîñ:

  • çöḿḿàñđ àŕĝüḿéñţš öŕ ƒļàĝ ṽàļüéš,
  • ƒîļé þàţĥš, ƒîļé çöñţéñţš, öŕ àñý éẋţŕàçţéđ ţéẋţ,
  • þŕöĵéçţ ñàḿéš öŕ ŕéçîþé çöñţéñţš,
  • ĥöšţñàḿéš, üšéŕñàḿéš, ÎÞ-đéŕîṽéđ ĝéöļöçàţîöñ ƃéýöñđ ŵĥàţ àñý ĤŢŢÞ ŕéǫüéšţ ŕéṽéàļš, öŕ àñý öţĥéŕ þéŕšöñàļ îñƒöŕḿàţîöñ.

Ĥéļþ àñđ šĥéļļ-çöḿþļéţîöñ îñṽöçàţîöñš (--help, kapi help, kapi completion, àñđ ţĥé ĥîđđéñ çöḿþļéţîöñ ḿàçĥîñéŕý) éḿîţ ñöţĥîñĝ, àñđ ţĥé kapi telemetry çöḿḿàñđ ĝŕöüþ îţšéļƒ îš ñéṽéŕ ŕéþöŕţéđ.

Ţüŕñîñĝ îţ öƒƒ

Ţéļéḿéţŕý îš đîšàƃļéđ ŵĥéñ àñý öƒ ţĥé ƒöļļöŵîñĝ ĥöļđš; ţĥé šŵîţçĥéš çöḿþöšé àš à ļàţţîçé ŵĥéŕé àñý šîñĝļé öñé ŵîñš:

ŠŵîţçĥŠçöþé
kapi telemetry offÞéŕšîšţéđ îñ ţĥé kapi çöñƒîĝüŕàţîöñ ƒîļé; kapi telemetry on ŕéṽéŕšéš îţ
KAPI_TELEMETRY=0 (öŕ false)Éñṽîŕöñḿéñţ, þéŕ îñṽöçàţîöñ öŕ éẋþöŕţéđ
DO_NOT_TRACK=1 (àñý ñöñ-éḿþţý ṽàļüé öţĥéŕ ţĥàñ 0)Ţĥé çŕöšš-ţööļ çöñšöļé çöñṽéñţîöñ
CI šéţ îñ ţĥé éñṽîŕöñḿéñţÀüţöḿàţîç; ÇÎ ŕüñš ñéṽéŕ ŕéþöŕţ
Ƃüîļţ ŵîţĥ -tags notelemetryÇöḿþîļé-ţîḿé: ţĥé éñţîŕé çļîéñţ îš éẋçļüđéđ ƒŕöḿ ţĥé ƃîñàŕý
Ñö ŕéþöŕţîñĝ ķéý îñ ţĥé ƃüîļđÀüţöḿàţîç; šöüŕçé ƃüîļđš àñđ đéṽéļöþḿéñţ ƃüîļđš šéñđ ñöţĥîñĝ

Đîšàƃļéđ ḿéàñš đîšàƃļéđ: ñö éṽéñţš àŕé šéñţ, ñö ƒîŕšţ-ŕüñ ñöţîçé îš šĥöŵñ, àñđ ñö îđéñţîƒîéŕ îš ĝéñéŕàţéđ.

Đéļîṽéŕý

Éṽéñţš àŕé ǫüéüéđ îñ ḿéḿöŕý àñđ þöšţéđ îñ ţĥé ƃàçķĝŕöüñđ ţö à Éüŕöþéàñ Üñîöñ ÞöšţĤöĝ îñĝéšţîöñ éñđþöîñţ. Đéļîṽéŕý îš ƃéšţ-郃öŕţ àñđ ƒîŕé-àñđ-ƒöŕĝéţ: à ƒàîļéđ öŕ šļöŵ ŕéǫüéšţ îš šîļéñţļý đŕöþþéđ, ţĥé ƒļüšĥ àţ þŕöçéšš éẋîţ ŵàîţš àţ ḿöšţ 100 ḿîļļîšéçöñđš, àñđ ţéļéḿéţŕý çàñ ñéṽéŕ ƃļöçķ, šļöŵ đöŵñ (ƃéýöñđ ţĥàţ ƃöüñđ), öŕ ƒàîļ à çöḿḿàñđ.

Ţĥé ƒîŕšţ-ŕüñ ñöţîçé

Ţĥé ƒîŕšţ ţîḿé àñ éļîĝîƃļé çöḿḿàñđ ŕüñš îñ àñ éñàƃļéđ ƃüîļđ, kapi þŕîñţš à šĥöŕţ ñöţîçé ţö šţđéŕŕ šţàţîñĝ ŵĥàţ îš çöļļéçţéđ, ŵĥàţ ñéṽéŕ îš, ţĥé öþţ-öüţ šŵîţçĥéš, àñđ à ļîñķ ţö ţĥîš þàĝé. Îţ îš þŕîñţéđ éẋàçţļý öñçé àñđ ŕéçöŕđéđ îñ ţĥé çöñƒîĝüŕàţîöñ ƒîļé (telemetry.notice_shown). Îñéļîĝîƃļé ŕüñš (ĥéļþ, çöḿþļéţîöñ, öŕ àñý ŕüñ ŵîţĥ ţéļéḿéţŕý đîšàƃļéđ) ñéîţĥéŕ šĥöŵ ţĥé ñöţîçé ñöŕ çöñšüḿé îţ.