line / line/centraldogma

Consider renaming the watch API

Open
#601 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

breaking change improvement
Dominant language
Java
Stars
668
Forks
135
Avg merge
4d 19h
Merged PRs (30d)
7

Description

Currently, get file(s) API and watch API have the same endpoint.
https://github.com/line/centraldogma/blob/master/server/src/main/java/com/linecorp/centraldogma/server/internal/api/ContentServiceV1.java#L231
So access logs and metrics have the same naming.
That really makes it hard to debug when something happens because the watch API usually has high latency.

Contributor guide

Open the contributing guide

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 in server/src/main/java/com/linecorp/centraldogma/server/internal/api/ContentServiceV1.java at line 231, where the file and watch APIs share an endpoint. Trace how that endpoint is named in access logs and metrics, then ensure the watch API has a distinct name so its latency can be identified during debugging.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api, observability
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 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.