spring boot actuator что это

Учебник по Spring Boot Admin

Контролируйте и управляйте своими приложениями Spring Boot с помощью приятного пользовательского интерфейса поверх конечных точек Spring Boot Actuator.

Spring Boot Actuator

Actuator: Spring Boot Production Monitoring and Management
Мониторинг и управление вашим работающим приложением с помощью Spring Boot Actuator 2.x. Соберите метрики или проверьте здоровье приложения.

Примечание переводчика. На Хабре есть аналогичная статья:
Введение в Spring Boot Actuator

Spring Boot Admin

Actuator является отличным и мощным инструментом, кроме того, его конечные точки легко и удобно использовать с помощью другого приложения — вы просто используете вызов REST-сервиса. Однако человеку использовать Actuator не очень удобно. Для пользователя гораздо проще иметь хороший пользовательский интерфейс, который можно использовать для просмотра всех данных мониторинга и управления вашим приложением. Это именно то, для чего служит Spring Boot Admin. Он предоставляет вам удобную прослойку пользовательского интерфейса поверх конечных точек Actuator с несколькими дополнительными функциями сверх того.

Spring Boot Admin не является модулем, предоставленным командой Spring, он был создан компанией под названием Codecentric. Тем не менее, его код общедоступен на Github и является бесплатным.

Клиент и сервер

В отличие от Actuator, Spring Boot Admin фактически состоит из двух частей — клиентской и серверной.

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

Таким образом, даже если наше приложение не работает или не работает должным образом, сервер мониторинга все еще работает. Теперь представьте, что у вас есть несколько приложений (таких как микросервисы Spring Boot), и каждое из них может работать в нескольких экземплярах. С традиционным мониторингом Actuator это сложно, так как вам нужно получить доступ к каждому из них по отдельности, и вам нужно отслеживать, сколько экземпляров и где запущено.

При использовании Spring Boot Admin каждый экземпляр отслеживаемого приложения (клиента) регистрируется на сервере после его запуска. Тогда у вас есть единственная точка (Admin Server), где вы можете проверить их все.

Исходный код

Исходный код готового приложения можно найти в этом репозитории Github.

Настройка сервера

Давайте сначала рассмотрим, как настроить Spring Boot Admin Server. Начнем со нового Spring Boot приложения. Вы можете легко создать его, используя Spring Initializr. Обязательно включите web модуль.

После создания проекта, первое, что нам нужно, это добавить зависимость Spring Boot Admin Server:

Обратите внимание, что хотя этот проект не создан Pivotal, вы можете найти клиентский и серверный модули для Spring Boot Admin в Spring Initializr. Далее нам нужно включить Admin Server, аннотируя наш основной класс приложения с помощью аннотации @EnableAdminServer:

Вот и все. Теперь вы можете запустить свое приложение и после открытия страницы вы должны увидеть такой экран:

Сервер работает, но клиенты еще не зарегистрированы. Давайте исправим это.

Настройка клиента

Как и при настройке сервера, первый шаг — необходимо добавить правильную зависимость к существующему приложению:

Затем вам нужно определить URL, где работает ваш Admin Server. Добавьте эту строку в ваш файл application.properties:

Добавление Actuator

Теперь у вас должна быть возможность запустить и клиент, и сервер. Просто убедитесь, что нет конфликта портов, поскольку оба приложения по умолчанию используют 8080. В целях тестирования вы можете установить server.port = 0 в ваших application.properties, чтобы ваш клиент использовал случайный порт при запуске. Таким образом, вы можете протестировать запуск нескольких экземпляров, работающих на разных портах.

При открытии пользовательского интерфейса Admin Server вы должны увидеть свое приложение. Когда вы нажимаете на название приложения, должна появиться страница с информацией о приложении.

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

Однако большинство конечных точек по умолчанию не отображаются в Actuator. Вам нужно изменить свою конфигурацию в application.properties, чтобы выставить их:

После предоставления конечных точек Actuator вы должны увидеть гораздо больше информации в интерфейсе администратора:

Подробное руководство по настройке Spring Boot Actuator можно найти в этой статье.
Примечание переводчика. И в статье на Хабре.

Безопасность

Теперь, когда все работает, мы должны убедиться, что наши конечные точки Actuator и интерфейс администратора не доступны для всех.

Безопасность клиентов

Если вы уже используете Spring Security, вышеперечисленное не будет работать для вас, так как конечные точки привода по умолчанию защищены и ваш сервер администратора не сможет получить к ним доступ. Если вы еще не используете Spring Security, сначала нужно добавить зависимость:

В целях тестирования вы можете временно отключить безопасность конечных точек Actuator с помощью management.security.enabled = false. Однако мы хотим, чтобы безопасность была включена. Если вы используете обычную аутентификацию, вы можете просто указать имя пользователя и пароль в файле свойств. Эти учетные данные будут использоваться Admin Server для аутентификации на конечных точках привода клиента:

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

Безопасность сервера

Как и в случае с клиентом, нам нужно добавить зависимость Spring Security:

Теперь давайте настроим имя пользователя и пароль, необходимые для входа на Admin Server в вашем application.properties:

Сейчас на вашем клиенте вам также необходимо добавить эти учетные данные, иначе он не сможет зарегистрироваться на сервере:

Теперь вернемся к серверной части. Последнее, что нам нужно, это добавить конфигурацию Spring Security для защиты пользовательского интерфейса администратора:

Это позволит обеспечить доступ к интерфейсу администратора только для аутентифицированных пользователей, использующих базовую аутентификацию HTTP для входа в систему. Сама страница входа и статические ресурсы пользовательского интерфейса, включая javascript, HTML и CSS, являются открытыми. В противном случае вы не сможете войти в систему. Тогда существует защита от подделки межсайтовых запросов (CSRF, Cross-Site Request Forgery) на основе файлов cookie. Вы можете видеть, что некоторые пути игнорируются в защите CSRF — это потому, что Admin Server в настоящее время не имеет надлежащей поддержки.

Теперь после перезагрузки вы должны увидеть красивый экран входа, защищающий ваш Admin Server:

Cloud Discovery

Клиент Spring Boot Admin — не единственный способ зарегистрировать ваши приложения на сервере. Admin Server также поддерживает Spring Cloud Service Discovery. Вы можете прочитать больше в официальной документации или в статье «Spring Cloud Discovery with Spring Boot Admin».

Уведомления

Как только у вас запущен мониторинг, вы хотите получать уведомления, когда что-то идет не так. Хорошая новость заключается в том, что Spring Admin предоставляет широкий спектр вариантов уведомлений.

Если вы посещаете страницу Admin Server в первый раз, она запрашивает разрешение на отображение push-уведомлений на вашем компьютере. Всякий раз, когда возникает проблема, вы получите всплывающее сообщение.

Другие уведомления нуждаются в простой настройке. Обычно это означает просто предоставить несколько записей в вашем application.properties. В настоящее время поддерживаются следующие сервисы:

Настройка почтовых уведомлений

Если вы хотите включить почтовые уведомления, вам нужно добавить Spring email зависимость в вашу серверную часть:

Затем вам нужно определить ваш SMTP-сервер, который будет использоваться для отправки уведомлений и учетных данных по электронной почте. Обновите свои application.properties вашего Admin Server.

Затем вам нужно определить получателей и отправителей.

Источник

Администрирование и мониторинг приложений с помощью Azure Spring Boot Actuator

Эта статья применима к: ✔️ Java

После развертывания нового двоичного кода в приложении вы можете проверить его функциональность и просмотреть сведения о работающем приложении. В этой статье объясняется, как получить доступ к API из тестовой конечной точки, предоставленной Azure Spring Cloud, и как предоставить готовые функции для вашего приложения.

Предварительные требования

Проверка приложения с помощью тестовой конечной точки

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

На странице Обзор должен отображаться параметр Тестовая конечная точка. Выполните доступ к этой конечной точке из командной строки или браузера и наблюдайте за ответом API.

Обратите внимание на универсальный код ресурса (URI) тестовой конечной точки, который будет использоваться в следующем разделе.

Добавление зависимости для исполнителя

Чтобы добавить исполнителя в проект Maven, добавьте зависимость «Starter»:

Скомпилируйте новый двоичный код и разверните его в приложении.

Включение готовых компонентов

Конечные точки исполнителя позволяют отслеживать приложение и взаимодействовать с ним. По умолчанию приложение Spring Boot предоставляет конечные точки health и info для отображения произвольных данных приложения и сведений о работоспособности.

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

Добавьте указанные ниже свойства в формате «ключ:значение». В этом окружении откроется конечная точка Spring Actuator «env», «health», «info».

Нажмите кнопку Сохранить. Приложение автоматически перезапустится и загрузит новые переменные среды.

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

После публикации приложения, конечные точки исполнителя также будут находится в общем доступе. Все конечные точки можно скрыть, удалив переменные среды management.endpoints.web.exposure.include и задав management.endpoints.web.exposure.exclude=*

