Skip to content

feat(manager): optimizing tracing configuration#4102

Merged
Liam-Zhao merged 1 commit intomainfrom
feature/tracing
May 29, 2025
Merged

feat(manager): optimizing tracing configuration#4102
Liam-Zhao merged 1 commit intomainfrom
feature/tracing

Conversation

@gaius-qi
Copy link
Copy Markdown
Member

Description

This pull request updates the dfcache documentation to reflect changes in the tool's behavior and formatting. The most notable updates include removing deprecated flags, improving formatting consistency, and updating the documentation generator version.

Documentation Updates:

  • Updated the documentation generator from Pandoc 3.6.1 to 3.7.0.1 across all .1 files, resulting in minor formatting changes [1] [2] [3] [4] [5] [6] [7] [8].
  • Improved formatting by replacing escaped sequences (e.g., \[lq] and \[rq]) with their corresponding characters (e.g., \(lq and \(rq) for better readability [1] [2] [3].

Flag Updates:

  • Removed the --jaeger flag from all commands, which previously allowed specifying a Jaeger endpoint URL [1] [2] [3] [4] [5] [6] [7] [8].
  • Removed the --service-name flag, which defined the tracer's service name, and the --pprof-port flag's default value formatting was updated for consistency [1] [2] [3] [4] [5] [6] [7] [8].

Markdown Documentation:

  • Synchronized changes in .1 files with their corresponding .md files for consistency in flag descriptions and formatting [1] [2] [3].

Related Issue

Motivation and Context

Screenshots (if appropriate)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation Update (if none of the other choices apply)

Checklist

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.

@gaius-qi gaius-qi added this to the v2.3.0 milestone May 28, 2025
@gaius-qi gaius-qi self-assigned this May 28, 2025
@gaius-qi gaius-qi requested a review from a team as a code owner May 28, 2025 14:45
@gaius-qi gaius-qi added the enhancement New feature or request label May 28, 2025
@gaius-qi gaius-qi requested review from chlins, garenwen and hyy0322 May 28, 2025 14:45
@gaius-qi gaius-qi requested a review from a team as a code owner May 28, 2025 15:03
@gaius-qi gaius-qi requested a review from fcgxz2003 May 28, 2025 15:03
@gaius-qi gaius-qi force-pushed the feature/tracing branch 3 times, most recently from f31b826 to 771dfd9 Compare May 28, 2025 15:22
@codecov
Copy link
Copy Markdown

codecov bot commented May 28, 2025

Codecov Report

Attention: Patch coverage is 14.47368% with 130 lines in your changes missing coverage. Please review.

Project coverage is 33.18%. Comparing base (67423da) to head (24e988a).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
cmd/dependency/dependency.go 0.00% 57 Missing ⚠️
pkg/rpc/scheduler/client/client_v1.go 0.00% 8 Missing ⚠️
pkg/rpc/scheduler/client/client_v2.go 0.00% 8 Missing ⚠️
cmd/dfget/cmd/daemon.go 0.00% 6 Missing ⚠️
cmd/dfget/cmd/root.go 0.00% 6 Missing ⚠️
cmd/manager/cmd/root.go 0.00% 6 Missing ⚠️
cmd/dfcache/cmd/delete.go 0.00% 4 Missing ⚠️
cmd/dfcache/cmd/export.go 0.00% 4 Missing ⚠️
cmd/dfcache/cmd/import.go 0.00% 4 Missing ⚠️
cmd/dfcache/cmd/stat.go 0.00% 4 Missing ⚠️
... and 8 more
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #4102      +/-   ##
==========================================
- Coverage   33.20%   33.18%   -0.03%     
==========================================
  Files         346      346              
  Lines       40589    40656      +67     
==========================================
+ Hits        13476    13490      +14     
- Misses      26222    26273      +51     
- Partials      891      893       +2     
Flag Coverage Δ
unittests 33.18% <14.47%> (-0.03%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
manager/config/config.go 96.47% <100.00%> (+0.12%) ⬆️
pkg/rpc/scheduler/server/server.go 100.00% <100.00%> (ø)
scheduler/config/config.go 86.66% <100.00%> (+0.55%) ⬆️
client/daemon/objectstorage/objectstorage.go 0.00% <0.00%> (ø)
client/daemon/upload/upload_manager.go 54.30% <0.00%> (ø)
cmd/dfcache/cmd/root.go 0.00% <0.00%> (ø)
manager/router/router.go 0.00% <0.00%> (ø)
cmd/dfcache/cmd/delete.go 0.00% <0.00%> (ø)
cmd/dfcache/cmd/export.go 0.00% <0.00%> (ø)
cmd/dfcache/cmd/import.go 0.00% <0.00%> (ø)
... and 11 more

... and 3 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Signed-off-by: Gaius <gaius.qi@gmail.com>
Copy link
Copy Markdown

@Liam-Zhao Liam-Zhao left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Liam-Zhao Liam-Zhao enabled auto-merge (squash) May 29, 2025 02:28
Copy link
Copy Markdown
Member

@chlins chlins left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@Liam-Zhao Liam-Zhao merged commit 49e6cf6 into main May 29, 2025
16 of 17 checks passed
@Liam-Zhao Liam-Zhao deleted the feature/tracing branch May 29, 2025 02:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants