feat: log AI coding agents in user-agent, telemetry, and tracing #550
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,77 @@ | ||||||
| // Copyright 2022-2026 Salesforce, Inc. | ||||||
| // | ||||||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||||||
| // you may not use this file except in compliance with the License. | ||||||
| // You may obtain a copy of the License at | ||||||
| // | ||||||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||||||
| // | ||||||
| // Unless required by applicable law or agreed to in writing, software | ||||||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||||||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||||||
| // See the License for the specific language governing permissions and | ||||||
| // limitations under the License. | ||||||
|
|
||||||
| package useragent | ||||||
|
|
||||||
| import ( | ||||||
| "fmt" | ||||||
| "os" | ||||||
| "runtime" | ||||||
| "strings" | ||||||
| ) | ||||||
|
|
||||||
| // AIAgent represents a detected AI coding agent that invoked the CLI. | ||||||
| type AIAgent struct { | ||||||
| Name string | ||||||
| Entry string | ||||||
| } | ||||||
|
|
||||||
| // Detect checks environment variables to determine if the CLI is being run by | ||||||
| // an AI coding agent. Returns nil if no agent is detected. Detection priority: | ||||||
| // CLAUDECODE > CODEX_CI > GEMINI_CLI > CLINE_ACTIVE > CURSOR_AGENT > AGENT. | ||||||
| func Detect() *AIAgent { | ||||||
| switch { | ||||||
| case os.Getenv("CLAUDECODE") == "1": | ||||||
| return &AIAgent{ | ||||||
| Name: "claude-code", | ||||||
| Entry: os.Getenv("CLAUDE_CODE_ENTRYPOINT"), | ||||||
| } | ||||||
| case os.Getenv("CODEX_CI") == "1": | ||||||
| return &AIAgent{Name: "codex"} | ||||||
| case os.Getenv("GEMINI_CLI") == "1": | ||||||
| return &AIAgent{Name: "gemini-cli"} | ||||||
| case os.Getenv("CLINE_ACTIVE") == "true": | ||||||
| return &AIAgent{Name: "cline"} | ||||||
| case os.Getenv("CURSOR_AGENT") == "1": | ||||||
| return &AIAgent{Name: "cursor"} | ||||||
| case os.Getenv("AGENT") != "": | ||||||
| return &AIAgent{Name: os.Getenv("AGENT")} | ||||||
| default: | ||||||
| return nil | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| // DetectName returns the normalized name of the detected AI agent, or an empty | ||||||
| // string if no agent is detected. | ||||||
| func DetectName() string { | ||||||
|
Member
There was a problem hiding this comment.
Suggested change
🪬 question: Forgive these words but this is an unusual export for the value found I think but I also admit to not being so familiar with practices encouraged here!
Member
There was a problem hiding this comment. 🌃 ramble: It does seem solid if we're framing this as the... actual user agent though? I'm understanding more I hope! |
||||||
| if agent := Detect(); agent != nil { | ||||||
| return agent.Name | ||||||
| } | ||||||
| return "" | ||||||
| } | ||||||
|
|
||||||
| // BuildUserAgent constructs the HTTP User-Agent header value for the CLI. If an | ||||||
| // AI agent is detected, an "AI-Agent (name=..., entry=...)" suffix is appended. | ||||||
|
Comment on lines
+64
to
+65
Member
There was a problem hiding this comment. 📚 quibble: It'd be helpful to have a full example here but no blocker! |
||||||
| func BuildUserAgent(cliVersion string) string { | ||||||
| ua := fmt.Sprintf("slack-cli/%s (os: %s)", cliVersion, runtime.GOOS) | ||||||
| if agent := Detect(); agent != nil { | ||||||
| var parts []string | ||||||
| parts = append(parts, "name="+agent.Name) | ||||||
|
Member
There was a problem hiding this comment.
Suggested change
☎️ question: A ":" separator might match the |
||||||
| if agent.Entry != "" { | ||||||
| parts = append(parts, "entry="+agent.Entry) | ||||||
| } | ||||||
| ua += " AI-Agent (" + strings.Join(parts, ", ") + ")" | ||||||
| } | ||||||
| return ua | ||||||
| } | ||||||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
note: This is a new addition to our verbose logs. For a while, I've wanted to see our user-agent which is used for each API request. This may also be helpful when diagnosing user reported issues.