Add `cmd-exec-id` to user agent by shreyas-goenka · Pull Request #1808 · databricks/cli

shreyas-goenka · 2024-10-04T12:04:03Z

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:

Purpose of traceparent: It's designed to trace a single HTTP request across a distributed system as it moves through subsystems and proxies.
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

…d execution

pietern · 2024-10-17T13:18:17Z

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

shreyas-goenka · 2024-10-18T07:40:32Z

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

shreyas-goenka · 2024-10-30T14:57:58Z

For some social proof, the az CLI also does something similar, but to correlate the multiple telemetry logs recorded in a single CLI invocation:

https://github.com/Azure/azure-cli/blob/34dac6f0c68d053073d5bff50acaf90f2de4f0fb/src/azure-cli-core/azure/cli/core/telemetry.py#L38

https://github.com/Azure/azure-cli/blob/dev/doc/telemetry/faq.md#how-can-i-collect-customized-properties-into-cli-telemetry

eng-dev-ecosystem-bot · 2024-10-31T13:49:22Z

Test Details: go/deco-tests/11613171225

pietern

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.

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)).

## 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

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)).

Add trace id to user agent to correlate API calls for the same comman…
c92f7bd
…d execution

shreyas-goenka added 3 commits October 30, 2024 15:31

-
821627b

Merge remote-tracking branch 'origin' into cmd-uuid
e766bfe

add unit test
ce17497

shreyas-goenka temporarily deployed to test-trigger-is October 30, 2024 14:53 — with GitHub Actions Inactive

Merge remote-tracking branch 'origin' into cmd-uuid
11dad47

shreyas-goenka marked this pull request as ready for review October 30, 2024 15:14

shreyas-goenka requested review from andrewnester, mgyucht and pietern October 30, 2024 15:14

shreyas-goenka temporarily deployed to test-trigger-is October 30, 2024 15:15 — with GitHub Actions Inactive

pietern reviewed Oct 31, 2024
View reviewed changes

Comment threadcmd/root/user_agent_command.go
Comment threadcmd/root/user_agent_upstream_test.go Outdated

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 executionOct 31, 2024

address comments
941958c

shreyas-goenka temporarily deployed to test-trigger-is October 31, 2024 10:16 — with GitHub Actions Inactive

-
9302520

shreyas-goenka temporarily deployed to test-trigger-is October 31, 2024 10:17 — with GitHub Actions Inactive

-
bbc2632

shreyas-goenka temporarily deployed to test-trigger-is October 31, 2024 10:19 — with GitHub Actions Inactive

shreyas-goenka requested a review from pietern October 31, 2024 10:19

pietern reviewed Oct 31, 2024
View reviewed changes

Comment threadcmd/root/root.go
Comment threadcmd/root/user_agent_command_exec_id.go Outdated
Comment threadcmd/root/user_agent_command_exec_id.go Outdated

address comments
a7e54a2

shreyas-goenka temporarily deployed to test-trigger-is October 31, 2024 13:49 — with GitHub Actions Inactive

shreyas-goenka requested a review from pietern October 31, 2024 13:49

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 agentNov 1, 2024

pietern reviewed Nov 1, 2024
View reviewed changes

shreyas-goenka requested a review from pietern November 1, 2024 10:00

pietern approved these changes Nov 1, 2024
View reviewed changes

shreyas-goenka added this pull request to the merge queue Nov 1, 2024

Merged via the queue into main with commit f3bf33dNov 1, 2024

shreyas-goenka deleted the cmd-uuid branch November 1, 2024 14:15

andrewnester mentioned this pull request Nov 6, 2024
[Release] Release v0.233.0 #1886
Merged

Navigation Menu

Uh oh!

Add `cmd-exec-id` to user agent - #1808

Add `cmd-exec-id` to user agent#1808
shreyas-goenka merged 9 commits into
mainfrom
cmd-uuid

shreyas-goenka commented Oct 4, 2024•
edited
Loading

Uh oh!

pietern commented Oct 17, 2024

Uh oh!

shreyas-goenka commented Oct 18, 2024

Uh oh!

shreyas-goenka commented Oct 30, 2024•
edited
Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

eng-dev-ecosystem-bot commented Oct 31, 2024

Uh oh!

pietern left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

shreyas-goenka commented Oct 4, 2024• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Why Not Use HTTP traceparent?

Tests

Uh oh!

pietern commented Oct 17, 2024

Uh oh!

shreyas-goenka commented Oct 18, 2024

Uh oh!

shreyas-goenka commented Oct 30, 2024• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

eng-dev-ecosystem-bot commented Oct 31, 2024

Uh oh!

pietern left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

shreyas-goenka commented Oct 4, 2024•
edited
Loading

shreyas-goenka commented Oct 30, 2024•
edited
Loading