La forma más fácil de depurar un servicio de Windows

¿Hay una manera más fácil de recorrer el código que iniciar el servicio a través del Administrador de control de servicios de Windows y luego adjuntar el depurador al hilo? Es un poco engorroso y me pregunto si hay un enfoque más directo.

Si quiero depurar rápidamente el servicio, simplemente entro Debugger.Break()allí. Cuando se alcanza esa línea, me devolverá a VS. No olvide eliminar esa línea cuando haya terminado.

ACTUALIZACIÓN: Como alternativa a los #if DEBUGpragmas, también puede usar el Conditional("DEBUG_SERVICE")atributo.

[Conditional("DEBUG_SERVICE")]
private static void DebugMode()
{
    Debugger.Break();
}

En su OnStart, simplemente llame a este método:

public override void OnStart()
{
     DebugMode();
     /* ... do the rest */
}

Allí, el código solo se habilitará durante las compilaciones de depuración. Mientras lo hace, puede ser útil crear una configuración de compilación separada para la depuración del servicio.

También creo que tener una "versión" separada para la ejecución normal y como servicio es el camino a seguir, pero ¿es realmente necesario dedicar un interruptor de línea de comando separado para ese propósito?

¿No podrías simplemente hacer:

public static int Main(string[] args)
{
  if (!Environment.UserInteractive)
  {
    // Startup as service.
  }
  else
  {
    // Startup as application
  }
}

Eso tendría el "beneficio" de que puede iniciar su aplicación mediante un doble clic (OK, si realmente lo necesita) y que puede presionar F5en Visual Studio (sin la necesidad de modificar la configuración del proyecto para incluir esa /consoleOpción).

Técnicamente, Environment.UserInteractivecomprueba si el WSF_VISIBLEindicador está configurado para la estación de ventana actual, pero ¿hay alguna otra razón por la que regresaría false, además de ejecutarse como un servicio (no interactivo)?

Cuando configuré un nuevo proyecto de servicio hace unas semanas, encontré esta publicación. Si bien hay muchas sugerencias geniales, todavía no encontré la solución que quería: la posibilidad de llamar a las clases OnStarty OnStopmétodos de servicio sin ninguna modificación a las clases de servicio.

La solución que se me ocurrió utiliza el Environment.Interactivemodo de ejecución selectivo, como lo sugieren otras respuestas a esta publicación.

static void Main()
{
    ServiceBase[] servicesToRun;
    servicesToRun = new ServiceBase[] 
    {
        new MyService()
    };
    if (Environment.UserInteractive)
    {
        RunInteractive(servicesToRun);
    }
    else
    {
        ServiceBase.Run(servicesToRun);
    }
}

El RunInteractiveayudante usa la reflexión para llamar a los métodos OnStarty protegidos OnStop:

static void RunInteractive(ServiceBase[] servicesToRun)
{
    Console.WriteLine("Services running in interactive mode.");
    Console.WriteLine();

    MethodInfo onStartMethod = typeof(ServiceBase).GetMethod("OnStart", 
        BindingFlags.Instance | BindingFlags.NonPublic);
    foreach (ServiceBase service in servicesToRun)
    {
        Console.Write("Starting {0}...", service.ServiceName);
        onStartMethod.Invoke(service, new object[] { new string[] { } });
        Console.Write("Started");
    }

    Console.WriteLine();
    Console.WriteLine();
    Console.WriteLine(
        "Press any key to stop the services and end the process...");
    Console.ReadKey();
    Console.WriteLine();

    MethodInfo onStopMethod = typeof(ServiceBase).GetMethod("OnStop", 
        BindingFlags.Instance | BindingFlags.NonPublic);
    foreach (ServiceBase service in servicesToRun)
    {
        Console.Write("Stopping {0}...", service.ServiceName);
        onStopMethod.Invoke(service, null);
        Console.WriteLine("Stopped");
    }

    Console.WriteLine("All services stopped.");
    // Keep the console alive for a second to allow the user to see the message.
    Thread.Sleep(1000);
}

Este es todo el código requerido, pero también escribí un tutorial con explicaciones.

A veces es importante analizar lo que sucede durante el inicio del servicio. Adjuntar al proceso no ayuda aquí, porque no es lo suficientemente rápido como para adjuntar el depurador mientras se inicia el servicio.

