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.

Sign up for GitHub

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

Jump to bottom

Azure Monitor OpenTelemetry Readme Issue #28744

Closed
v-weiyding opened this issue Mar 1, 2024 · 1 comment
Closed

Azure Monitor OpenTelemetry Readme Issue #28744

v-weiyding opened this issue Mar 1, 2024 · 1 comment
Assignees
@hectorhdzg
Labels
Client This issue points to a problem in the data-plane of the library. Docs Monitor - Exporter Monitor OpenTelemetry Exporter test-manual-pass

Comments

@v-weiyding
Copy link
Member

Section link1,link2
image
image

Reason:
The readme code snippets are in JS not TS, so a type AzureMonitorOpenTelemetryOptions shouldn't be necessary.
useAzureMonitor is used but not imported

Suggestion:
Remove AzureMonitorOpenTelemetryOptions
Import useAzureMonitor

@joheredi and @JacksonWeber for notification.
@github-actions github-actions bot added Client This issue points to a problem in the data-plane of the library. Monitor - Exporter Monitor OpenTelemetry Exporter needs-team-triage Workflow: This issue needs the team to triage. labels Mar 1, 2024
@xirzec xirzec removed the needs-team-triage Workflow: This issue needs the team to triage. label Mar 1, 2024
@JacksonWeber
Copy link
Member

Hi @v-weiyding, the code snippets all represent TS here. The const { ... } = require(...); syntax is valid TS. However, thank you for alerting us to the missing import of useAzureMonitor.

@JacksonWeber JacksonWeber mentioned this issue Mar 3, 2024
Merged
3 tasks
JacksonWeber added a commit that referenced this issue Mar 13, 2024
@JacksonWeber
[Azure Monitor OpenTelemetry] Update Code Samples in README (#28759)
00504e6 
### Packages impacted by this PR
@azure/monitor-opentelemetry

### Describe the problem that is addressed by this PR
Code samples should be consistent and be syntactically correct in
TypeScript

#28744 

### Checklists
- [x] Added impacted package name to the issue description
- [ ] Does this PR needs any fixes in the SDK Generator?** _(If so,
create an Issue in the
[Autorest/typescript](https://github.com/Azure/autorest.typescript)
repository and link it here)_
- [x] Added a changelog (if necessary)
@github-actions github-actions bot locked and limited conversation to collaborators Jun 16, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@hectorhdzg hectorhdzg

Labels
Client This issue points to a problem in the data-plane of the library. Docs Monitor - Exporter Monitor OpenTelemetry Exporter test-manual-pass
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@xirzec @hectorhdzg @JacksonWeber @v-xuto @v-weiyding