winsvc: Stop the service when the supervisor is dead #4909

ashie · 2025-04-21T07:28:28Z

Which issue(s) this PR fixes:
None.

What this PR does / why we need it:
Even if the supervisor process is dead due to config error or etc, the service process will continue running unexpectedly because no one monitor it. This commit fix this issue.

Docs Changes:
Not needed.

Release Note:
Same with the title.

ashie · 2025-04-21T07:49:03Z

Unfortunately it's hard to write tests for windows service.
Instead I tested this code manually and confirmed that it works fine.

Watson1978

👍🏻

lib/fluent/winsvc.rb

daipom · 2025-04-23T04:27:34Z

Thanks!

I share my check scripts for now.

/test/run.rb

require "win32/daemon"
require "win32/service"

class TestService < Win32::Daemon
  File.open("/test/log/test_service.log", 'a') { |f| f.puts "#{Time.now.inspect}, TestService init" }

  def service_main
    count = 0
    while running?
      File.open("/test/log/test_service.log", 'a') { |f| f.puts "#{Time.now.inspect}, TestService mainloop" }
      sleep 2
      begin
        count += 1
        raise Errno::ECHILD if count >= 2
      rescue Errno::ECHILD
        File.open("/test/log/test_service.log", 'a') { |f| f.puts "#{Time.now.inspect}, TestService trigger stop" }
        SetTheServiceStatus.call(SERVICE_STOPPED, Errno::ECHILD::Errno, 0, 0)
        # Service.stop("testservice")
        # SetEvent(@@hStopEvent)
        break
      end
    end
  end

  def service_stop
    File.open("/test/log/command_receiver_thread.log", 'a') { |f| f.puts "#{Time.now.inspect}, TestService service_stop called" }
  end
end

TestService.new.mainloop

Install debug win32_service
- https://github.com/fluent-plugins-nursery/win32-service/tree/fix-slow-start-with-ruby3-with-debug-logs
- rake install
Register service

require "win32/service"

# Specify ruby bin path
ruby_path = "C:\\Ruby32-x64\\bin\\ruby.exe"

Win32::Service.create(
  service_name: "testservice",
  binary_path_name: "\"#{ruby_path}\" C:\\test\\run.rb",
  display_name: "testservice",
)

Prepare /test/log/ dir
Run powershell script

echo "Clear logs"
rm /test/log/*

echo "Start the service"
Start-Service testservice

echo "Waiting for a while ..."
sleep 6

echo "Check service status:"
Get-Service testservice

echo "`nCheck Ruby process:"
ps -Name ruby

echo "`nLog:"
cat /test/log/* | sort

echo "`nLatest System EventLogs:"
Get-EventLog System -newest 3 | fl *

daipom

@ashie
Thanks!
This seems to be the right way to stop the service process!

I have commented on some minor points.
Please check them.

lib/fluent/winsvc.rb

Even if the supervisor process is dead due to config error or etc, the service process will continue running unexpectedly because no one monitor it. This commit fix this issue. Signed-off-by: Takuro Ashie <[email protected]>

daipom

Thanks! LGTM!

**Which issue(s) this PR fixes**: None. **What this PR does / why we need it**: Even if the supervisor process is dead due to config error or etc, the service process will continue running unexpectedly because no one monitor it. This commit fix this issue. **Docs Changes**: Not needed. **Release Note**: Same with the title. Signed-off-by: Takuro Ashie <[email protected]> Signed-off-by: Kentaro Hayashi <[email protected]>

…#4909) (#4942) **Which issue(s) this PR fixes**: Backport #4909 None. **What this PR does / why we need it**: Even if the supervisor process is dead due to config error or etc, the service process will continue running unexpectedly because no one monitor it. This commit fix this issue. **Docs Changes**: Not needed. **Release Note**: Same with the title. Signed-off-by: Takuro Ashie <[email protected]> Signed-off-by: Kentaro Hayashi <[email protected]> Co-authored-by: Takuro Ashie <[email protected]>

After 53bcd3c (fluent#4909), the service accidentally stops after starting, without stopping the supervisor and workers. Signed-off-by: Daijiro Fukuda <[email protected]>

daipom · 2025-05-13T05:58:51Z

I'm sorry.
My suggestion was wrong: #4909 (comment)
The if condition was reversed.
The service accidentally stops after starting, without stopping the supervisor and workers.

I have made a PR to fix this bug and adding tests:

winsvc: Fix bug where service accidentally stops after starting #4954

After 53bcd3c (fluent#4909), the service accidentally stops after starting, without stopping the supervisor and workers. Signed-off-by: Daijiro Fukuda <[email protected]>

After 53bcd3c (fluent#4909), the service accidentally stops after starting, without stopping the supervisor and workers. Signed-off-by: Daijiro Fukuda <[email protected]> Co-authored-by: Takuro Ashie <[email protected]>

After 53bcd3c (fluent#4909), the service accidentally stops after starting, without stopping the supervisor and workers. Signed-off-by: Daijiro Fukuda <[email protected]> Co-authored-by: Takuro Ashie <[email protected]> Co-authored-by: Kentaro Hayashi <[email protected]>

**Which issue(s) this PR fixes**: This fixes a bug of #4909. **What this PR does / why we need it**: After 53bcd3c (#4909), the service accidentally stops after starting, without stopping the supervisor and workers. **Docs Changes**: Not needed. **Release Note**: The same as the title. Signed-off-by: Daijiro Fukuda <[email protected]> Co-authored-by: Takuro Ashie <[email protected]> Co-authored-by: Kentaro Hayashi <[email protected]>

**Which issue(s) this PR fixes**: This fixes a bug of #4909. **What this PR does / why we need it**: After 53bcd3c (#4909), the service accidentally stops after starting, without stopping the supervisor and workers. **Docs Changes**: Not needed. **Release Note**: The same as the title. Signed-off-by: Daijiro Fukuda <[email protected]> Co-authored-by: Takuro Ashie <[email protected]> Co-authored-by: Kentaro Hayashi <[email protected]> Signed-off-by: Daijiro Fukuda <[email protected]>

…er starting (#4954) (#4955) **Which issue(s) this PR fixes**: Backport #4954. **What this PR does / why we need it**: After 53bcd3c (#4909), the service accidentally stops after starting, without stopping the supervisor and workers. **Docs Changes**: Not needed. **Release Note**: The same as the title. Signed-off-by: Daijiro Fukuda <[email protected]> Co-authored-by: Takuro Ashie <[email protected]> Co-authored-by: Kentaro Hayashi <[email protected]>

ashie requested review from Watson1978 and daipom April 21, 2025 07:30

ashie force-pushed the win32-service-watch-supervisor branch from 7c6e0ab to a254703 Compare April 21, 2025 07:45

Watson1978 previously approved these changes Apr 22, 2025

View reviewed changes

Watson1978 added the backport to v1.16 We will backport this fix to the LTS branch label Apr 22, 2025

daipom added this to the v1.19.0 milestone Apr 22, 2025

daipom reviewed Apr 22, 2025

View reviewed changes

lib/fluent/winsvc.rb Outdated Show resolved Hide resolved

ashie marked this pull request as draft April 23, 2025 00:50

ashie dismissed Watson1978’s stale review via 82dba11 April 23, 2025 04:20

ashie force-pushed the win32-service-watch-supervisor branch from a254703 to 82dba11 Compare April 23, 2025 04:20

daipom reviewed Apr 24, 2025

View reviewed changes

lib/fluent/winsvc.rb Outdated Show resolved Hide resolved

lib/fluent/winsvc.rb Outdated Show resolved Hide resolved

lib/fluent/winsvc.rb Outdated Show resolved Hide resolved

ashie force-pushed the win32-service-watch-supervisor branch from 82dba11 to 2ef6a86 Compare April 25, 2025 09:44

winsvc: Stop the service when the supervisor is dead

3b9c442

Even if the supervisor process is dead due to config error or etc, the service process will continue running unexpectedly because no one monitor it. This commit fix this issue. Signed-off-by: Takuro Ashie <[email protected]>

ashie force-pushed the win32-service-watch-supervisor branch from 2ef6a86 to 3b9c442 Compare April 25, 2025 09:59

ashie marked this pull request as ready for review April 25, 2025 10:02

daipom approved these changes Apr 25, 2025

View reviewed changes

daipom mentioned this pull request Apr 26, 2025

OSS Gate Workshop: tokyo: 2025-04-26: daipom: fluentd: Work log oss-gate/workshop#1941

Closed

daipom merged commit 53bcd3c into master Apr 28, 2025
13 checks passed

daipom deleted the win32-service-watch-supervisor branch April 28, 2025 01:03

kenhys mentioned this pull request Apr 30, 2025

Backport(v1.16): winsvc: Stop the service when the supervisor is dead (#4909) kenhys/fluentd#23

Closed

kenhys mentioned this pull request Apr 30, 2025

Backport(v1.16): winsvc: Stop the service when the supervisor is dead (#4909) #4942

Merged

daipom added the backported "backport to LTS" is done label Apr 30, 2025

daipom mentioned this pull request May 13, 2025

winsvc: Fix bug where service accidentally stops after starting #4954

Merged

daipom mentioned this pull request May 14, 2025

Backport(v1.16): winsvc: Fix bug where service accidentally stops after starting (#4954) #4955

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

winsvc: Stop the service when the supervisor is dead #4909

winsvc: Stop the service when the supervisor is dead #4909

Uh oh!

ashie commented Apr 21, 2025

Uh oh!

ashie commented Apr 21, 2025

Uh oh!

Watson1978 left a comment

Uh oh!

Uh oh!

daipom commented Apr 23, 2025 •

edited

Loading

Uh oh!

daipom left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

daipom left a comment

Uh oh!

Uh oh!

daipom commented May 13, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

winsvc: Stop the service when the supervisor is dead #4909

winsvc: Stop the service when the supervisor is dead #4909

Uh oh!

Conversation

ashie commented Apr 21, 2025

Uh oh!

ashie commented Apr 21, 2025

Uh oh!

Watson1978 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

daipom commented Apr 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

daipom left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

daipom left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

daipom commented May 13, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

daipom commented Apr 23, 2025 •

edited

Loading