Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add cmd-exec-id to user agent #1808

Merged
merged 9 commits into from
Nov 1, 2024
Merged

Add cmd-exec-id to user agent #1808

merged 9 commits into from
Nov 1, 2024

Conversation

shreyas-goenka
Copy link
Contributor

@shreyas-goenka shreyas-goenka commented Oct 4, 2024

Changes

This PR adds the cmd-exec-id field to the user agent. This allows us to correlate multiple HTTP requests made from the CLI.

Why Not Use HTTP traceparent?

We considered using the traceparent header in HTTP as an alternative, but it's not a good fit for our use case. Here's why:

  1. Purpose of traceparent: It's designed to trace a single HTTP request across a distributed system as it moves through subsystems and proxies.
  2. Our requirement: We need to trace multiple HTTP requests made during a single command execution in the CLI.

For more details about how traceparent itself works and how it's used in the Go SDK, see databricks/databricks-sdk-go#914.

Tests

Unit test

@pietern
Copy link
Contributor

pietern commented Oct 17, 2024

With an alternative in the works, shall we skip this?

@shreyas-goenka
Copy link
Contributor Author

@pietern I have not yet looked into Traceparent. I'll followup on this and close it once I verify it would work.

@shreyas-goenka
Copy link
Contributor Author

shreyas-goenka commented Oct 30, 2024

@shreyas-goenka shreyas-goenka marked this pull request as ready for review October 30, 2024 15:14
cmd/root/user_agent_command.go Outdated Show resolved Hide resolved
cmd/root/user_agent_upstream_test.go Outdated Show resolved Hide resolved
@shreyas-goenka shreyas-goenka changed the title Add trace id to user agent to correlate API calls for the same command execution Add cmd-exec-id to user agent to correlate API calls from the same command execution Oct 31, 2024
cmd/root/root.go Outdated Show resolved Hide resolved
cmd/root/user_agent_command_exec_id.go Outdated Show resolved Hide resolved
cmd/root/user_agent_command_exec_id.go Outdated Show resolved Hide resolved
@eng-dev-ecosystem-bot
Copy link
Collaborator

Test Details: go/deco-tests/11613171225

@pietern pietern changed the title Add cmd-exec-id to user agent to correlate API calls from the same command execution Add cmd-exec-id to user agent Nov 1, 2024
Copy link
Contributor

@pietern pietern left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The change LGTM. Please update the PR summary. If you want to keep the discussion about traceparent around, it should move to its own section. Now it reads as if this PR has any bearing on traceparent, but it doesn't.

@shreyas-goenka shreyas-goenka added this pull request to the merge queue Nov 1, 2024
Merged via the queue into main with commit f3bf33d Nov 1, 2024
10 checks passed
@shreyas-goenka shreyas-goenka deleted the cmd-uuid branch November 1, 2024 14:15
andrewnester added a commit that referenced this pull request Nov 6, 2024
CLI:
 * Clean host URL in the `auth login` command ([#1879](#1879)).

Bundles:
 * Fix bundle run when run interactively ([#1880](#1880)).
 * Fix relative path resolution for dashboards on Windows ([#1881](#1881)).

Internal:
 * Address goreleaser deprecation warning ([#1872](#1872)).
 * Update actions/github-script to v7 ([#1873](#1873)).
 * Use Go 1.23 ([#1871](#1871)).
 * [Internal] Always write message for manual integration test trigger ([#1874](#1874)).
 * Add `cmd-exec-id` to user agent ([#1808](#1808)).
 * Added E2E test to run Python wheels on interactive cluster created in bundle ([#1864](#1864)).

Dependency updates:
 * Bump github.com/hashicorp/terraform-json from 0.22.1 to 0.23.0 ([#1877](#1877)).
github-merge-queue bot pushed a commit that referenced this pull request Nov 6, 2024
CLI:
* Clean host URL in the `auth login` command
([#1879](#1879)).

Bundles:
* Fix bundle run when run interactively
([#1880](#1880)).
* Fix relative path resolution for dashboards on Windows
([#1881](#1881)).

Internal:
* Address goreleaser deprecation warning
([#1872](#1872)).
* Update actions/github-script to v7
([#1873](#1873)).
 * Use Go 1.23 ([#1871](#1871)).
* [Internal] Always write message for manual integration test trigger
([#1874](#1874)).
* Add `cmd-exec-id` to user agent
([#1808](#1808)).
* Added E2E test to run Python wheels on interactive cluster created in
bundle ([#1864](#1864)).


Dependency updates:
* Bump github.com/hashicorp/terraform-json from 0.22.1 to 0.23.0
([#1877](#1877)).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants