apple / apple/foundationdb

Client trace logs should include Cluster as key where appropriate

Open
#4,202 2 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
C++
Stars
16.7k
Forks
1.6k
Avg merge
1d 20h
Merged PRs (30d)
126

Description

There are a few client trace logs that currently do not have the Cluster as an XML/log key indicating what cluster they are talking to, and I think that it would be useful to have that information to support applications where one client connects to multiple clusters. Some examples are:

1. `LargeTransaction`
2. `LargePacket` (which *does* contain peer information, but having the cluster as well can help aggregate requests)
3. `ConnectionRejected` (similar to `LargePacket`)

There are probably others, but the basic idea is that anything that is talking to a specific cluster or a specific FDB server on a specific cluster should probably include the Cluster as a logging key (which may be easier to plumb through in some circumstances than others).

Contributor guide

Open the contributing guide

Research direction

Start by locating the client trace-log sites for LargeTransaction, LargePacket, and ConnectionRejected, then inspect how cluster context is available at each site. Check nearby logging tests or coverage if present. Done means logs that identify a specific cluster or server include Cluster wherever that context can be provided, with existing behavior preserved.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
databases, distributed-systems
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.