Stop send error message

  1. Stop sending error messages to Microsoft
  2. Stop sending exceptions in response with spring boot 6 min read
  3. 1) Stop using spring-boot-dev-tools in production profile
  4. 2) Stop server stack trace using simple configuration
  5. 3) You can always customize it in spring boot
  6. Все, что вы хотели знать об исключениях
  7. Базовая терминология
  8. Исключение
  9. Throw и Catch
  10. Стек вызовов
  11. Неустранимые и устранимые ошибки
  12. Игнорирование исключения
  13. Основной синтаксис команды
  14. Ключевое слово throw
  15. Параметр -ErrorAction Stop командлета Write-Error
  16. Параметр -ErrorAction Stop в командлете
  17. Try и Catch
  18. Try и Finally
  19. Try, catch и finally
  20. $PSItem
  21. PSItem.ToString()
  22. $PSItem.InvocationInfo
  23. $PSItem.ScriptStackTrace
  24. $PSItem.Exception
  25. $PSItem.Exception.Message
  26. $PSItem.Exception.InnerException
  27. $PSItem.Exception.StackTrace
  28. Работа с исключениями
  29. Перехват типизированных исключений
  30. Одновременный перехват нескольких типов
  31. Вызов типизированных исключений
  32. Параметр -Exception командлета Write-Error
  33. Большой список исключений .NET
  34. Исключения как объекты
  35. Повторный вызов исключения
  36. Повторный вызов нового исключения
  37. $PSCmdlet.ThrowTerminatingError()
  38. Try как источник неустранимой ошибки
  39. Метод $PSCmdlet.ThrowTerminatingError() в try/catch
  40. Шаблоны общих функций
  41. Ключевое слово trap
  42. Заключительное слово

Stop sending error messages to Microsoft


Archived from groups: microsoft.public.windowsxp.general (More info?)

Hi, experts!
What to do for stop sending error messages for Microsoft, when I get a box
with Send to Microsoft?
I wish to eliminate this.


Archived from groups: microsoft.public.windowsxp.general (More info?)

Right-click «My Computer» > Properties > Advanced (tab) > Error Reporting >
Disable Error Reporting


Stop sending exceptions in response with spring boot 6 min read

Rest API is one of the common and easiest ways to communicate between client/server and it has been widely used around the world. Many startup projects tend to develop Rest API quickly and share with the other team members who might be responsible for integrating it with the front end codebase. When you have to expose one of your services to the outside world, you expose it as an API and others can consume it.

At any point of time, production-ready applications need to always go through this all set of security tests, so that most of the severe and critical vulnerabilities can be fixed before we go totally live with your application. There were different set of tests and different types of tools available in the market to perform these tests.

  • SAST (Static application security testing)
  • DAST (Dynamic application security testing)
  • IAST (Interactive application security testing)

And there is always a security risk in exposing your Rest API to public or internal. Many of the tools will tend to inject our API’s with different values to fail the API and check the failed API response is exposing below information.

  • Exceptions
  • Errors
  • Server information (IIS or Apache tomcat… etc)
  • SQL Injection errors

This is why I was just to highlight how we can stop exposing our exceptions/errors information in our failed Rest API responses. Lets get started with some hands-on.

If you want to quickly setup spring boot project with maven to create your first Rest API, follow this link how to setup the spring boot project quickly

Once you have setup your basic spring boot project, you should have some basic spring boot application as below

Quickly now, lets create a controller which expose the Rest API and this API will throw an java.lang.ArrayIndexOutOfBoundsException. Since we are trying to access a invalid index.

All looks good, lets open an postman and try to hit our Rest API and you will see below response as below

As we can see, it exposes a lot of information to the end user which obviously is a security risk. What if there is an SQL error exposed here and whole exception details will be in the response and which in turn will make the attackers to understand more about the database and makes it vulnerable for SQL injection attacks very easily.

Out of the box, Spring-boot provides the above default exception format (timestamp, status, error, track, message, path) for any Rest API failures. So we should stop exposing these exceptions/errors in our Rest API response.

Spring boot makes developer life so much easier because with very little configuration we should able to stop these exceptions/error in our response.

1) Stop using spring-boot-dev-tools in production profile

First thing, we need to check whether spring-boot-dev-tools is getting used in the production profile or not. Since by default spring boot dev tools are enabled in your development environment. Spring boot dev tools enables user to live restart server on saving the file, show trace if exception occurred ..etc. So When it is time to move to code to deployment environment or production or demo environment, it is always advisable we should just disable the spring boot dev tools.

By default, if your final packaging is started using java -jar , then spring boot knows that is production profile and it will automatically disable the dev-tools for you.

But just in case, if you are packaging using war, then it is possible that you might have to inform maven to exclude the dev tools completely while packing the war. It looks like below.

READ  Spring exception handler annotation

Still exceptions are showing in the Rest API ? Check out next solution

2) Stop server stack trace using simple configuration

This way is slightly configuring or telling the spring boot how do you want to handle if there is an exception and spring boot does gives a nice configuration to achieve this from

Now, your stack trace from the response should have been gone.

As we can see now adding the config variable, now the spring boot will start attaching stack trace errors in the response of Rest API.

3) You can always customize it in spring boot

There might be come instance, where the message in above response might hold some basic error message like Null pointer exception or Index out of bounds exception etc. Or you might also want to configure something in common when an exception occurs.

Spring boot gives us that flexibility as well to remove any key from the above response and expose only what we need. And this can be done by using the power of dependency injection. There is an ErrorAttributes bean in the spring boot and through which we can control it. Let’s inject this bean and play around and remove the message attribute key from the response as well.

Updated Spring boot Application configuration after configuring the ErrorAttributes bean.

I just simply injected the bean and overriding getErrorAttributes methods which is responsible for sending back with all the information. If we try to hit our API now, it will respond back as below,

I just removed the timestamp and message attributes form the Rest API response. With this couple of ways, we should able to completely control the attributes which we have to expose in our Rest API response. Moreover, if an exception occurs we should be looking at logging it and sending some sort of error code in the failed Rest API and it varies from project to project and it depends on how we architect the exception handling mechanism for the whole application. That is a vast topic and maybe in an upcoming post, I can share it.

Hope you enjoying this post? Subscribe and stay tuned for latest updates.


Все, что вы хотели знать об исключениях

Обработка ошибок — это лишь часть процесса написания кода. Зачастую можно проверить, выполняются ли условия для ожидаемого поведения. При возникновении непредвиденной ситуации необходимо переключиться на обработку исключений. Вы можете легко обрабатывать исключения, созданные кодом других разработчиков, или создавать собственные исключения, которые смогут обработать другие.

Оригинал этой статьи впервые был опубликован в блоге автора @KevinMarquette. Группа разработчиков PowerShell благодарит Кевина за то, что он поделился с нами этими материалами. Читайте его блог —

Базовая терминология

Прежде чем двигаться дальше, необходимо разобраться с основными терминами.


Исключение подобно событию, которое создается, когда не удается справиться с проблемой путем обычной обработки ошибок. Примерами проблем, которые приводят к исключениям, могут служить попытки деления числа на ноль и нехватка памяти. Иногда автор кода, который вы используете, создает исключения для определенных проблем в случае их возникновения.

Throw и Catch

Когда происходит исключение, мы говорим, что оно вызвано. Чтобы обработать вызванное исключение, его необходимо перехватить. Если вызывается исключение, которое не перехватывается никакими объектами, выполнение скрипта прекращается.

Стек вызовов

Стек вызовов — это список функций, которые вызывали друг друга. При вызове функции она добавляется в стек или вверх списка. При выходе из функции или возврате ею значения она удаляется из стека.

При вызове исключения выполняется проверка этого стека вызовов, чтобы обработчик исключений мог его перехватить.

Неустранимые и устранимые ошибки

Исключение обычно является неустранимой ошибкой. Вызванное исключение либо перехватывается, либо завершает текущее выполнение. По умолчанию устранимая ошибка генерируется Write-Error и приводит к добавлению ошибки в выходной поток без вызова исключения.

Обращаю внимание на это потому, что Write-Error и другие устранимые ошибки не активируют catch .

Игнорирование исключения

Это ситуация, когда ошибка перехватывается только для того, чтобы ее подавить. Используйте эту возможность с осторожностью, поскольку это может существенно усложнить устранение неполадок.

Основной синтаксис команды

Ниже приведен краткий обзор основного синтаксиса обработки исключений, используемого в PowerShell.

Ключевое слово throw

Чтобы вызвать собственное событие исключения, воспользуйтесь ключевым словом throw .

Это приведет к созданию исключения во время выполнения, которое является неустранимой ошибкой. Оно обрабатывается с помощью catch в вызывающей функции или приводит к выходу из скрипта с сообщением следующего вида.

Параметр -ErrorAction Stop командлета Write-Error

Я упоминал, что по умолчанию Write-Error не вызывает неустранимую ошибку. Если указать -ErrorAction Stop , то Write-Error создает неустранимую ошибку, которую можно обработать с помощью catch .

Благодарю Ли Дейли за напоминание о том, что -ErrorAction Stop можно использовать таким образом.

Параметр -ErrorAction Stop в командлете

Если указать -ErrorAction Stop в любой расширенной функции или командлете, все инструкции Write-Error будут преобразованы в неустранимые ошибки, которые приводят к остановке выполнения или могут быть обработаны с помощью catch .

Try и Catch

Принцип обработки исключений в PowerShell (и многих других языках) состоит в том, что сначала к разделу кода применяется try , а если происходит ошибка, к нему применяется catch . Приведем краткий пример.

READ  Ps one classic mini прошивка

Скрипт catch выполняется только в том случае, если произошла неустранимая ошибка. Если try выполняется правильно, catch пропускается. Можно получить доступ к информации об исключении в блоке catch с помощью переменной $_ .

Try и Finally

Иногда ошибку обрабатывать не требуется, но необходимо выполнить определенный код в зависимости от того, было ли создано исключение. Именно это и делает скрипт finally .

Взгляните на этот пример.

Всякий раз, когда вы открываете ресурс или подключаетесь к нему, его следует закрыть. Если ExecuteNonQuery() вызывает исключение, соединение не закрывается. Вот тот же код в блоке try/finally .

В этом примере соединение закрывается при возникновении ошибки. Оно также закрывается при отсутствии ошибок. При этом всякий раз выполняется скрипт finally .

Так как исключение не перехватывается, оно по-прежнему распространяет в стек вызовов.

Try, catch и finally

Вполне допустимо использовать catch и finally вместе. В большинстве случаев используется либо один, либо другой скрипт, но вам могут встретиться сценарии, в которых используются они оба.


Теперь, когда мы разобрались с основами, можно изучить вопрос подробнее.

В блоке catch существует автоматическая переменная ( $PSItem или $_ ) типа ErrorRecord , содержащая сведения об исключении. Ниже приведен краткий обзор некоторых ключевых свойств.

В этих примерах для создания такого исключения я использовал недопустимый путь в ReadAllText .


Этот метод позволяет получить максимально понятное сообщение, которое можно использовать при ведении журнала и выводе общего результата. ToString() вызывается автоматически, если в строку помещена переменная $PSItem .


Это свойство содержит дополнительные сведения, собираемые PowerShell о функции или скрипте, которые вызвали исключение. Ниже приведено свойство InvocationInfo из примера созданного мною исключения.

Здесь приведены важные сведения: имя ScriptName , строка кода Line и номер строки ScriptLineNumber , из которой инициирован вызов.


Это свойство показывает порядок вызовов функций, ведущих к коду, в котором создано исключение.

Я выполняю вызовы функций в пределах одного скрипта, но таким же образом можно отслеживать функции при использовании нескольких скриптов.


Это, собственно, и есть вызванное исключение.


Это общее сообщение, которое описывает исключение и служит хорошей отправной точкой при устранении неполадок. Для большинства исключений предусмотрены сообщения по умолчанию, но при необходимости их можно настроить по своему усмотрению.

Это еще одно сообщение, возвращаемое при вызове $PSItem.ToString() , если для ErrorRecord не задан другой его вариант.


Исключения могут содержать внутренние исключения. Это часто случается, когда вызываемый код перехватывает одно исключение и вызывает другое. Исходное исключение помещается в новое исключение.

Я вернусь к этому вопросу позже, когда буду рассказывать о повторном вызове исключений.


Это свойство StackTrace для исключения. Я продемонстрировал принцип работы свойства ScriptStackTrace выше, но это предназначено для вызовов управляемого кода.

Эта трассировка стека выполняется только в случае, если событие вызвано из управляемого кода. Я вызываю функцию .NET Framework напрямую, так что это все, что можно увидеть в этом примере. Как правило, трассировка стека просматривается, чтобы найти место остановки кода и начало системных вызовов.

Работа с исключениями

Для работы с исключениями недостаточно базового синтаксиса и основных свойств.

Перехват типизированных исключений

Исключения можно перехватывать избирательно. Исключения имеют тип, задав который можно перехватить только исключения определенного типа.

Каждый блок catch проверяется на наличие исключения заданного типа, пока не будет найден тот, в котором оно создается. Важно понимать, что исключения могут наследоваться от других исключений. В приведенном выше примере FileNotFoundException наследуется от IOException . Поэтому, если исключение IOException было первым, будет вызвано именно оно. Даже если совпадений несколько, вызывается только один блок catch.

При наличии исключения System.IO.PathTooLongException исключение IOException распознается как совпадение, но при наличии исключения InsufficientMemoryException перехватывать его нечем, поэтому оно распространится по стеку.

Одновременный перехват нескольких типов

С помощью одной инструкции catch можно перехватывать несколько типов исключений одновременно.

Благодарю /u/Sheppard_Ra за предложение добавить этот раздел.

Вызов типизированных исключений

В PowerShell можно вызывать типизированные исключения. Вместо вызова throw со строкой:

используйте ускоритель исключений следующим образом:

Но в таком случае необходимо указать сообщение.

Можно также создать новый экземпляр исключения для вызова. При этом сообщение является необязательным, так как в системе предусмотрены сообщения по умолчанию для всех встроенных исключений.

Если вы не используете PowerShell 5.0 или более поздних версий, необходимо использовать устаревший подход с применением New-Object .

Как упоминалось в предыдущем разделе, используя типизированное исключение, вы (или другие пользователи) можете перехватывать исключения по типу.

Параметр -Exception командлета Write-Error

Эти типизированные исключения можно добавить в Write-Error и при этом перехватывать исключения с помощью catch по их типу. Используйте командлет Write-Error , как показано в следующих примерах.

Теперь исключение можно перехватить следующим образом.

Большой список исключений .NET

В дополнение к этой публикации я (при помощи Сообщество Reddit/r/PowerShell) составил основной список, который содержит сотни исключений .NET.

Для начала я ищу в этом списке исключения, которые хорошо подходят для моей ситуации. Следует попытаться использовать исключения в базовом пространстве имен System .

Исключения как объекты

При использовании большого числа типизированных исключений следует помнить, что они являются объектами. Различные исключения имеют разные конструкторы и свойства. В документации FileNotFoundException для System.IO.FileNotFoundException указано, что для этого исключения можно передать сообщение и путь к файлу.

READ  Python function call exception

У него есть свойство FileName , которое предоставляет путь к этому файлу.

Сведения о других конструкторах и свойствах объектов см. в документации по Документация по .NET.

Повторный вызов исключения

Если блок catch используется только для вызова того же исключения с помощью throw , перехватывать его с помощью catch не стоит. Перехватывать с помощью catch следует только исключение, которое планируется обработать или использовать для выполнения какого-либо действия.

Бывают случаи, когда необходимо выполнить действие с исключением, но при этом вызывать его повторно, чтобы его можно было обработать на более низком уровне. Мы можем написать сообщение или записать проблему в журнал ближе к месту обнаружения, а обработать эту проблему на другом уровне стека.

Интересно, что throw можно вызвать из catch , и тогда текущее исключение будет вызвано повторно.

Исключение создается повторно, чтобы сохранить исходные сведения о выполнении, например исходный скрипт и номер строки. Если на этом этапе вызывается новое исключение, оно скрывает первоначальное место его возникновения.

Повторный вызов нового исключения

Если вы перехватили исключение, но хотите вызвать другое, следует вложить исходное исключение в новое. Это позволяет объекту на более низком уровне стека получить к нему доступ как к $PSItem.Exception.InnerException .


Единственное, что мне не нравится в использовании throw для необработанных исключений, заключается в том, что в качестве причины ошибки в сообщении об ошибке указывается инструкция throw и номер проблемной строки.

Если сообщение об ошибке сообщает о том, что скрипт работает неправильно из-за вызова throw в строке 31, оно не подходит для отображения пользователям скрипта. Оно не сообщает им ничего полезного.

Декстер Дхами отметил, что для устранения этой проблемы я могу использовать ThrowTerminatingError() .

Если предположить, что метод ThrowTerminatingError() вызван внутри функции с именем Get-Resource , сообщение об ошибке будет таким, как показано ниже.

Вы заметили, что в качестве источника проблемы в нем указана функция Get-Resource ? Теперь пользователь узнает что-то полезное.

Так как значением $PSItem является ErrorRecord , можно таким же образом использовать ThrowTerminatingError для повторного вызова.

При этом источник ошибки изменится на командлет, а внутренние данные о функции будут скрыты от его пользователей.

Try как источник неустранимой ошибки

Кирк Манро указывает, что некоторые исключения являются неустранимыми ошибками только при выполнении внутри блока try/catch . В этом предоставленном им примере исключение во время выполнения вызывается вследствие деления на ноль.

Вызовем его теперь следующим образом, чтобы код содержал ошибку, но при этом выводилось сообщение.

Однако если поместить этот же код в try/catch , то происходит нечто иное.

Ошибка становится неустранимой, а первое сообщение не выводится. Не нравится мне в этом то, что при наличии такого кода в функции поведение становится другим, если использовать try/catch .

Сам я не сталкивался с такой проблемой, но это крайний случай, о котором следует помнить.

Метод $PSCmdlet.ThrowTerminatingError() в try/catch

Одна из особенностей $PSCmdlet.ThrowTerminatingError() заключается в том, что в командлете этот метод вызывает неустранимую ошибку, но после выхода из него ошибка становится устранимой. Из-за этого тому, кто вызывает функцию, приходится решать, как следует обрабатывать такую ошибку. В этом случае можно превратить ее снова в неустранимую ошибку с помощью -ErrorAction Stop или воспользоваться вызовом из try<. >catch <. >.

Шаблоны общих функций

В одной из последних бесед с Кирком Манро мы говорили о том, что он помещает каждый блок begin , process и end во всех своих расширенных функциях в блок try<. >catch <. >. В этих универсальных блоках catch у него есть одна строка с методом $PSCmdlet.ThrowTerminatingError($PSItem) для обработки всех исключений, вызываемых его функциями.

Поскольку в его функциях все находится в операторе try , весь код работает единообразно. Это также позволяет выводить для пользователя понятные сообщения об ошибках, в которых скрыты данные о внутреннем коде.

Ключевое слово trap

Я уделил много внимания особенностям блока try/catch . Однако прежде чем закрывать эту тему, нужно упомянуть об одной устаревшей функции.

Ключевое слово trap помещается в скрипт или функцию для перехвата всех исключений, возникающих в соответствующей области. При возникновении исключения выполняется код в ловушке trap , а затем продолжается выполнение стандартного кода. Если происходит несколько исключений, ловушка вызывается снова и снова.

Я лично никогда не применял этот подход. Однако, судя по скриптам администраторов и контроллеров, которые заносят в журнал абсолютно все исключения, а затем продолжают выполнение, могу сказать, что в нем есть своя польза.

Заключительное слово

Добавление соответствующей обработки исключений в скрипты не только делает эти скрипты более стабильными, но и упрощает устранение таких исключений.

Я уделил так много внимания throw , так как это основное понятие, которым мы оперируем при обсуждении обработки исключений. В PowerShell также предоставляется командлет Write-Error , справляющийся со всеми ситуациями, в которых следовало бы использовать throw . Так что изложенное в этой статье вовсе не означает, что вам обязательно необходимо использовать throw .

Теперь, когда я подробно рассказал об обработке исключений, я собираюсь заняться вопросом использования Write-Error -Stop для создания ошибок в коде. Я также собираюсь воспользоваться советом Кирка и перейти на использование ThrowTerminatingError в качестве обработчика исключений для каждой функции.