Skip to content

Connection errors to unauthenticated telemetry endpoint #619

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

Open
wants to merge 271 commits into
base: main
Choose a base branch
from

Conversation

saishreeeee
Copy link
Collaborator

@saishreeeee saishreeeee commented Jun 27, 2025

What type of PR is this?

  • Refactor
  • Feature
  • Bug Fix
  • Other

Description

Send error logs to the unauthenticated telemetry endpoint in case of connection/authentication errors (before TelemetryClient initialization)

How is this tested?

  • Unit tests

  • E2E Tests

  • Manually
    Tried to establish a connection with an invalid access token

      === Request Details ===
      URL: https://e2-dogfood.staging.cloud.databricks.com/telemetry-unauth
      
      Headers:
        Accept: application/json
        Content-Type: application/json
      
      Request Body Summary:
        uploadTime: 1751006386604
        items: 0 items
        protoLogs: 1 logs
      
      === Proto Logs Details ===
      
      Proto Log #1:
      {
        "frontend_log_event_id": "15cd988b-55bc-4a97-9e0b-05f6981a8487",
        "context": {
          "client_context": {
            "timestamp_millis": 1751006386604,
            "user_agent": "PyDatabricksSqlConnector/4.0.5"
          }
        },
        "entry": {
          "sql_driver_log": {
            "system_configuration": {
              "driver_version": "4.0.5",
              "os_name": "Darwin",
              "os_version": "24.5.0",
              "os_arch": "arm64",
              "runtime_name": "Python 3.11.13",
              "runtime_version": "3.11.13",
              "runtime_vendor": "CPython",
              "driver_name": "Databricks SQL Python Connector",
              "char_set_encoding": "utf-8",
              "locale_name": "en_US"
            },
            "driver_connection_params": {
              "http_path": <HTTP_PATH>,
              "mode": "THRIFT",
              "host_info": {
                "host_url": <SERVER_HOSTNAME>,
                "port": 443
              }
            },
            "error_info": {
              "error_name": "ConnectionError",
              "stack_trace": "Failed to establish connection: Error during request to server: : Invalid access token.. "
            }
          }
        }
      }
      
      === Response Details ===
      Status Code: 200
      
      Response Body:
      {
        "errors": [],
        "numSuccess": 0,
        "numProtoSuccess": 1,
        "numRealtimeSuccess": 0
      }
    
  • N/A

Related Tickets & Documents

moderakh and others added 30 commits August 25, 2022 12:04
Signed-off-by: Moe Derakhshani <[email protected]>
Signed-off-by: Moe Derakhshani <[email protected]>