Просмотр конечной точки исполнителя для просмотра сведений о приложении

Информацию о том, как просмотреть все встроенные конечные точки, см. в разделе Предоставление конечных точек.

Источник

Создание RESTful web-сервиса с Spring Boot Actuator

Spring Boot Actuator является подпроектом Spring Boot. Он добавляет несколько сервисов бизнес-уровня без особых усилий с вашей стороны. В этом уроке вы создадите приложение и увидите, как добавить эти сервисы.

Что вы создадите

В этом уроке освещаются шаги создания «hello world» RESTful Web Service c использованием Spring Boot Actuator. Вы создадите сервис, который принимает HTTP GET запрос:

А в ответ возвращает JSON:

Также есть некоторые возможности для вашего приложения «из коробки» управлять сервисом в рабочем (или других) окружениях. Бизнес логика сервиса построена так же, как в Создание RESTful Web-сервиса. Вам необязательно использовать это руководство для изучения, однако это может быть интересным, чтобы впоследствии сравнить результаты.

Что вам потребуется

Как проходить этот урок

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

Чтобы начать с нуля, перейдите в Настройка проекта.

Настройка проекта

Для начала вам необходимо настроить базовый скрипт сборки. Вы можете использовать любую систему сборки, которая вам нравится для сборки проетов Spring, но в этом уроке рассмотрим код для работы с Gradle и Maven. Если вы не знакомы ни с одним из них, ознакомьтесь с соответсвующими уроками Сборка Java-проекта с использованием Gradle или Сборка Java-проекта с использованием Maven.

Создание структуры каталогов

Создание файла сборки Gradle

Ниже представлен начальный файл сборки Gradle. Файл pom.xml находится здесь. Если вы используете Spring Tool Suite (STS), то можете импортировать урок прямо из него.

Spring Boot gradle plugin предоставляет множество удобных возможностей:

Запуск пустого сервиса

Ниже представлено пустое Spring MVC приложение.

Аннотация @EnableAutoConfiguration обеспечивает загрузку по умолчанию (подобно встроенному сервлет контейнеру) в зависимости от содержания вашего classpath и других вещей. Она также ключает Spring MVC @EnableWebMvc аннотацию для активации web компонентов.

Не все компоненты определены в этом приложении, но этого достаточно для запуска и просмотра некоторых возможностей Actuator’а. Команда SpringApplication.run() знает как запустить web приложение. Все, что вам нужно, это запустить команду:

Вы ещё не писали код, так что же случится? Подождите, пока сервер запустится, перейдите в терминал и попробуйте выполнить:

Вы получили «ОК», значит все хорошо.

Более подробную информацию смотрите на Spring Boot Actuator Project.

Создание класса представления

Для начала, давайте подумаем, как будет выглядеть ваше API.

Для моделирования представления сообщения, создайте класс представления:

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

Создание контроллера ресурсов

Ключевое отличие между обычным(human-facing) контроллером и REST контроллером в том, как создан ответ. Вместо того, чтобы опираться на представление(такое как JSP) для отображения данных модели в HTML, REST контроллер просто возвращает данные, записанные прямо в тело ответа.

Аннотация @ResponseBody говорит Spring MVC не отображать модель в представлении, а писать возвращаемый объект в тело ответа. Делается это с помощью одного из ковертеров сообщений Spring. Т.к. Jackson 2 находится в classpath, то значит MappingJackson2HttpMessageConverter будет обрабатывать конвертацию Greeting в JSON при условии, что заголовок Accept запроса указывает, что необходимо вернуть JSON.

Создание выполняемым главный класс

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

Сборка исполняемого JAR

Вы можете собрать единый исполняемый JAR-файл, который содержит все необходимые зависимости, классы и ресурсы. Это делает его легким в загрузке, версионировании и развертывании сервиса как приложения на протяжении всего периода разработки, на различных средах и так далее.

Затем вы можете запустить JAR-файл:

Запуск сервиса

Если вы используете Gradle, вы можете запустить ваш сервис из командной строки:

Как вариант, вы можете запустить ваш сервис напрямую из Gradle примерно так:

Переключение на другой порт сервера

Запустите сервер снова:

Поздравляем! Вы только что разработали простой RESTful сервис, используя Spring. Вы добавили некоторые полезные встроенные сервисы благодаря Spring Boot Actuator.

Источник

Введение в Spring Boot Actuator

Салют, хабровчане! Уже через неделю стартуют занятия в новой группе курса «Разработчик на Spring Framework». В связи с этим делимся с вами полезным материалом в котором рассказано о том, что такое Spring Actuator и чем он может быть полезен.

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

Традиционно, до Spring Actuator, нам нужно было писать код для проверки работоспособности приложения, но с Spring Actuator нам не нужно писать код. Spring Actuator предоставляет несколько готовых конечных точек (endpoint), которые могут быть полезны для мониторинга приложения.

Как добавить Spring Actuator в проект Maven или Gradle?

Создание проекта Spring Boot с Spring Actuator

Давайте продолжим и создадим с помощью Spring Initializer проект Spring Boot с зависимостями Spring Actuator, Web и DevTools.

Обратите внимание, что на момент написания этой статьи версия Spring Boot была 2.1.0.

В консоли вы увидите следующее:

Видно, что встроенный Tomcat запущен на порту 8080, а SpringActuatorApplication запущен в Tomcat. Также вы можете увидеть, что конечные точки actuator’а доступны по адресу /actuator.

Мониторинг приложений с Spring Actuator Endpoints

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

Включение конечных точек

Примечание переводчика: по умолчанию доступ ко всем конечным точкам есть только через JMX, доступа через HTTP ко всем конечным точкам нет (см. ниже).

Доступ к конечным точкам через HTTP

Давайте перейдем по URL-адресу localhost:8080/actuator и посмотрим на доступные конечные точки.

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

Доступ к конкретным конечным точкам

Теперь, после добавления в application.properties указанной выше записи, давайте снова перейдем по http://localhost:8080/actuator

Как мы видим на скриншоте ниже, конечная точка env также включена.

Доступ ко всем конечным точкам

Доступ ко всем конечным точкам, кроме некоторых

Две записи ниже активируют все конечные точки, но отключают конечную точку env.

Отключение всех конечных точек HTTP

Если вы не хотите предоставлять конечные точки через HTTP, это можно сделать, настроив в файле application.properties следующее:

Настройка URL для доступа к конечным точкам

Например, если вы хотите сделать базовый URL-адрес как /monitor вместо /actuator это можно сделать следующим образом:

При этом все конечные точки будут доступны как /monitor/ вместо /actuator/

Конечные точки Spring Boot Actuator

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

Конечная точка health даёт общий статус приложения: запущено и работает или нет. Это очень важно для мониторинга состояния приложения, когда оно находится в продакшене. Эта конечная точка может быть интегрирована с приложениями мониторинга и будет очень полезна для определения работоспособности приложений в реальном времени.

Отключение всех преднастроенных индикаторов

Описанные выше “индикаторы здоровья” включены по умолчанию, однако, их можно отключить с помощью следующего свойства:

Отключение отдельного индикатора

Написание своих индикаторов (HealthIndicator)

Давайте снова перейдем на конечную точку health и посмотрим, отражается ли наш индикатор или нет.

Мы видим наш индикатор.

Статус отдельного компонента

Можно также проверить состояние отдельного компонента. В приведенном выше примере мы видели написанный нами индикатор и diskSpace.

Если мы хотим видеть только состояние диска, мы можем использовать следующее URL:

Так как в нашем проекте такого файла нет, то ответ будет пустой, как показано ниже:

Теперь давайте снова посмотрим на конечную точку info и увидим информацию о сборке, как показано ниже:

Конечная точка beans показывает все бины, определенные в Spring-контейнере со следующей информацией о каждом бине:

Например, я создал RestController с именем TestController и заинжектил компонент с именем TestService

Вы можете увидеть, как это показывается для testController, на скриншоте ниже.

На приведенном выше скриншоте мы видим два бина, которые определены в самом Spring Framework и снабжены аннотацией @ConfigurationProperties и, следовательно, отображаются в этой конечной точке.

Конечная точка env предоставляет всю информацию, относящуюся к окружению, в следующем порядке:

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

Конечная точка loggers предоставляет логгеры приложения с информацией об их настроенном уровне логирования (configuredLevel) и эффективном уровне (effectiveLevel). Если для логера и его родителя настроенный уровень не указан (null), то эффективным уровнем будет уровень корневого логера.

Свойство level указывает, какие уровни логирования поддерживаются фреймворком логирования.

Конечная точка metrics показывает все метрики, которые вы можете отслеживать для вашего приложения.

Проверка индивидуальной метрики

По устоявшейся традиции ждем ваши комментарии и приглашаем всех на день открытых дверей, который пройдет 23 мая.

Источник