Handbook with the documented consistent logging across services
Closed, ResolvedPublic5 Estimated Story Points
Actions

Assigned To

Authored By

	JArguello-WMF
	Oct 19 2023, 2:19 PM

Description

Background/Goal

Key task for OKR O 6. KR3

As a software engineer in wme i'd like to have a document specifying the logging standards for the team, so that i can rely on it for my work and guarantee quality of logs.

We have a logging package with a defined API for formatted json logs, in this document i'd expect to have a criteria of what to include and what levels to use in what cases.

Acceptance Criteria

Document specifying the teams best practices going forward.
Template proposal for the team to discuss

Key Tasks

Document specifying the following for logs:
- What logs levels available
- Per log level, how and what should the logs be created.
Document specifying the following for metrics:
Present to the team and iterate given feedback.

Artifacts & Resources

Related Objects
Search...

Status	Assigned	Task
Resolved	None	T350340 OKR 6.3
Resolved	None	T350590 [Stub] Implement RFC From Investigation
Resolved	E.Enabulele	T349305 Handbook with the documented consistent logging across services

Event Timeline

JArguello-WMF created this task.Oct 19 2023, 2:19 PM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptOct 19 2023, 2:19 PM

JArguello-WMF renamed this task from Handbook with the documented consistent logging across services to [needs refinement] Handbook with the documented consistent logging across services.Oct 19 2023, 2:20 PM

JArguello-WMF updated the task description. (Show Details)Oct 19 2023, 2:22 PM

REsquito-WMF renamed this task from [needs refinement] Handbook with the documented consistent logging across services to Handbook with the documented consistent logging across services.Oct 20 2023, 1:47 PM

REsquito-WMF updated the task description. (Show Details)

Minor things I'd like to see in this doc:

guide on code patterns where we must have logging, optional logging and not use logs
The same for tracing
Ways to dynamically change the log level and filters out by tags in logs or traces. example:

processors:
  filter/1:
    metrics:
      include:
        match_type: regexp
        metric_names:
          - prefix/.*
          - prefix_.*
        resource_attributes:
          - key: container.name
            value: app_container_1
      exclude:
        match_type: strict
        metric_names:
          - kafka-latency-*

JArguello-WMF updated the task description. (Show Details)Nov 2 2023, 4:35 AM

JArguello-WMF added a parent task: T350340: OKR 6.3.Nov 2 2023, 5:02 AM

LDlulisa-WMF added a parent task: T350590: [Stub] Implement RFC From Investigation.Nov 6 2023, 2:57 PM

JArguello-WMF assigned this task to E.Enabulele.Nov 8 2023, 3:47 PM

JArguello-WMF updated the task description. (Show Details)

JArguello-WMF set the point value for this task to 5.

JArguello-WMF moved this task from To Be Estimated/To Be Discussed to Estimated /Discussed on the Wikimedia Enterprise board.

E.Enabulele changed the task status from Open to In Progress.Nov 14 2023, 2:00 PM

JArguello-WMF moved this task from Estimated /Discussed to Sprint 51 on the Wikimedia Enterprise board.Nov 16 2023, 2:46 PM

JArguello-WMF edited projects, added Wikimedia Enterprise (Sprint 51); removed Wikimedia Enterprise.

REsquito-WMF moved this task from Next Up to In Progress on the Wikimedia Enterprise (Sprint 51) board.Nov 20 2023, 2:08 PM

E.Enabulele updated the task description. (Show Details)Nov 27 2023, 12:34 PM