my [OAuth PR](https://github.com/databricks/databricks-sql-python/runs/8005844758?check_suite_focus=true) is blocked due to dco validation (following error):
<img width="1202" alt="Screen Shot 2022-08-25 at 12 05 40 PM" src="https://user-images.githubusercontent.com/22279672/186747897-c9d57586-366f-41f9-aa66-609f2bf3911f.png">



We should try to avoid running dco for internal databricks employees:
I am trying to relax the validation based on this guideline:
https://github.com/dcoapp/app/blob/main/README.md#skipping-sign-off-for-organization-members

and here:
https://stackoverflow.com/questions/62969381/is-it-in-line-with-the-dco-that-a-github-sign-off-needs-and-publishes-full-name
Signed-off-by: Moe Derakhshani <[email protected]>
Signed-off-by: Moe Derakhshani <[email protected]>
Signed-off-by: Moe Derakhshani <[email protected]>

this is undo of #42 till we figure out how to fix dco
This PR:
* Adds the foundation for OAuth against Databricks account on AWS with BYOIDP.
* It copies one internal module that Steve Weis @sweisdb wrote for Databricks CLI (oauth.py). Once ecosystem-dev team (Serge, Pieter) build a python sdk core we will move this code to their repo as a dependency. 
* the PR provides authenticators with visitor pattern format for stamping auth-token which later is intended to be moved to the repo owned by Serge @nfx and and Pieter @pietern
Signed-off-by: Jesse Whitehouse <[email protected]>
Bump to v2.1.0 and update changelog

Signed-off-by: Jesse Whitehouse <[email protected]>
* Refactor so we can unit test `inject_parameters`
* Add unit tests for inject_parameters
* Remove inaccurate comment. Per #51, spark sql does not support escaping a single quote with a second single quote.
* Closes #51 and adds unit tests plus the integration test provided in #56

Signed-off-by: Jesse Whitehouse <[email protected]>
Co-authored-by: Courtney Holcomb (@courtneyholcomb)
Co-authored-by: @mcannamela
Signed-off-by: Jesse Whitehouse <[email protected]>
Signed-off-by: Jesse Whitehouse <[email protected]>
Signed-off-by: Jesse Whitehouse <[email protected]>
Add none check on _oauth_persistence in DatabricksOAuthProvider to avoid app crash when _oauth_persistence is None.

Signed-off-by: Jacky Hu <[email protected]>
* Support custom oauth client id and rediret port range

PySQL is used by other tools/CLIs which have own oauth client id,
we need to expose oauth_client_id and oauth_redirect_port_range
as the connection parameters to support this customization.

Signed-off-by: Jacky Hu <[email protected]>

* Change oauth redirect port range to port

Signed-off-by: Jacky Hu <[email protected]>

* Fix type check issue

Signed-off-by: Jacky Hu <[email protected]>

Signed-off-by: Jacky Hu <[email protected]>
Signed-off-by: Jacky Hu <[email protected]>
Signed-off-by: Jesse <[email protected]>
Follow up to #67 and #64 

* Regenerate TCLIService using latest TCLIService.thrift from DBR (#64)
* SI: Implement GET, PUT, and REMOVE (#67)
* Re-lock dependencies after merging `main`

Signed-off-by: Jesse Whitehouse <[email protected]>
Since the package is under databricks namespace. pip install this package will cause issue importing other packages under the same namespace like automl and feature store. Adding pkgutil style to resolve the issue.

Signed-off-by: lu-wang-dl <[email protected]>
Signed-off-by: Jesse Whitehouse <[email protected]>
Signed-off-by: Jesse Whitehouse <[email protected]>
Do this because the environment variable pulls did not have closing quotes on their string literals.
Signed-off-by: Thomas Newton <[email protected]>
Signed-off-by: Jesse Whitehouse <[email protected]>
Co-authored-by: Thomas Newton <[email protected]>
Per the sermver.org spec, updating the projects dependencies is considered a compatible change.

https: //semver.org/#what-should-i-do-if-i-update-my-own-dependencies-without-changing-the-public-api

Signed-off-by: Jesse Whitehouse <[email protected]>
* Add Andre. Signed-off-by: Yunbo Deng <[email protected]>

Signed-off-by: yunbodeng-db <[email protected]>

* Revert the change temporarily so I can sign off. Signed-off-by: Yunbo Deng <[email protected]>

Signed-off-by: yunbodeng-db <[email protected]>

* Add Andre and sign off. Signed-off-by: Yunbo Deng <[email protected]>

Signed-off-by: yunbodeng-db <[email protected]>

* Remove redundant line

Signed-off-by: yunbodeng-db <[email protected]>

---------

Signed-off-by: yunbodeng-db <[email protected]>
session_id_hex=UNAUTH_SESSION_ID,
auth_provider=None,
host_url=host_url,
)
Copy link
Contributor

Choose a reason for hiding this comment

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

can we initialize in TelemetryClientFactory constructor?

Signed-off-by: Sai Shree Pradhan <[email protected]>
Signed-off-by: Sai Shree Pradhan <[email protected]>
Signed-off-by: Sai Shree Pradhan <[email protected]>
Copy link

Thanks for your contribution! To satisfy the DCO policy in our contributing guide every commit message must include a sign-off message. One or more of your commits is missing this message. You can reword previous commit messages with an interactive rebase (git rebase -i main).

Signed-off-by: Sai Shree Pradhan <[email protected]>
Copy link

Thanks for your contribution! To satisfy the DCO policy in our contributing guide every commit message must include a sign-off message. One or more of your commits is missing this message. You can reword previous commit messages with an interactive rebase (git rebase -i main).

-
Signed-off-by: Sai Shree Pradhan <[email protected]>
Copy link

Thanks for your contribution! To satisfy the DCO policy in our contributing guide every commit message must include a sign-off message. One or more of your commits is missing this message. You can reword previous commit messages with an interactive rebase (git rebase -i main).

Copy link

Thanks for your contribution! To satisfy the DCO policy in our contributing guide every commit message must include a sign-off message. One or more of your commits is missing this message. You can reword previous commit messages with an interactive rebase (git rebase -i main).

Signed-off-by: Sai Shree Pradhan <[email protected]>
Copy link

Thanks for your contribution! To satisfy the DCO policy in our contributing guide every commit message must include a sign-off message. One or more of your commits is missing this message. You can reword previous commit messages with an interactive rebase (git rebase -i main).

Signed-off-by: Sai Shree Pradhan <[email protected]>
Copy link

Thanks for your contribution! To satisfy the DCO policy in our contributing guide every commit message must include a sign-off message. One or more of your commits is missing this message. You can reword previous commit messages with an interactive rebase (git rebase -i main).

Signed-off-by: Sai Shree Pradhan <[email protected]>
Copy link

Thanks for your contribution! To satisfy the DCO policy in our contributing guide every commit message must include a sign-off message. One or more of your commits is missing this message. You can reword previous commit messages with an interactive rebase (git rebase -i main).

Signed-off-by: Sai Shree Pradhan <[email protected]>
@saishreeeee saishreeeee deployed to azure-prod July 16, 2025 13:35 — with GitHub Actions Active
Copy link

Thanks for your contribution! To satisfy the DCO policy in our contributing guide every commit message must include a sign-off message. One or more of your commits is missing this message. You can reword previous commit messages with an interactive rebase (git rebase -i main).

@databricks databricks deleted a comment from github-actions bot Jul 16, 2025
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.