feat: monitor http server request by diagnostics_channel #248

fengmk2 · 2025-03-09T15:20:02Z

BREAKING CHANGE: drop Node.js < 18.19.0 support

closes X-Profiler/egg-xtransit#10

Usage: ```js XPROFILER_PATCH_HTTP_WITH_DIAGNOSTICS_CHANNEL=YES npm start ``` closes X-Profiler/egg-xtransit#10

Copilot

PR Overview

This PR adds support for monitoring HTTP server requests via diagnostics_channel. Key changes include:

Adding new subscription functions (subscribeHttpServerRequestStart and unsubscribeHttpServerRequestStart) that leverage diagnostics_channel.
Updating configuration, tests, and documentation to support the new patch_http_with_diagnostics_channel flag.
Adjusting patch logic in patch/index.js to conditionally use diagnostics_channel based on configuration.

Reviewed Changes

File	Description
test/patch/http_with_diagnostics_channel.test.js	New tests to validate the diagnostics_channel integration.
patch/http.js	Added subscription/unsubscription functions and refactored HTTP patch.
configuration.js	Extended configuration to include the new patch_http_with_diagnostics_channel flag.
patch/index.js	Updated patch logic to toggle between diagnostics_channel and default patch.
test/fixtures/cases/config.js, logbypass.js, command.js	Updated test fixtures to cover the new configuration flag.
README.md	Documentation updated with details about diagnostics_channel support.

Copilot reviewed 10 out of 10 changed files in this pull request and generated 1 comment.

Comments suppressed due to low confidence (1)

test/fixtures/cases/logbypass.js:138

The configuration value for patch_http_with_diagnostics_channel is set to 0, which may cause type coercion issues. It is recommended to use a proper boolean value (false) to maintain consistency with the configuration schema.

XPROFILER_PATCH_HTTP_WITH_DIAGNOSTICS_CHANNEL: 0,

patch/http.js

Copilot

PR Overview

This PR adds support for monitoring HTTP server requests using the diagnostics_channel module when enabled via configuration. Key changes include:

Adding new functions subscribeHttpServerRequestStart and unsubscribeHttpServerRequestStart in patch/http.js.
Updating configuration and tests with the new patch_http_with_diagnostics_channel option.
Adjusting the patch logic in patch/index.js to conditionally apply diagnostics_channel-based patching.

Reviewed Changes

File	Description
test/patch/http_with_diagnostics_channel.test.js	Adds tests for monitoring HTTP requests using diagnostics_channel
patch/http.js	Introduces subscribeHttpServerRequestStart/unsubscribeHttpServerRequestStart functions and exports them
configuration.js	Adds new configuration option patch_http_with_diagnostics_channel
test/fixtures/cases/config.js	Adds test case for the new configuration option
patch/index.js	Adjusts patch logic to switch between diagnostics_channel and standard patching
.github/workflows/nodejs.yml	Removes scheduled trigger for CI jobs
test/fixtures/cases/logbypass.js	Includes the new environment variable for diagnostics channel patching
test/fixtures/cases/command.js	Updates command configuration expectations with the new option
README.md	Documents the new configuration option

Copilot reviewed 11 out of 11 changed files in this pull request and generated 1 comment.

test/fixtures/cases/logbypass.js

PR Overview

This pull request introduces an optional HTTP monitoring feature that leverages the diagnostics_channel module to capture HTTP request metrics. It updates the patching logic, configuration options, tests, and documentation to support the new patch_http_with_diagnostics_channel flag.

Updated patch/http.js to export and use subscribe/unsubscribe functions for diagnostics_channel.
Revised configuration and test fixtures to include the new diagnostics channel-based patch.
Updated CI workflows and documentation to reflect the change.

Reviewed Changes

File	Description
test/patch/http_with_diagnostics_channel.test.js	New tests for verifying diagnostics_channel-based HTTP request monitoring.
.github/workflows/release.yml	Added release workflow configuration.
patch/http.js	Added subscribeHttpServerRequestStart and unsubscribeHttpServerRequestStart functions, and updated exports.
configuration.js	Introduced new configuration for patch_http_with_diagnostics_channel.
patch/index.js	Updated patch logic to conditionally use diagnostics_channel subscription.
test/fixtures/cases/config.js	Added diagnostics_channel configuration in test cases.
.github/workflows/nodejs.yml	Updated Node.js setup to a newer version.
test/fixtures/cases/logbypass.js	Adjusted environment variable value for diagnostics_channel patch in tests.
test/fixtures/cases/command.js	Updated test commands to check diagnostics_channel-related configuration.
README.md	Documented the new diagnostics_channel patch option.
lib/utils.js	Minor formatting change.

Copilot reviewed 14 out of 14 changed files in this pull request and generated no comments.

fengmk2 · 2025-03-09T15:52:38Z

@hyj1991 node 12 和 14 没法坚持了，github action 都安装不了了。

codecov · 2025-03-09T16:15:22Z

Codecov Report

Attention: Patch coverage is 69.23077% with 4 lines in your changes missing coverage. Please review.

Project coverage is 29.12%. Comparing base (799f075) to head (5846bfd).
Report is 5 commits behind head on master.

Files with missing lines	Patch %	Lines
patch/http.js	77.77%	2 Missing ⚠️
patch/index.js	50.00%	2 Missing ⚠️

❗ There is a different number of reports uploaded between BASE (799f075) and HEAD (5846bfd). Click for more details.

HEAD has 142 uploads less than BASE

Flag BASE (799f075) HEAD (5846bfd)

153 11

Additional details and impacted files

@@             Coverage Diff              @@
##            master     #248       +/-   ##
============================================
- Coverage   100.00%   29.12%   -70.88%     
============================================
  Files           10       10               
  Lines          321      309       -12     
============================================
- Hits           321       90      -231     
- Misses           0      219      +219

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

fengmk2 · 2025-03-10T11:27:18Z

我再重构一下，改成只用 diagnostics_channel 监控 http server request 统计，并且不再支持 Node.js < 18，发一个 major 版本

PR Overview

This PR introduces a new monitoring feature that leverages diagnostics_channel for HTTP server request tracking and drops support for Node.js versions earlier than 18.19.0. Key changes include updates to GitHub workflow configurations (e.g. supported Node.js versions and action versions), modifications to the HTTP instrumentation code in the patch module to use diagnostics_channel subscriptions, and corresponding test updates and documentation changes.

Reviewed Changes

File	Description
.github/workflows/release.yml	Added release workflow configuration
README.md	Updated documentation and supported Node.js runtime version info
.github/workflows/nodejs.yml	Updated GitHub Action configuration and supported node versions
patch/index.js	Switched from patchHttp to subscribeHttpServerRequestStart
test/patch/http.test.js	Adjusted tests to reflect new diagnostic_channel behavior
test/utils.test.js	Minor formatting fix with semicolon
patch/http.js	Refactored HTTP instrumentation to use diagnostics_channel
lib/utils.js	Added missing semicolon for consistency in code formatting

Copilot reviewed 14 out of 14 changed files in this pull request and generated no comments.

Comments suppressed due to low confidence (1)

patch/http.js:29

[nitpick] Consider renaming 'patch_http_timeout' to a more descriptive name like 'httpPatchTimeout' to clearly indicate its purpose as a timeout value used in HTTP instrumentation.

}, patch_http_timeout * 1000);

fengmk2 · 2025-03-10T12:46:47Z

src/platform/win/report_win.cc

@@ -125,7 +125,7 @@ string GetOsVersion() {
  LPSERVER_INFO_101 os_info = NULL;
  NET_API_STATUS nStatus = NetServerGetInfo(NULL, level, (LPBYTE*)&os_info);
  if (nStatus == NERR_Success) {
-    LPSTR os_name = "Windows";
+    std::string os_name = "Windows";


PR Overview

This pull request implements monitoring of HTTP server requests by leveraging the diagnostics_channel API and drops support for Node.js versions below 18.19.0. Key changes include:

Replacing the custom HTTP patching mechanism with diagnostics_channel subscriptions.
Updating GitHub Action workflows to reflect new Node.js version requirements and upgrade action versions.
Adjusting documentation and tests to align with the new behavior.

Reviewed Changes

File	Description
.github/workflows/release.yml	Added release workflow configuration.
README.md	Updated documentation to reflect new monitoring and version support.
.github/workflows/nodejs.yml	Removed outdated schedule and reduced supported node versions.
patch/index.js	Updated patching logic to use diagnostics_channel subscribe API.
test/patch/http.test.js	Adjusted tests to match the new HTTP request monitoring behavior.
test/utils.test.js	Minor syntax update for consistency.
patch/http.js	Refactored HTTP patching to diagnostics_channel with subscribe/unsubscribe functions.
lib/utils.js	Minor code style correction.

Copilot reviewed 15 out of 15 changed files in this pull request and generated no comments.

Comments suppressed due to low confidence (2)

README.md:80

The term 'FataLError' appears to be a typo; consider using 'FatalError' for clarity.

**enable_fatal_error_report**: 是否需要在 V8 出现 FataLError 时导出 Report 文件, 默认 `true`

patch/http.js:15

[nitpick] Consider using a more descriptive name for '_onHttpServerRequestStart' to clearly indicate its role as the diagnostics_channel subscription handler.

let _onHttpServerRequestStart;

[skip ci] ## [3.0.0](v2.6.1...v3.0.0) (2025-03-10) ### ⚠ BREAKING CHANGES * drop Node.js < 18.19.0 support closes X-Profiler/egg-xtransit#10 ### Features * monitor http server request by diagnostics_channel ([#248](#248)) ([293abe8](293abe8))

feat: support monitor http server request by diagnostics_channel

1270982

Usage: ```js XPROFILER_PATCH_HTTP_WITH_DIAGNOSTICS_CHANNEL=YES npm start ``` closes X-Profiler/egg-xtransit#10

fengmk2 added the enhancement New feature or request label Mar 9, 2025

fengmk2 requested review from hyj1991 and Copilot March 9, 2025 15:20

Copilot AI reviewed Mar 9, 2025

View reviewed changes

patch/http.js Show resolved Hide resolved

f

8be48d8

fengmk2 requested a review from Copilot March 9, 2025 15:22

Copilot AI reviewed Mar 9, 2025

View reviewed changes

test/fixtures/cases/logbypass.js Outdated Show resolved Hide resolved

f

683b03b

fengmk2 changed the title ~~feat: support monitor http server request by diagnostics_channel~~ feat: monitor http server request by diagnostics_channel Mar 9, 2025

fengmk2 added 2 commits March 9, 2025 23:29

f

a8ad1b2

auto release

88ed27e

fengmk2 requested a review from Copilot March 9, 2025 15:39

Copilot AI reviewed Mar 9, 2025

View reviewed changes

f

f56ef1b

fengmk2 marked this pull request as draft March 10, 2025 08:43

f

6c9caa3

fengmk2 marked this pull request as ready for review March 10, 2025 11:43

fengmk2 requested a review from Copilot March 10, 2025 11:43

Copilot AI reviewed Mar 10, 2025

View reviewed changes

fix: use std::string to support node 22

64bfb1d

fengmk2 requested a review from Copilot March 10, 2025 12:46

fengmk2 commented Mar 10, 2025

View reviewed changes

Copilot AI reviewed Mar 10, 2025

View reviewed changes

fengmk2 added 3 commits March 10, 2025 20:52

f

1420c4c

f

5b593bb

f

c369e60

fix codecov

5846bfd

fengmk2 merged commit 293abe8 into master Mar 10, 2025
18 of 20 checks passed

fengmk2 deleted the http-monitor-support-esm branch March 10, 2025 13:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: monitor http server request by diagnostics_channel #248

feat: monitor http server request by diagnostics_channel #248

fengmk2 commented Mar 9, 2025 •

edited

Loading

Copilot AI left a comment

Copilot AI left a comment

fengmk2 commented Mar 9, 2025

codecov bot commented Mar 9, 2025 •

edited

Loading

fengmk2 commented Mar 10, 2025

fengmk2 Mar 10, 2025

feat: monitor http server request by diagnostics_channel #248

feat: monitor http server request by diagnostics_channel #248

Conversation

fengmk2 commented Mar 9, 2025 • edited Loading

Copilot AI left a comment

Choose a reason for hiding this comment

PR Overview

Reviewed Changes

Copilot AI left a comment

Choose a reason for hiding this comment

PR Overview

Reviewed Changes

Choose a reason for hiding this comment

PR Overview

Reviewed Changes

fengmk2 commented Mar 9, 2025

codecov bot commented Mar 9, 2025 • edited Loading

Codecov Report

fengmk2 commented Mar 10, 2025

Choose a reason for hiding this comment

PR Overview

Reviewed Changes

fengmk2 Mar 10, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

PR Overview

Reviewed Changes

fengmk2 commented Mar 9, 2025 •

edited

Loading

codecov bot commented Mar 9, 2025 •

edited

Loading