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

[BUG] The documentation for enableDebug is incorrect, it should reference enableDebugExceptions #2014

Closed
MSNev opened this issue Mar 9, 2023 · 3 comments
Closed

[BUG] The documentation for enableDebug is incorrect, it should reference enableDebugExceptions #2014

MSNev opened this issue Mar 9, 2023 · 3 comments
Assignees
@MSNev
Labels
documentation released - NPM
Milestone
2.8.12

Comments

@MSNev
Copy link
Collaborator

MSNev commented Mar 9, 2023

As part of investigating the configuration for #2013 we identified that the documented enableDebug flag is not used during the initialization of the SDK and instead is using enableDebugExceptions

For previous released versions (v2.x) we should update the documentation to point out that this is called enableDebugExceptions, and for later releases we shoudl "consider" whether to use the enableDebug with a fallback to enableDebugExceptions.

As this is really a developer time (non-production) setting, I'm inclined to only support 1 value rather than 2 (from a code size perspective).
@celluj34
Copy link

IMO, v3 is a great time to remove it entirely (and put it in the migration notes).

@MSNev
Copy link
Collaborator Author

MSNev commented Mar 17, 2023

Yeh, for v3 I'm changing this to only support enableDebug, but I'll keep this issue open and we will patch v2.x to support both as one was defined in IConfiguration and the other in IConfig ☹️

@MSNev MSNev added this to the 2.8.12 milestone Mar 17, 2023
MSNev added a commit that referenced this issue Mar 18, 2023
@MSNev
[BUG] The documentation for enableDebug is incorrect, it should refer…
224db76 
…ence enableDebugExceptions #2014
MSNev added a commit that referenced this issue Mar 18, 2023
@MSNev
[BUG] The documentation for enableDebug is incorrect, it should refer…
5593038 
…ence enableDebugExceptions #2014
@MSNev MSNev self-assigned this Mar 18, 2023
MSNev added a commit that referenced this issue Mar 20, 2023
@MSNev
[BUG] The documentation for enableDebug is incorrect, it should refer…
f90f593 
…ence enableDebugExceptions #2014 (#2021)
MSNev added a commit that referenced this issue Mar 20, 2023
@MSNev
[BUG] The documentation for enableDebug is incorrect, it should refer…
218ca12 
…ence enableDebugExceptions #2014
MSNev added a commit that referenced this issue Mar 29, 2023
@MSNev
[BUG] The documentation for enableDebug is incorrect, it should refer…
cd510bc 
…ence enableDebugExceptions #2014 (#2022)
@MSNev MSNev added the fixed - waiting release PR Committed and waiting deployment label Apr 11, 2023
MSNev added a commit that referenced this issue Apr 11, 2023
@MSNev
[BUG] The documentation for enableDebug is incorrect, it should refer…
3b1eae8 
…ence enableDebugExceptions #2014 (#2022)
@MSNev MSNev added waiting - CDN deployment released - NPM and removed fixed - waiting release PR Committed and waiting deployment labels Apr 11, 2023
MSNev added a commit that referenced this issue Apr 12, 2023
@MSNev @peitschie
[Master] Merge latest main to master (#2047)
cd07499 
* [BUG] The documentation for enableDebug is incorrect, it should reference enableDebugExceptions #2014 (#2022)

* [BUG] SDK LOAD Failure reporting not working #2027 (#2038)

* Add a simple interface to enable custom buffer storage solutions #1419 (#2037)

This can be used like:

```
const appInsights = new ApplicationInsights({
  config: {
    enableSessionStorageBuffer: true,
    bufferOverride: {
      getItem: (logger, key) => localStorage.getItem(key),
      setItem: (logger, key, value) => localStorage.setItem(key, value),
    }
  }
});
```

Co-authored-by: Nev <54870357+MSNev@users.noreply.github.com>

* [Master] Add readme documentation for IStorageBuffer (#2045)

* [Release] Increase version to 2.8.12 (#2046)

---------

Co-authored-by: Philip Peitsch <philip.peitsch@gmail.com>
@MSNev MSNev closed this as completed Apr 20, 2023
@github-actions GitHub Actions
Copy link

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 20, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@MSNev MSNev

Labels
documentation released - NPM
Projects
None yet
Milestone
2.8.12
Development

No branches or pull requests
2 participants
@celluj34 @MSNev