La respuesta corta es que estoy usando las siguientes 4 líneas de código para hacer esto:

#if DEBUG
    base.RequestAdditionalTime(600000); // 600*1000ms = 10 minutes timeout
    Debugger.Launch(); // launch and attach debugger
#endif

Estos se insertan en el OnStartmétodo del servicio de la siguiente manera:

protected override void OnStart(string[] args)
{
    #if DEBUG
       base.RequestAdditionalTime(600000); // 10 minutes timeout for startup
       Debugger.Launch(); // launch and attach debugger
    #endif
    MyInitOnstart(); // my individual initialization code for the service
    // allow the base class to perform any work it needs to do
    base.OnStart(args);
}

Para aquellos que no lo han hecho antes, he incluido consejos detallados a continuación , porque pueden atascarse fácilmente. Las siguientes sugerencias se refieren a Windows 7x64 y Visual Studio 2010 Team Edition , pero también deberían ser válidas para otros entornos.

Importante: Implemente el servicio en modo "manual" (utilizando la InstallUtilutilidad desde el símbolo del sistema VS o ejecute un proyecto de instalador de servicio que haya preparado). Abra Visual Studio antes de iniciar el servicio y cargue la solución que contiene el código fuente del servicio, configure puntos de interrupción adicionales según lo requiera en Visual Studio, luego inicie el servicio a través del Panel de control del servicio.

Debido al Debugger.Launchcódigo, esto generará un cuadro de diálogo "Se produjo una excepción no controlada de Microsoft .NET Framework en Servicename.exe ". a aparecer. Haga clic como se muestra en la captura de pantalla: Yes, debug Servicename.exe

Posteriormente, especialmente en Windows 7 UAC puede solicitarle que ingrese las credenciales de administrador. Ingrese y proceda con Yes:

Después de eso, aparece la conocida ventana del depurador Just-In-Time de Visual Studio . Le pregunta si desea depurar utilizando el depurador eliminado. Antes de hacer clic Yes, seleccione que no desea abrir una nueva instancia (segunda opción); una nueva instancia no sería útil aquí, porque el código fuente no se mostraría. Entonces, seleccione la instancia de Visual Studio que abrió anteriormente:

Después de hacer clic Yes, Visual Studio mostrará la flecha amarilla justo en la línea donde está la Debugger.Launchinstrucción y podrá depurar su código (método MyInitOnStart, que contiene su inicialización).

Al presionar F5continúa la ejecución de inmediato, hasta que se alcanza el siguiente punto de interrupción que ha preparado.

Sugerencia: para mantener el servicio en funcionamiento, seleccione Depurar -> Separar todo . Esto le permite ejecutar un cliente que se comunica con el servicio después de que se haya iniciado correctamente y haya terminado de depurar el código de inicio. Si presiona Shift+F5 (detener la depuración), esto terminará el servicio. En lugar de hacer esto, debe usar el Panel de control de servicio para detenerlo.

Tenga en cuenta que

• Si crea una versión, el código de depuración se elimina automáticamente y el servicio se ejecuta normalmente.

• Estoy usando Debugger.Launch(), que inicia y adjunta un depurador . También lo probé Debugger.Break(), lo que no funcionó , porque todavía no hay un depurador conectado al iniciar el servicio (causando el "Error 1067: El proceso finalizó inesperadamente" ).

• RequestAdditionalTimeestablece un largo tiempo de espera para el inicio del servicio (se no retrasar el código en sí mismo, sino que continuará inmediatamente con la Debugger.Launchdeclaración). De lo contrario, el tiempo de espera predeterminado para iniciar el servicio es demasiado corto y el servicio falla si no llama base.Onstart(args)lo suficientemente rápido desde el depurador. Prácticamente, un tiempo de espera de 10 minutos evita que vea el mensaje " el servicio no respondió ..." inmediatamente después de que se inicia el depurador.

• Una vez que te acostumbras, este método es muy fácil porque solo requiere que agregues 4 líneas a un código de servicio existente, lo que te permite obtener rápidamente control y depuración.

