Page MenuHomePhabricator
Create Task
Maniphest T330027

WikiLambda PHP: Document our logging conventions
Open, LowPublic
Actions

Description

We have a handful of uses of wfDebug() in WikiLambda PHP. A patch review has said: "suggest using a specific logger instead of just general wfDebug, so that this gets labeled with a WikiLambda channel". (See patch.) I'm not aware of any conventions for this. If there are none, let's decide on a logging channel and other details of our logging approach and document it somewhere.

Desired behavior/Acceptance criteria

Completion checklist

Details

SubjectRepoBranchLines +/-
ApiPerformTest: Move logging up to WikiLambdaApibase and implement generallymediawiki/extensions/WikiLambdamaster+66 -25
ApiPerformTest: Transition wfDebug() calls to proper logs where we canmediawiki/extensions/WikiLambdamaster+28 -4
Customize query in gerrit

Event Timeline

DMartin-WMF created this task.Feb 19 2023, 6:41 PM
DVrandecic moved this task from To triage to Phase κ – Clean-up on the Abstract Wikipedia team board.Feb 21 2023, 7:34 PM
DVrandecic edited projects, added Abstract Wikipedia team (Phase κ – Clean-up); removed Abstract Wikipedia team.
gerritbot added a comment.Mar 1 2023, 6:13 PM

Change 893525 had a related patch set uploaded (by Jforrester; author: Jforrester):

[mediawiki/extensions/WikiLambda@master] ApiPerformTest: Transition wfDebug() calls to proper logs where we can

https://gerrit.wikimedia.org/r/893525

gerritbot added a project: Patch-For-Review.Mar 1 2023, 6:13 PM
gerritbot added a comment.Mar 7 2023, 9:50 PM

Change 893525 merged by jenkins-bot:

[mediawiki/extensions/WikiLambda@master] ApiPerformTest: Transition wfDebug() calls to proper logs where we can

https://gerrit.wikimedia.org/r/893525

Maintenance_bot removed a project: Patch-For-Review.Mar 7 2023, 10:10 PM
ReleaseTaggerBot added a project: MW-1.40-notes (1.40.0-wmf.27; 2023-03-13).Mar 9 2023, 6:01 PM
gerritbot added a comment.Mar 21 2023, 6:02 PM

Change 901686 had a related patch set uploaded (by Jforrester; author: Jforrester):

[mediawiki/extensions/WikiLambda@master] ApiPerformTest: Move logging up to WikiLambdaApibase and implement generally

https://gerrit.wikimedia.org/r/901686

gerritbot added a project: Patch-For-Review.Mar 21 2023, 6:02 PM
Jdforrester-WMF triaged this task as Medium priority.Mar 24 2023, 1:24 AM
gerritbot added a comment.Mar 29 2023, 2:27 PM

Change 901686 merged by jenkins-bot:

[mediawiki/extensions/WikiLambda@master] ApiPerformTest: Move logging up to WikiLambdaApibase and implement generally

https://gerrit.wikimedia.org/r/901686

Maintenance_bot removed a project: Patch-For-Review.Mar 29 2023, 2:30 PM
ReleaseTaggerBot added a project: MW-1.41-notes (1.41.0-wmf.3; 2023-04-03).Mar 29 2023, 3:00 PM
Jdforrester-WMF assigned this task to • CCoxwell-WMF.May 1 2023, 7:37 PM
DMartin-WMF added a subscriber: Jdforrester-WMF.May 1 2023, 11:27 PM

I think this ticket is closable. Since this ticket was written, we have new code in WikiLambdaApiBase.php that creates a logger on channel WikiLambda, and use of the logger is illustrated in ApiPerformTest.php. Even though I suggested documenting our conventions, I now feel like what we have is sufficiently straightforward and self-documenting. @Jdforrester-WMF - I'll leave it open for now, in case you have identified any other actions to be done before closing.

Jdforrester-WMF updated the task description. (Show Details)May 11 2023, 2:08 PM
In T330027#8817775, @DMartin-WMF wrote:

I think this ticket is closable. Since this ticket was written, we have new code in WikiLambdaApiBase.php that creates a logger on channel WikiLambda, and use of the logger is illustrated in ApiPerformTest.php. Even though I suggested documenting our conventions, I now feel like what we have is sufficiently straightforward and self-documenting. @Jdforrester-WMF - I'll leave it open for now, in case you have identified any other actions to be done before closing.

Yeah, I think we just need to fix the documentation to consider this Resolved.

Jdforrester-WMF moved this task from Incoming to Better before launch on the Abstract Wikipedia team (Phase κ – Clean-up) board.May 24 2023, 9:39 PM
Jdforrester-WMF renamed this task from WikiLambda PHP: Establish logging conventions to WikiLambda PHP: Document our logging conventions.Jun 8 2023, 9:40 PM
Jdforrester-WMF moved this task from Phase κ – Clean-up to To triage: Nice-to-haves on the Abstract Wikipedia team board.Jun 16 2023, 8:38 AM
Jdforrester-WMF edited projects, added Abstract Wikipedia team; removed Abstract Wikipedia team (Phase κ – Clean-up).
Jdforrester-WMF removed • CCoxwell-WMF as the assignee of this task.Oct 26 2023, 4:47 PM
Jdforrester-WMF lowered the priority of this task from Medium to Low.
Jdforrester-WMF moved this task from To triage: Nice-to-haves to Backlog on the Abstract Wikipedia team board.
Jdforrester-WMF added a subscriber: • CCoxwell-WMF.
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL