HydrologicEngineeringCenter / HydrologicEngineeringCenter/cwms-cli

Support use of Trace Id value

Open
#197 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
2
Forks
4
Avg merge
19h 59m
Merged PRs (30d)
3

Description

CLI Script

cwms-cli

Feature Proposal

cwms-cli, especially when using any CWMS service should provide a per session (or user provided from HEADER for a set of request) Trace ID UUID value to place in an X-Trace-Id header.

This will allow correlation of logs during review.

NOTE: can be done at any time, header will be ignored until given service accepts and processes the header.

REDACTED relevant log output

Related Context or Links

No response

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 at the cwms-cli entry point and trace how requests and user-provided headers are assembled. Define how a per-session or supplied UUID reaches service requests as X-Trace-Id, then verify that requests carry the expected value without requiring services to process it.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.