Update trace-application.md #513
Open
+1
−1
Conversation
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
### Updated telemetry documentation reference
Replaced incorrect usage of a non-existent method `get_connection_string()` with the correct `get_application_insights_connection_string()` when retrieving the Application Insights connection string.
---
#### Context
I initially followed the docs:
```python
project = AIProjectClient(
credential=DefaultAzureCredential(),
endpoint=os.getenv("AZURE_AI_FOUNDRY_ENDPOINT"),
)
tracer = trace.get_tracer(__name__)
connection_string = project.telemetry.get_connection_string()
configure_azure_monitor(connection_string=connection_string)
```
This resulted in the following error:
```
Traceback (most recent call last): line 21, in <module>
connection_string = project.telemetry.get_connection_string()
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
AttributeError: 'TelemetryOperations' object has no attribute 'get_connection_string'. Did you mean: '_connection_string'?
```
#### Investigation
I checked the source code of the SDK and found this in the TelemetryOperations class:
```python
class TelemetryOperations:
"""
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.ai.projects.AIProjectClient`'s
:attr:`telemetry` attribute.
"""
_connection_string: Optional[str] = None
def __init__(self, outer_instance: "azure.ai.projects.AIProjectClient") -> None: # type: ignore[name-defined]
self._outer_instance = outer_instance
@distributed_trace
def get_application_insights_connection_string(self) -> str: # pylint: disable=name-too-long
```
#### Resolution
Switching to the correct method resolved the issue:
```python
project = AIProjectClient(
credential=DefaultAzureCredential(),
endpoint=os.getenv("AZURE_AI_FOUNDRY_ENDPOINT"),
)
tracer = trace.get_tracer(__name__)
connection_string = project.telemetry.get_application_insights_connection_string()
configure_azure_monitor(connection_string=connection_string)
```
|
@Lin-ux-404 : Thanks for your contribution! The author(s) and reviewer(s) have been notified to review your proposed change. |
|
Learn Build status updates of commit 19fd0e0: ✅ Validation status: passed
For more details, please refer to the build report. |
|
Can you review the proposed changes? Important: When the changes are ready for publication, adding a #label:"aq-pr-triaged" |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Updated telemetry documentation reference
Replaced incorrect usage of a non-existent method
get_connection_string()with the correctget_application_insights_connection_string()when retrieving the Application Insights connection string.Context
I initially followed the docs:
This resulted in the following error:
Investigation
I checked the source code of the SDK and found this in the TelemetryOperations class:
Resolution
Switching to the correct method resolved the issue: