引入外部日志配置文件时Windows服务启动失败排查

Hey there, let's break down why your Windows service won't start after packaging with PyInstaller—especially since you're seeing an empty log file (so we know the config is being picked up). Here are actionable steps to diagnose and fix the issue:

1. Fix Path Handling for Single-File Exes #

PyInstaller's -F (single-file) mode extracts your app to a temporary runtime directory when executed. Your current code uses path.abspath(__file__), which points to the temporary unpacked script—not the actual EXE location. Worse, Windows services default to running from C:\Windows\System32, so relative paths get messed up fast.

Update your log config path logic to target the EXE's actual directory:

import sys
import os

def get_log_config_path():
    if getattr(sys, 'frozen', False):
        # Running as bundled EXE: use the EXE's directory
        exe_dir = os.path.dirname(sys.executable)
    else:
        # Running as a script: use the current script's directory
        exe_dir = os.path.dirname(os.path.abspath(__file__))
    return os.path.join(exe_dir, 'logging.conf')

# Initialize logging
log_file_path = get_log_config_path()
logging.config.fileConfig(log_file_path)

2. Capture Startup Exceptions (Even When Logs Fail) #

An empty log file suggests the service crashes before it can write to the log. Add error handling to your service class to log crashes to the Windows Event Viewer—this is a lifesaver for service debugging:

import win32event
import win32serviceutil
import logging
import traceback
import win32evtlog
import win32evtlogutil

class MyService(win32serviceutil.ServiceFramework):
    _svc_name_ = "YourServiceName"
    _svc_display_name_ = "Your Service Display Name"

    def __init__(self, args):
        win32serviceutil.ServiceFramework.__init__(self, args)
        self.hWaitStop = win32event.CreateEvent(None, 0, 0, None)
        try:
            # Initialize logging here with the fixed path
            log_file_path = get_log_config_path()
            logging.config.fileConfig(log_file_path)
            self.logger = logging.getLogger(__name__)
            self.logger.info("Service initialized successfully")
        except Exception as e:
            # Send error to Event Viewer
            win32evtlogutil.ReportEvent(
                self._svc_name_,
                0,
                eventType=win32evtlog.EVENTLOG_ERROR_TYPE,
                strings=[
                    "Service Initialization Failed",
                    f"Error Message: {str(e)}",
                    f"Traceback:\n{traceback.format_exc()}"
                ]
            )
            raise  # Re-raise to let Windows know initialization failed

    def SvcDoRun(self):
        try:
            self.logger.info("Service started successfully")
            # Your core service logic goes here
            win32event.WaitForSingleObject(self.hWaitStop, win32event.INFINITE)
        except Exception as e:
            self.logger.error(f"Service runtime error: {str(e)}", exc_info=True)
            # Fallback to Event Viewer if logging fails
            win32evtlogutil.ReportEvent(
                self._svc_name_,
                0,
                eventType=win32evtlog.EVENTLOG_ERROR_TYPE,
                strings=[
                    "Service Runtime Failure",
                    f"Error Message: {str(e)}",
                    f"Traceback:\n{traceback.format_exc()}"
                ]
            )

    def SvcStop(self):
        self.logger.info("Service stopping")
        self.ReportServiceStatus(win32service.SERVICE_STOP_PENDING)
        win32event.SetEvent(self.hWaitStop)

3. Verify Hidden Imports #

PyInstaller sometimes misses dependencies for win32service modules. Expand your hidden imports to cover critical components:

pyinstaller -F <main-file>.py -n <exe-name> --hidden-import=win32timezone --hidden-import=win32service --hidden-import=win32event --hidden-import=win32evtlog --add-data "logging.conf;."

4. Test Without Single-File Mode #

Temporarily remove the -F flag and package as a directory. If the service starts normally, the issue is tied to single-file runtime unpacking. You can then narrow down if it's path-related or resource-access related.

5. Check Service Permissions #

Even if the log file is created, your service might lack permissions for other operations (e.g., accessing files, network resources). Try:

• Opening Services.msc, right-click your service → Properties → Log On
• Switch to a local admin account instead of the default Local System
• Restart the service to test

6. Dig Into Windows Event Logs #

Windows tracks service failures in the Event Viewer. Go to:
Event Viewer → Windows Logs → Application
Look for entries from Service Control Manager or your service name—these often include specific error codes or failure descriptions that point directly to the problem.

内容的提问来源于stack exchange，提问作者shasan