telemetry package (#1)

Co-authored-by: Derek Misler <derek.misler@docker.com>

Author: dgageot

.github/workflows/ci.yml

@@ -47,6 +47,11 @@ jobs:
 
       - name: Run tests
         run: task test
+        env:
+          TELEMETRY_ENABLED: true
+          TELEMETRY_API_KEY: ${{ secrets.TELEMETRY_API_KEY }}
+          TELEMETRY_ENDPOINT: ${{ secrets.TELEMETRY_ENDPOINT }}
+          TELEMETRY_HEADER: ${{ secrets.TELEMETRY_HEADER }}
 
   license-check:
     runs-on: ubuntu-latest
@@ -87,3 +92,8 @@ jobs:
 
       - name: Build
         run: task build
+        env:
+          TELEMETRY_ENABLED: true
+          TELEMETRY_API_KEY: ${{ secrets.TELEMETRY_API_KEY }}
+          TELEMETRY_ENDPOINT: ${{ secrets.TELEMETRY_ENDPOINT }}
+          TELEMETRY_HEADER: ${{ secrets.TELEMETRY_HEADER }}

README.md

@@ -52,7 +52,7 @@ Many examples can be found [here](/examples/README.md)!
 
 [Prebuilt binaries](https://github.com/docker/cagent/releases) for Windows, macOS and Linux can be found on the releases page of the [project's GitHub repository](https://github.com/docker/cagent/releases)
 
-Once you've downloaded the appropriate binary for your platform, you may need to give it executable permissions.  
+Once you've downloaded the appropriate binary for your platform, you may need to give it executable permissions.
 On macOS and Linux, this is done with the following command:
 
 ```sh
@@ -78,7 +78,7 @@ export ANTHROPIC_API_KEY=your_api_key_here
 export GOOGLE_API_KEY=your_api_key_here
 ```
 
-###  Run Agents!
+### Run Agents!
 
 ```bash
 # Run an agent!
@@ -188,11 +188,13 @@ cagent pull agentcatalog/pirate
 
 `cagent run agentcatalog_pirate.yaml` will run your newly pulled agent
 
-
 ## Usage
 
 More details on the usage and configuration of `cagent` can be found in [USAGE.md](/docs/USAGE.md)
 
+## Telemetry
+
+We track anonymous usage data to improve the tool. See [TELEMETRY.md](/docs/TELEMETRY.md) for details.
 
 ## Contributing
 

cmd/root/api.go

@@ -8,6 +8,7 @@ import (
 
 	"github.com/spf13/cobra"
 
+	"github.com/docker/cagent/internal/telemetry"
 	latest "github.com/docker/cagent/pkg/config/v1"
 	"github.com/docker/cagent/pkg/server"
 	"github.com/docker/cagent/pkg/session"
@@ -28,6 +29,7 @@ func NewApiCmd() *cobra.Command {
 		Long:  `Start the API server that exposes the agent via an HTTP API`,
 		Args:  cobra.ExactArgs(1),
 		RunE: func(cmd *cobra.Command, args []string) error {
+			telemetry.TrackCommand("api", args)
 			return runHttp(cmd, false, args)
 		},
 	}

cmd/root/catalog.go

@@ -10,6 +10,7 @@ import (
 	"text/tabwriter"
 	"time"
 
+	"github.com/docker/cagent/internal/telemetry"
 	"github.com/spf13/cobra"
 )
 
@@ -34,6 +35,10 @@ func newCatalogListCmd() *cobra.Command {
 		Short: "List catalog entries",
 		Args:  cobra.MaximumNArgs(1),
 		RunE: func(cmd *cobra.Command, args []string) error {
+			// Track catalog list with "list" as the first argument for telemetry
+			telemetryArgs := append([]string{"list"}, args...)
+			telemetry.TrackCommand("catalog", telemetryArgs)
+
 			var org string
 			if len(args) == 0 {
 				org = "agentcatalog"

cmd/root/eval.go

@@ -5,6 +5,7 @@ import (
 
 	"github.com/spf13/cobra"
 
+	"github.com/docker/cagent/internal/telemetry"
 	"github.com/docker/cagent/pkg/evaluation"
 	"github.com/docker/cagent/pkg/teamloader"
 )
@@ -23,6 +24,8 @@ func NewEvalCmd() *cobra.Command {
 }
 
 func runEvalCommand(cmd *cobra.Command, args []string) error {
+	telemetry.TrackCommand("eval", args)
+
 	agents, err := teamloader.Load(cmd.Context(), args[0], runConfig)
 	if err != nil {
 		return err

cmd/root/feedback.go

@@ -3,6 +3,7 @@ package root
 import (
 	"fmt"
 
+	"github.com/docker/cagent/internal/telemetry"
 	"github.com/spf13/cobra"
 )
 
@@ -15,6 +16,7 @@ func NewFeedbackCmd() *cobra.Command {
 		Short: "Send feedback about cagent",
 		Long:  `Submit feedback or report issues with cagent`,
 		Run: func(cmd *cobra.Command, args []string) {
+			telemetry.TrackCommand("feedback", args)
 			fmt.Println("Feel free to give feedback:\n", FeedbackLink)
 		},
 	}

cmd/root/mcp.go

@@ -9,6 +9,7 @@ import (
 	"syscall"
 	"time"
 
+	"github.com/docker/cagent/internal/telemetry"
 	"github.com/docker/cagent/pkg/mcpserver"
 	"github.com/docker/cagent/pkg/servicecore"
 	"github.com/spf13/cobra"
@@ -42,7 +43,9 @@ and maintain conversational sessions.`,
 	return cmd
 }
 
-func runMCPCommand(*cobra.Command, []string) error {
+func runMCPCommand(_ *cobra.Command, args []string) error {
+	telemetry.TrackCommand("mcp", args)
+
 	// Default agents directory to current working directory if not specified
 	resolvedAgentsDir := agentsDir
 	if resolvedAgentsDir == "" {

cmd/root/new.go

@@ -9,6 +9,7 @@ import (
 	"github.com/spf13/cobra"
 
 	"github.com/docker/cagent/internal/creator"
+	"github.com/docker/cagent/internal/telemetry"
 	"github.com/docker/cagent/pkg/runtime"
 )
 
@@ -21,6 +22,8 @@ func NewNewCmd() *cobra.Command {
 		Short: "Create a new agent configuration",
 		Long:  `Create a new agent configuration by asking questions and generating a YAML file`,
 		RunE: func(cmd *cobra.Command, args []string) error {
+			telemetry.TrackCommand("new", args)
+
 			ctx := cmd.Context()
 
 			var model string         // final model name

cmd/root/pull.go

@@ -7,6 +7,7 @@ import (
 	"path/filepath"
 	"strings"
 
+	"github.com/docker/cagent/internal/telemetry"
 	"github.com/docker/cagent/pkg/remote"
 	"github.com/google/go-containerregistry/pkg/crane"
 	"github.com/spf13/cobra"
@@ -19,6 +20,7 @@ func NewPullCmd() *cobra.Command {
 		Long:  `Pull an artifact from Docker Hub`,
 		Args:  cobra.ExactArgs(1),
 		RunE: func(cmd *cobra.Command, args []string) error {
+			telemetry.TrackCommand("pull", args)
 			return runPullCommand(args[0])
 		},
 	}

cmd/root/push.go

@@ -4,6 +4,7 @@ import (
 	"fmt"
 	"log/slog"
 
+	"github.com/docker/cagent/internal/telemetry"
 	"github.com/docker/cagent/pkg/content"
 	"github.com/docker/cagent/pkg/oci"
 	"github.com/docker/cagent/pkg/remote"
@@ -21,6 +22,7 @@ The local identifier can be either a reference (tag) or a digest that was return
 from the build command.`,
 		Args: cobra.ExactArgs(2),
 		RunE: func(cmd *cobra.Command, args []string) error {
+			telemetry.TrackCommand("push", args)
 			return runPushCommand(args[0], args[1])
 		},
 	}