Lo que generalmente hago es encapsular la lógica del servicio en una clase separada y comenzar eso desde una clase 'runner'. Esta clase de corredor puede ser el servicio real o simplemente una aplicación de consola. Entonces su solución tiene (al menos) 3 proyectos:

/ConsoleRunner
   /....
/ServiceRunner
   /....
/ApplicationLogic
   /....

Este video de YouTube de Fabio Scopel explica cómo depurar un servicio de Windows bastante bien ... el método real de hacerlo comienza a las 4:45 en el video ...

Aquí está el código explicado en el video ... en su archivo Program.cs, agregue las cosas para la sección de Depuración ...

namespace YourNamespace
{
    static class Program
    {
        /// <summary>
        /// The main entry point for the application.
        /// </summary>
        static void Main()
        {
#if DEBUG
            Service1 myService = new Service1();
            myService.OnDebug();
            System.Threading.Thread.Sleep(System.Threading.Timeout.Infinite);
#else
            ServiceBase[] ServicesToRun;
            ServicesToRun = new ServiceBase[]
            {
                new Service1()
            };
            ServiceBase.Run(ServicesToRun);
#endif

        }
    }
}

En su archivo Service1.cs, agregue el método OnDebug () ...

    public Service1()
    {
        InitializeComponent();
    }

    public void OnDebug()
    {
        OnStart(null);
    }

    protected override void OnStart(string[] args)
    {
        // your code to do something
    }

    protected override void OnStop()
    {
    }

Cómo funciona

Básicamente, debe crear un public void OnDebug()que llame al OnStart(string[] args)ya que está protegido y no es accesible desde el exterior. El void Main()programa se agrega con #ifpreprocesador con #DEBUG.

Visual Studio define DEBUGsi el proyecto se compila en modo de depuración. Esto permitirá que la sección de depuración (a continuación) se ejecute cuando la condición sea verdadera

Service1 myService = new Service1();
myService.OnDebug();
System.Threading.Thread.Sleep(System.Threading.Timeout.Infinite);

Y se ejecutará como una aplicación de consola, una vez que las cosas salgan bien, puede cambiar el modo Releasey la elsesección normal activará la lógica

ACTUALIZAR

Este enfoque es, con mucho, el más fácil:

http://www.codeproject.com/KB/dotnet/DebugWinServices.aspx

Dejo mi respuesta original a continuación para la posteridad.

Mis servicios tienden a tener una clase que encapsula un temporizador, ya que quiero que el servicio verifique a intervalos regulares si hay algún trabajo que hacer.

Actualizamos la clase y llamamos a StartEventLoop () durante el inicio del servicio. (Esta clase también podría usarse fácilmente desde una aplicación de consola).

El agradable efecto secundario de este diseño es que los argumentos con los que configura el temporizador se pueden usar para tener un retraso antes de que el servicio realmente comience a funcionar, de modo que tenga tiempo para adjuntar un depurador manualmente.

ps ¿Cómo adjuntar el depurador manualmente a un proceso en ejecución ...?

using System;
using System.Threading;
using System.Configuration;    

public class ServiceEventHandler
{
    Timer _timer;
    public ServiceEventHandler()
    {
        // get configuration etc.
        _timer = new Timer(
            new TimerCallback(EventTimerCallback)
            , null
            , Timeout.Infinite
            , Timeout.Infinite);
    }

    private void EventTimerCallback(object state)
    {
        // do something
    }

    public void StartEventLoop()
    {
        // wait a minute, then run every 30 minutes
        _timer.Change(TimeSpan.Parse("00:01:00"), TimeSpan.Parse("00:30:00");
    }
}

También solía hacer lo siguiente (ya se mencionó en respuestas anteriores pero con los indicadores del compilador condicional [#if] para ayudar a evitar que se active en una versión de lanzamiento).

Dejé de hacerlo de esta manera porque a veces nos olvidamos de compilar en Release y tener una interrupción del depurador en una aplicación que se ejecuta en una demostración de cliente (¡vergonzoso!).

#if DEBUG
if (!System.Diagnostics.Debugger.IsAttached)
{
    System.Diagnostics.Debugger.Break();
}
#endif

static void Main()
{
#if DEBUG
                // Run as interactive exe in debug mode to allow easy
                // debugging.

                var service = new MyService();
                service.OnStart(null);

                // Sleep the main thread indefinitely while the service code
                // runs in .OnStart

                Thread.Sleep(Timeout.Infinite);
#else
                // Run normally as service in release mode.

                ServiceBase[] ServicesToRun;
                ServicesToRun = new ServiceBase[]{ new MyService() };
                ServiceBase.Run(ServicesToRun);
#endif
}

También puede iniciar el servicio a través del símbolo del sistema (sc.exe).

Personalmente, ejecutaría el código como un programa independiente en la fase de depuración, y cuando se solucionen la mayoría de los errores, cambiaría a ejecutar como servicio.

Lo que solía hacer era tener un interruptor de línea de comando que iniciara el programa como un servicio o como una aplicación normal. Luego, en mi IDE, configuraría el interruptor para poder pasar por mi código.

Con algunos idiomas, puede detectar si se está ejecutando en un IDE y realizar este cambio automáticamente.

Qué idioma estás usando?

Use la biblioteca TopShelf .

Cree una aplicación de consola y luego configure la configuración en su Main

class Program
    {
        static void Main(string[] args)
        {
            HostFactory.Run(x =>
            {

                // setup service start and stop.
                x.Service<Controller>(s =>
                {
                    s.ConstructUsing(name => new Controller());
                    s.WhenStarted(controller => controller.Start());
                    s.WhenStopped(controller => controller.Stop());
                });

                // setup recovery here
                x.EnableServiceRecovery(rc =>
                {
                    rc.RestartService(delayInMinutes: 0);
                    rc.SetResetPeriod(days: 0);
                });

                x.RunAsLocalSystem();
            });
        }
}

public class Controller
    {
        public void Start()
        {

        }

        public void Stop()
        {

        }
    }

Para depurar su servicio, simplemente presione F5 en Visual Studio.

Para instalar el servicio, escriba cmd "console.exe install"

Luego puede iniciar y detener el servicio en el administrador de servicios de Windows.

Creo que depende del sistema operativo que esté utilizando, Vista es mucho más difícil de conectar a los Servicios, debido a la separación entre sesiones.

Las dos opciones que he usado en el pasado son:

• Use GFlags (en las Herramientas de depuración para Windows) para configurar un depurador permanente para un proceso. Esto existe en la clave de registro "Opciones de ejecución de archivos de imagen" y es increíblemente útil. Creo que deberá ajustar la configuración del Servicio para habilitar "Interactuar con el escritorio". Lo uso para todo tipo de depuración, no solo para servicios.
• La otra opción es separar un poco el código, de modo que la parte del servicio sea intercambiable con un inicio normal de la aplicación. De esa manera, puede usar un indicador de línea de comando simple y ejecutarlo como un proceso (en lugar de un Servicio), lo que facilita mucho la depuración.

Espero que esto ayude.

Me gusta poder depurar todos los aspectos de mi servicio, incluida cualquier inicialización en OnStart (), mientras lo ejecuto con un comportamiento de servicio completo en el marco del SCM ... sin modo "consola" o "aplicación".

Hago esto creando un segundo servicio, en el mismo proyecto, para usar para la depuración. El servicio de depuración, cuando se inicia como de costumbre (es decir, en el complemento MMC de servicios), crea el proceso de host del servicio. Esto le proporciona un proceso para adjuntar el depurador a pesar de que aún no ha comenzado su servicio real. Después de adjuntar el depurador al proceso, inicie su servicio real y podrá acceder a él en cualquier parte del ciclo de vida del servicio, incluido OnStart ().

Debido a que requiere una intrusión de código muy mínima, el servicio de depuración se puede incluir fácilmente en su proyecto de configuración del servicio, y se elimina fácilmente de su versión de producción comentando una sola línea de código y eliminando un solo instalador del proyecto.

Detalles:

1) Suponiendo que está implementando MyService, también cree MyServiceDebug. Agregue ambos a la ServiceBasematriz de la siguiente Program.csmanera:

    /// <summary>
    /// The main entry point for the application.
    /// </summary>
    static void Main()
    {
        ServiceBase[] ServicesToRun;
        ServicesToRun = new ServiceBase[] 
        { 
            new MyService(),
            new MyServiceDebug()
        };
        ServiceBase.Run(ServicesToRun);
    }

2) Agregue el servicio real Y el servicio de depuración al instalador del proyecto para el proyecto de servicio:

Ambos servicios (real y depuración) se incluyen cuando agrega la salida del proyecto de servicio al proyecto de configuración para el servicio. Después de la instalación, ambos servicios aparecerán en el complemento service.msc MMC.

3) Inicie el servicio de depuración en MMC.

4) En Visual Studio, adjunte el depurador al proceso iniciado por el servicio de depuración.

5) Inicie el servicio real y disfrute de la depuración.

Cuando escribo un servicio pongo toda la lógica del servicio en un proyecto dll y creo dos "hosts" que llaman a este dll, uno es un servicio de Windows y el otro es una aplicación de línea de comandos.

Utilizo la aplicación de línea de comandos para depurar y adjunto el depurador al servicio real solo para errores que no puedo reproducir en la aplicación de línea de comandos.

Si utiliza este enfoque, recuerde que debe probar todo el código mientras se ejecuta en un servicio real, mientras que la herramienta de línea de comandos es una buena ayuda para la depuración, es un entorno diferente y no se comporta exactamente como un servicio real.

Al desarrollar y depurar un servicio de Windows, normalmente lo ejecuto como una aplicación de consola agregando un parámetro de inicio / console y verificando esto. Hace la vida mucho más fácil.

static void Main(string[] args) {
    if (Console.In != StreamReader.Null) {
        if (args.Length > 0 && args[0] == "/console") {
            // Start your service work.
        }
    }
}

¿Qué hay de Debugger.Break () en la primera línea?

Para depurar los servicios de Windows combino GFlags y un archivo .reg creado por regedit.

1. Ejecute GFlags, especificando el nombre del exe y vsjitdebugger
2. Ejecute regedit y vaya a la ubicación donde GFlags establece sus opciones
3. Elija "Exportar clave" en el menú archivo
4. Guarde ese archivo en algún lugar con la extensión .reg
5. Cada vez que desee depurar el servicio: haga doble clic en el archivo .reg
6. Si desea detener la depuración, haga doble clic en el segundo archivo .reg

O guarde los siguientes fragmentos y reemplace servicename.exe con el nombre ejecutable deseado.

debugon.reg:

Editor del Registro de Windows Versión 5.00

[HKEY_LOCAL_MACHINE \ SOFTWARE \ Microsoft \ Windows NT \ CurrentVersion \ Image File Execution Options \ servicename.exe]
"GlobalFlag" = "0x00000000"
"Debugger" = "vsjitdebugger.exe"

debugoff.reg:

Editor del Registro de Windows Versión 5.00

[HKEY_LOCAL_MACHINE \ SOFTWARE \ Microsoft \ Windows NT \ CurrentVersion \ Image File Execution Options \ servicename.exe]
"GlobalFlag" = "0x00000000"

Para la programación rutinaria de cosas pequeñas, he hecho un truco muy simple para depurar fácilmente mi servicio:

Al inicio del servicio, verifico si hay un parámetro de línea de comando "/ debug". Si se llama al servicio con este parámetro, no hago el inicio del servicio habitual, sino que inicio a todos los oyentes y solo visualizo un cuadro de mensaje "Depuración en progreso, presiono ok para finalizar".

Entonces, si mi servicio se inicia de la manera habitual, comenzará como servicio, si se inicia con el parámetro / depuración de la línea de comando, actuará como un programa normal.

En VS simplemente agregaré / depuraré como parámetro de depuración e iniciaré el programa de servicio directamente.

De esta manera, puedo depurar fácilmente la mayoría de los problemas pequeños. Por supuesto, algunas cosas aún deberán ser depuradas como servicio, pero para el 99% esto es lo suficientemente bueno.

#if DEBUG
    System.Diagnostics.Debugger.Break();
#endif

Yo uso una variación en la respuesta de JOP. Con los parámetros de la línea de comandos, puede establecer el modo de depuración en el IDE con las propiedades del proyecto o mediante el administrador de servicios de Windows.

protected override void OnStart(string[] args)
{
  if (args.Contains<string>("DEBUG_SERVICE"))
  {
    Debugger.Break();
  }
  ...
}

