FAForever/server

Add metrics for certain data structure sizes

Open

#609 opened on Jun 20, 2020

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Python (79 forks)auto 404
good first issue

Repository metrics

Stars
 (72 stars)
PR merge metrics
 (PR metrics pending)

Description

There are some dictionaries that hold strong references to their values which we should post some metrics about to make sure they aren't growing without bound. Mostly I want to know "how many elements are in the dictionary".

https://github.com/FAForever/server/blob/ccf349e3b4bbaee95373d79a0e2f4ee9c5d064a2/server/ladder_service.py#L53

https://github.com/FAForever/server/blob/ccf349e3b4bbaee95373d79a0e2f4ee9c5d064a2/server/player_service.py#L25

https://github.com/FAForever/server/blob/ccf349e3b4bbaee95373d79a0e2f4ee9c5d064a2/server/game_service.py#L46

https://github.com/FAForever/server/blob/ccf349e3b4bbaee95373d79a0e2f4ee9c5d064a2/server/matchmaker/matchmaker_queue.py#L49

Contributor guide

Research direction
Identify the dictionaries in the linked files and add instrumentation to expose their size via metrics (e.g., Prometheus gauge). Ensure the metrics are updated on insertion/removal.
Tech stack
python
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonMonitoring/metrics concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70