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

feat(logging): enable api/sdk interaction logging #237

Merged
merged 5 commits into from
Feb 12, 2025
Merged

feat(logging): enable api/sdk interaction logging #237

merged 5 commits into from
Feb 12, 2025

Conversation

DariuszPorowski
Copy link
Member

📥 Pull Request

❓ What are you trying to address

This pull request introduces logging enhancements for API/SDK interactions and updates related documentation and configuration files. The key changes include enabling detailed logging for API calls and updating the troubleshooting guide.

✨ Description of new changes

Logging Enhancements:

  • Added a new logging subsystem for the Microsoft Fabric SDK to capture detailed API interactions. (internal/provider/client/logging.go)
  • Integrated the new logging subsystem into the provider client creation process. (internal/provider/provider.go)

Documentation Updates:

  • Updated the troubleshooting guide to include instructions for enabling low-level logging for API calls. (docs/guides/troubleshooting.md, templates/guides/troubleshooting.md)

@DariuszPorowski DariuszPorowski requested a review from a team as a code owner February 6, 2025 12:33
@github-actions GitHub Actions
Copy link

github-actions bot commented Feb 6, 2025 •
edited
Loading

Changelog Preview

v0.1.0-dev - February 12, 2025

✨ Added

  • #237 Enable API/SDK interaction logging.

@DariuszPorowski DariuszPorowski added this to the 2025-02 milestone Feb 6, 2025
@github-actions GitHub Actions
Copy link

github-actions bot commented Feb 6, 2025 •
edited
Loading

Code Coverage

Package Line Rate Complexity Health
github.com/microsoft/terraform-provider-fabric/internal/auth 89% 0 ✔
github.com/microsoft/terraform-provider-fabric/internal/framework/customtypes 75% 0 ✔
github.com/microsoft/terraform-provider-fabric/internal/framework/planmodifiers 69% 0 ✔
github.com/microsoft/terraform-provider-fabric/internal/framework/typeutils 63% 0 ✔
github.com/microsoft/terraform-provider-fabric/internal/framework/validators 80% 0 ✔
github.com/microsoft/terraform-provider-fabric/internal/functions 72% 0 ✔
github.com/microsoft/terraform-provider-fabric/internal/pkg/fabricitem 82% 0 ✔
github.com/microsoft/terraform-provider-fabric/internal/pkg/transforms 63% 0 ✔
github.com/microsoft/terraform-provider-fabric/internal/pkg/utils 83% 0 ✔
github.com/microsoft/terraform-provider-fabric/internal/provider 85% 0 ✔
github.com/microsoft/terraform-provider-fabric/internal/provider/client 67% 0 ✔
github.com/microsoft/terraform-provider-fabric/internal/provider/config 100% 0 ✔
github.com/microsoft/terraform-provider-fabric/internal/provider/utils 69% 0 ✔
github.com/microsoft/terraform-provider-fabric/internal/services/capacity 87% 0 ✔
github.com/microsoft/terraform-provider-fabric/internal/services/dashboard 100% 0 ✔
github.com/microsoft/terraform-provider-fabric/internal/services/datamart 100% 0 ✔
github.com/microsoft/terraform-provider-fabric/internal/services/datapipeline 100% 0 ✔
github.com/microsoft/terraform-provider-fabric/internal/services/domain 42% 0 ➖
github.com/microsoft/terraform-provider-fabric/internal/services/environment 87% 0 ✔
github.com/microsoft/terraform-provider-fabric/internal/services/eventhouse 93% 0 ✔
github.com/microsoft/terraform-provider-fabric/internal/services/eventstream 100% 0 ✔
github.com/microsoft/terraform-provider-fabric/internal/services/kqldashboard 100% 0 ✔
github.com/microsoft/terraform-provider-fabric/internal/services/kqldatabase 82% 0 ✔
github.com/microsoft/terraform-provider-fabric/internal/services/kqlqueryset 100% 0 ✔
github.com/microsoft/terraform-provider-fabric/internal/services/lakehouse 86% 0 ✔
github.com/microsoft/terraform-provider-fabric/internal/services/mirroredwarehouse 100% 0 ✔
github.com/microsoft/terraform-provider-fabric/internal/services/mlexperiment 100% 0 ✔
github.com/microsoft/terraform-provider-fabric/internal/services/mlmodel 100% 0 ✔
github.com/microsoft/terraform-provider-fabric/internal/services/notebook 100% 0 ✔
github.com/microsoft/terraform-provider-fabric/internal/services/paginatedreport 100% 0 ✔
github.com/microsoft/terraform-provider-fabric/internal/services/report 100% 0 ✔
github.com/microsoft/terraform-provider-fabric/internal/services/semanticmodel 100% 0 ✔
github.com/microsoft/terraform-provider-fabric/internal/services/spark 75% 0 ✔
github.com/microsoft/terraform-provider-fabric/internal/services/sparkjobdefinition 92% 0 ✔
github.com/microsoft/terraform-provider-fabric/internal/services/sqlendpoint 100% 0 ✔
github.com/microsoft/terraform-provider-fabric/internal/services/warehouse 92% 0 ✔
github.com/microsoft/terraform-provider-fabric/internal/services/workspace 78% 0 ✔
Summary 76% (4205 / 5544) 0 ✔

