linkedin / linkedin/Burrow

Documentation clarification for [cluster.mycluster] section configuration

Open
#342 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
4k
Forks
818
Avg merge
1h 14m
Merged PRs (30d)
1

Description

Would it be possible to add a note to the documentation about cluster names in the config file?

I found out the hard way that if the cluster name has upper-case characters in it, it breaks things?
(Specifically, the burrow program will report "unknown cluster" (in the addConsumerOffset() routine) for all consumer offset updates with a cluster name of "CMU" or "Cmu". It works fine with a cluster name of "cmu")

Here is an example log error message when the cluster name has an upper-case letter in it:
{"level":"warn","ts":1517431581.178074,"msg":"unknown cluster","type":"module","coordinator":"storage","class":"inmemory","name":"default","worker":11,"cluster":"Cmu","consumer":"test","topic":"LSpipeline","partition":58,"topic_partition_count":0,"offset":1827590082,"timestamp":1517431580904,"owner":"","request":"StorageSetConsumerOffset"}

Thank you,

- Daniel

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the configuration documentation for the [cluster.mycluster] section and review the addConsumerOffset() path mentioned in the report. Done means the documentation clearly states the cluster-name casing constraint and reflects the reported "unknown cluster" behavior for names such as "CMU" or "Cmu".

Written by the indexing model from the issue text.

Assessment

Tech stack
go, kafka
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.