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

Promote extension log API to stable #43275

Closed
roblourens opened this issue Feb 9, 2018 · 10 comments
Closed

Promote extension log API to stable #43275

roblourens opened this issue Feb 9, 2018 · 10 comments
Assignees
@roblourens @jrieken
Labels
api api-finalization debt Code quality issues verification-needed Verification of issue is requested verified Verification succeeded
Milestone
August 2018

Comments

@roblourens
Copy link
Member

https://github.com/Microsoft/vscode/blob/f15c6481fb4637f767532757ef545a8c2460ce1a/src/vs/vscode.proposed.d.ts#L401
@roblourens roblourens added the api label Feb 9, 2018
@roblourens roblourens added this to the February 2018 milestone Feb 9, 2018
@roblourens roblourens self-assigned this Feb 9, 2018
@roblourens
Copy link
Member Author

Earlier discussion at 98c58df

roblourens added a commit that referenced this issue Feb 9, 2018
@roblourens
Promote extension log API to stable - Fix #43275
8351e06
@roblourens roblourens mentioned this issue Feb 9, 2018
Closed
@roblourens roblourens added the debt Code quality issues label Feb 9, 2018
roblourens added a commit that referenced this issue Feb 13, 2018
@roblourens
Promote extension log API to stable - Fix #43275
2e45f55
@ramya-rao-a
Copy link
Contributor

@roblourens Moving to March since you are not here ...

@ramya-rao-a ramya-rao-a modified the milestones: February 2018, March 2018 Mar 1, 2018
@roblourens roblourens modified the milestones: March 2018, April 2018 Mar 26, 2018
@roblourens roblourens modified the milestones: April 2018, May 2018 Apr 23, 2018
@roblourens roblourens mentioned this issue Apr 24, 2018
Merged
@roblourens roblourens modified the milestones: May 2018, Backlog Jun 1, 2018
@jrieken jrieken modified the milestones: Backlog, August 2018 Jul 19, 2018
@jrieken
Copy link
Member

jrieken commented Aug 9, 2018 •
edited
Loading

#43276 (comment)

Outcome of discussing this

have logDirectory a property of the extension context (in the spirit of storagePath)
move log level information and corresponding event to vscode.env as there is only a global log level in vscode
move the logging-related methods to the output channel api.
We are aiming to deliver the first two items during this milestone and consider the last as stretch.

@jrieken jrieken self-assigned this Aug 9, 2018
@jrieken
Copy link
Member

jrieken commented Aug 17, 2018 •
edited
Loading

I have added ExtensionContext#logPath. This will replace the proposed logDirectory-property which is currently used by node.debug and node.debug2. The old property is still around but will generate a warning. @roblourens @weinand please adopt

jrieken added a commit that referenced this issue Aug 17, 2018
@jrieken
add ExtensionContext#logPath, #43275
bbfcc67
jrieken added a commit that referenced this issue Aug 17, 2018
@jrieken
remove proposed Logger-api, #43275
1c72ab2 
we keep the LogLevel-enum and the plan is to accept the log level when
calling OutputChannel#appendLine so that
logging is supported there
@weinand
Copy link
Contributor

weinand commented Aug 17, 2018 •
edited
Loading

I've updated node-debug to use ExtensionContext.logPath instead of ExtensionContext.logDirectory.

jrieken added a commit that referenced this issue Aug 17, 2018
@jrieken
Revert "remove proposed Logger-api, #43275"
315cce8 
This reverts commit 1c72ab2.
@weinand
Copy link
Contributor

weinand commented Aug 17, 2018 •
edited
Loading

@jrieken Is there already an API proposal for the "logging-related methods on the output channel api"?
We should deprecate the existing log API, right?

I've already adopted the new logPath in node-debug.
Since you've reverted your change, the logPath won't be available, right?

@jrieken
Copy link
Member

jrieken commented Aug 17, 2018

You can use the simple appendLine - we didn't plan for that change because we didn't know anyone uses it. An idea might be to accept a log level when calling appendLine but nothing has been discussed yet

jrieken added a commit that referenced this issue Aug 20, 2018
@jrieken
Revert "Revert "remove proposed Logger-api, #43275""
6620589 
This reverts commit 315cce8.
jrieken added a commit that referenced this issue Aug 20, 2018
@jrieken
remove logDirectory, #43275
27c72d4
jrieken added a commit that referenced this issue Aug 22, 2018
@jrieken
add log level change event, #43275
1df5a2f
@jrieken
Copy link
Member

jrieken commented Aug 23, 2018

We have pushed ExtensionContext#logPath

@jrieken jrieken closed this as completed Aug 23, 2018
@DanTup DanTup mentioned this issue Aug 27, 2018
Closed
@jrieken jrieken added the verification-needed Verification of issue is requested label Aug 29, 2018
@jrieken
Copy link
Member

jrieken commented Aug 29, 2018

Verify that there is ExtensionContext#logPath, that it is documented, and that it is unique per extension.

@roblourens roblourens added the verified Verification succeeded label Aug 29, 2018
@DanTup
Copy link
Contributor

DanTup commented Sep 19, 2018

Am I right in thinking the path is the only thing being provided here, no logging API?

The path seems to have a long random folder name in it - restarting didn't seem to generate a new one - do these ever change? Do the logs ever get cleaned up?

@vscodebot vscodebot bot locked and limited conversation to collaborators Oct 7, 2018
@weinand weinand removed their assignment Mar 16, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@roblourens roblourens

@jrieken jrieken

Labels
api api-finalization debt Code quality issues verification-needed Verification of issue is requested verified Verification succeeded
Projects
None yet
Milestone
August 2018
Development

Successfully merging a pull request may close this issue.

Promote extension log API to stable microsoft/vscode
5 participants
@roblourens @DanTup @jrieken @weinand @ramya-rao-a