Para solucionar problemas en el programa de servicio de Windows existente, use 'Debugger.Break ()' como sugirieron otros chicos.

Para el nuevo programa de servicio de Windows, sugeriría utilizar el método de James Michael Hare http://geekswithblogs.net/BlackRabbitCoder/archive/2011/03/01/c-toolbox-debug-able-self-installable-windows-service-template- redux.aspx

Simplemente ponga su almuerzo de depuración en cualquier lugar y adjunte Visualstudio al inicio

#if DEBUG
    Debugger.Launch();
#endif

También debe iniciar VS como Administatrator y debe permitir que un usuario diferente pueda depurar un proceso (como se explica aquí ):

reg add "HKCR\AppID{E62A7A31-6025-408E-87F6-81AEB0DC9347}" /v AppIDFlags /t REG_DWORD /d 8 /f

Use el proyecto de plantilla de servicio de Windows C # para crear una nueva aplicación de servicio https://github.com/HarpyWar/windows-service-template

Hay modo de consola / servicio detectado automáticamente, instalador automático / desinstalador de su servicio y se incluyen varias de las funciones más utilizadas.

Aquí está el método simple que utilicé para probar el servicio, sin ningún método adicional de "depuración" y con pruebas de unidad VS integradas.

[TestMethod]
public void TestMyService()
{
    MyService fs = new MyService();

    var OnStart = fs.GetType().BaseType.GetMethod("OnStart", BindingFlags.NonPublic | BindingFlags.Public | BindingFlags.Instance | BindingFlags.Static);

    OnStart.Invoke(fs, new object[] { null });
}

// As an extension method
public static void Start(this ServiceBase service, List<string> parameters)
{
     string[] par = parameters == null ? null : parameters.ToArray();

     var OnStart = service.GetType().GetMethod("OnStart", BindingFlags.NonPublic | BindingFlags.Public | BindingFlags.Instance | BindingFlags.Static);

     OnStart.Invoke(service, new object[] { par });
}

static class Program
{
    static void Main()
    {
        #if DEBUG

        // TODO: Add code to start application here

        //    //If the mode is in debugging
        //    //create a new service instance
        Service1 myService = new Service1();

        //    //call the start method - this will start the Timer.
        myService.Start();

        //    //Set the Thread to sleep
        Thread.Sleep(300000);

        //    //Call the Stop method-this will stop the Timer.
        myService.Stop();

         #else
        ServiceBase[] ServicesToRun;
        ServicesToRun = new ServiceBase[] 
        { 
            new Service1() 
        };

        ServiceBase.Run(ServicesToRun);
         #endif
    }
}

Tienes dos opciones para hacer la depuración.

1. crear un archivo de registro: Personalmente, prefiero un archivo de registro separado como un archivo de texto en lugar de usar el registro de la aplicación o el registro de eventos, pero esto le costará mucho en nombre del tiempo, porque aún es difícil determinar dónde está la ubicación exacta del error
2. Convierta la aplicación a la aplicación de consola: esto le permitirá tener todas las herramientas de depuración que podemos usar en VS.

Consulte ESTA publicación de blog que creé para el tema.

Solo pegar

Debugger.Break();

en cualquier parte de tu código.

Por ejemplo ,

internal static class Program
    {
        /// <summary>
        /// The main entry point for the application.
        /// </summary>
        private static void Main()
        {
            Debugger.Break();
            ServiceBase[] ServicesToRun;
            ServicesToRun = new ServiceBase[]
            {
                new Service1()
            };
            ServiceBase.Run(ServicesToRun);
        }
    }

Golpeará Debugger.Break();cuando ejecutes tu programa.

La mejor opción es usar el espacio de nombres ' System.Diagnostics '.

Incluya su código en el bloque if if para el modo de depuración y el modo de liberación como se muestra a continuación para cambiar entre el modo de depuración y liberación en Visual Studio,

#if DEBUG  // for debug mode
       **Debugger.Launch();**  //debugger will hit here
       foreach (var job in JobFactory.GetJobs())
            {
                //do something 
            }

#else    // for release mode
      **Debugger.Launch();**  //debugger will hit here
     // write code here to do something in Release mode.

#endif