intercepter toutes les exceptions non gérées dans l'API Web ASP.NET

Comment intercepter toutes les exceptions non gérées qui se produisent dans l'API Web ASP.NET afin de pouvoir les consigner?

Jusqu'à présent, j'ai essayé:

• Créer et enregistrer un ExceptionHandlingAttribute
• Implémenter une Application_Errorméthode dansGlobal.asax.cs
• S'abonner à AppDomain.CurrentDomain.UnhandledException
• S'abonner à TaskScheduler.UnobservedTaskException

Le ExceptionHandlingAttributegère avec succès les exceptions qui sont levées dans les méthodes d'action du contrôleur et les filtres d'action, mais les autres exceptions ne sont pas gérées, par exemple:

• Exceptions levées lorsqu'un IQueryableretourné par une méthode d'action échoue à s'exécuter
• Exceptions levées par un gestionnaire de messages (ie HttpConfiguration.MessageHandlers)
• Exceptions levées lors de la création d'une instance de contrôleur

Fondamentalement, si une exception va provoquer le renvoi d'une erreur de serveur interne 500 au client, je veux qu'elle soit enregistrée. La mise en œuvre Application_Errora bien fonctionné dans Web Forms et MVC - que puis-je utiliser dans Web Api?

Ceci est maintenant possible avec WebAPI 2.1 (voir Quoi de neuf ):

Créez une ou plusieurs implémentations de IExceptionLogger. Par exemple:

public class TraceExceptionLogger : ExceptionLogger
{
    public override void Log(ExceptionLoggerContext context)
    {
        Trace.TraceError(context.ExceptionContext.Exception.ToString());
    }
}

Ensuite, inscrivez-vous avec HttpConfiguration de votre application, dans un rappel de configuration comme ceci:

config.Services.Add(typeof(IExceptionLogger), new TraceExceptionLogger());

ou directement:

GlobalConfiguration.Configuration.Services.Add(typeof(IExceptionLogger), new TraceExceptionLogger());

La réponse de Yuval est de personnaliser les réponses aux exceptions non gérées capturées par l'API Web, pas pour la journalisation, comme indiqué sur la page liée . Reportez-vous à la section Quand utiliser sur la page pour plus de détails. L'enregistreur est toujours appelé mais le gestionnaire n'est appelé que lorsqu'une réponse peut être envoyée. En bref, utilisez le logger pour enregistrer et le gestionnaire pour personnaliser la réponse.

Au fait, j'utilise l'assembly v5.2.3 et la ExceptionHandlerclasse n'a pas la HandleCoreméthode. L'équivalent, je pense, est Handle. Cependant, le simple sous-classement ExceptionHandler(comme dans la réponse de Yuval) ne fonctionne pas. Dans mon cas, je dois mettre IExceptionHandleren œuvre comme suit.

internal class OopsExceptionHandler : IExceptionHandler
{
    private readonly IExceptionHandler _innerHandler;

    public OopsExceptionHandler (IExceptionHandler innerHandler)
    {
        if (innerHandler == null)
            throw new ArgumentNullException(nameof(innerHandler));

        _innerHandler = innerHandler;
    }

    public IExceptionHandler InnerHandler
    {
        get { return _innerHandler; }
    }

    public Task HandleAsync(ExceptionHandlerContext context, CancellationToken cancellationToken)
    {
        Handle(context);

        return Task.FromResult<object>(null);
    }

    public void Handle(ExceptionHandlerContext context)
    {
        // Create your own custom result here...
        // In dev, you might want to null out the result
        // to display the YSOD.
        // context.Result = null;
        context.Result = new InternalServerErrorResult(context.Request);
    }
}

Notez que, contrairement à l'enregistreur, vous enregistrez votre gestionnaire en remplaçant le gestionnaire par défaut et non en ajoutant.

config.Services.Replace(typeof(IExceptionHandler),
    new OopsExceptionHandler(config.Services.GetExceptionHandler()));

Pour répondre à ma propre question, ce n'est pas possible!

La gestion de toutes les exceptions qui provoquent des erreurs de serveur internes semble être une capacité de base que l'API Web devrait avoir, j'ai donc demandé à Microsoft un gestionnaire d'erreurs global pour l'API Web :

https://aspnetwebstack.codeplex.com/workitem/1001

Si vous êtes d'accord, accédez à ce lien et votez pour lui!

En attendant, l'excellent article Gestion des exceptions de l'API Web ASP.NET montre différentes façons de détecter quelques catégories d'erreur différentes. C'est plus compliqué qu'il ne devrait l'être, et cela ne détecte pas toutes les erreurs de serveur internes, mais c'est la meilleure approche disponible aujourd'hui.

Mise à jour: la gestion globale des erreurs est désormais implémentée et disponible dans les versions nocturnes! Il sera publié dans ASP.NET MVC v5.1. Voici comment cela fonctionnera: https://aspnetwebstack.codeplex.com/wikipage?title=Global%20Error%20Handling

Vous pouvez également créer un gestionnaire d'exceptions global en implémentant l' IExceptionHandlerinterface (ou en héritant de la ExceptionHandlerclasse de base). Ce sera le dernier à être appelé dans la chaîne d'exécution, après tout enregistré IExceptionLogger:

Le IExceptionHandler gère toutes les exceptions non gérées de tous les contrôleurs. C'est le dernier de la liste. Si une exception se produit, le IExceptionLogger sera appelé en premier, puis le contrôleur ExceptionFilters et, s'il n'est toujours pas géré, l'implémentation IExceptionHandler.

public class OopsExceptionHandler : ExceptionHandler
{
    public override void HandleCore(ExceptionHandlerContext context)
    {
        context.Result = new TextPlainErrorResult
        {
            Request = context.ExceptionContext.Request,
            Content = "Oops! Sorry! Something went wrong."        
        };
    }

    private class TextPlainErrorResult : IHttpActionResult
    {
        public HttpRequestMessage Request { get; set; }

        public string Content { get; set; }

        public Task<HttpResponseMessage> ExecuteAsync(CancellationToken cancellationToken)
        {
            HttpResponseMessage response = 
                             new HttpResponseMessage(HttpStatusCode.InternalServerError);
            response.Content = new StringContent(Content);
            response.RequestMessage = Request;
            return Task.FromResult(response);
        }
    }
}

Plus à ce sujet ici .

Vous pouvez avoir des blocs try-catch existants dont vous n'êtes pas au courant.

Je pensais que ma nouvelle global.asax.Application_Errorméthode n'était pas systématiquement appelée pour des exceptions non gérées dans notre ancien code.

Ensuite, j'ai trouvé quelques blocs try-catch au milieu de la pile d'appels qui ont appelé Response.Write sur le texte d'exception. C'était ça. J'ai vidé le texte sur l'écran, puis tué la pierre d'exception.

Les exceptions étaient donc gérées, mais la manipulation ne faisait rien d'utile. Une fois que j'ai supprimé ces blocs try-catch, les exceptions se sont propagées à la méthode Application_Error comme prévu.