Minimum allowed line rate is 40%

@codecov-commenter
Copy link

codecov-commenter commented Feb 6, 2025 •
edited
Loading

Codecov Report

Attention: Patch coverage is 41.93548% with 18 lines in your changes missing coverage. Please review.

Project coverage is 79.20%. Comparing base (5ba6f57) to head (9324818).
Report is 2 commits behind head on main.

Files with missing lines Patch % Lines
internal/provider/provider.go 20.00% 12 Missing ⚠️
internal/provider/client/logging.go 62.50% 5 Missing and 1 partial ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##             main     #237      +/-   ##
==========================================
- Coverage   79.27%   79.20%   -0.08%     
==========================================
  Files         155      156       +1     
  Lines       13300    13329      +29     
==========================================
+ Hits        10544    10557      +13     
- Misses       2752     2767      +15     
- Partials        4        5       +1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

PabloZaiden
PabloZaiden approved these changes Feb 12, 2025
View reviewed changes
Copy link
Contributor

@PabloZaiden PabloZaiden left a comment

Choose a reason for hiding this comment

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

Added 2 minor comments, but looks good. Great feature.

@DariuszPorowski DariuszPorowski enabled auto-merge (squash) February 12, 2025 15:53
@DariuszPorowski DariuszPorowski merged commit 70af222 into main Feb 12, 2025
23 checks passed
@DariuszPorowski DariuszPorowski deleted the feat/sdk-logging branch February 12, 2025 16:03
This was referenced Feb 12, 2025
Merged
Merged
Merged
Merged
@DariuszPorowski DariuszPorowski mentioned this pull request Feb 13, 2025
Merged
DariuszPorowski added a commit that referenced this pull request Feb 13, 2025
@DariuszPorowski
feat(release): v0.1.0-beta.9 (#252)
9246abb 
## v0.1.0-beta.9 - February 13, 2025

### ✨ Added

*
[#215](#215)
Definition support in the `fabric_kql_database` Resource / Data-Source
*
[#237](#237)
Enable API/SDK interaction logging.

### 🪲 Fixed

*
[#235](#235)
Error when referencing non-text source for Fabric Item Definition part.
*
[#239](#239)
Inconsistent result for dynamic_executor_allocation
(min_executors/max_executors) when enabled is false.
*
[#247](#247)
Add support for missing `definition/expressions.tmdl` and
`definition/relationships.tmdl` paths in the Semantic Model TMDL format.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@PabloZaiden PabloZaiden PabloZaiden approved these changes

Assignees

@DariuszPorowski DariuszPorowski

Labels
None yet
Projects
None yet
Milestone
2025-02
Development

Successfully merging this pull request may close these issues.
3 participants
@DariuszPorowski @codecov-commenter @PabloZaiden