Учебник по 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.
Затем вам нужно определить получателей и отправителей.
Источник
Введение в Spring Boot Actuator
Салют, хабровчане! Уже через неделю стартуют занятия в новой группе курса «Разработчик на Spring Framework». В связи с этим делимся с вами полезным материалом в котором рассказано о том, что такое Spring Actuator и чем он может быть полезен.
- Что такое Spring Actuator?
- Как добавить Spring Actuator в проект Maven или Gradle?
- Создание проекта Spring Boot с зависимостью Spring Actuator.
- Мониторинг приложений с Spring Actuator Endpoints.
Что такое 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.
Импортируйте проект в Eclipse или любую другую IDE и запустите SpringActuatorApplication.java .
В консоли вы увидите следующее:
Видно, что встроенный Tomcat запущен на порту 8080, а SpringActuatorApplication запущен в Tomcat. Также вы можете увидеть, что конечные точки actuator’а доступны по адресу /actuator.
Мониторинг приложений с Spring Actuator Endpoints
Как мы уже говорили выше, Spring Actuator предоставляет несколько готовых конечных точек (endpoints), которые мы можем использовать для мониторинга работоспособности приложения.
| ID | Описание |
|---|---|
| auditevents | Предоставляет информацию о событиях аудита для текущего приложения. |
| beans | Отображает полный список всех Spring-бинов в приложении. |
| caches | Информация о кэше. |
| conditions | Показывает условия (Condition), которые были вычислены для классов конфигурации и автоконфигурации, и причины, по которым они соответствовали или не соответствовали. |
| configprops | Отображает список всех @ConfigurationProperties |
| env | Отображает свойства из ConfigurableEnvironment. |
| flyway | Показывает миграции баз данных Flyway, которые были применены. |
| health | Показывает сведения о работоспособности приложения. |
| httptrace | Отображает информацию трассировки HTTP (по умолчанию последние 100 HTTP запросов-ответов). |
| info | Отображает дополнительную информацию о приложении. |
| integrationgraph | Граф Spring Integration. |
| loggers | Отображает и позволяет изменить конфигурацию логгеров в приложении. |
| liquibase | Показывает примененные миграции базы данных Liquibase. |
| metrics | Показывает информацию о метриках для текущего приложения. |
| mappings | Отображает список всех путей @RequestMapping. |
| scheduledtasks | Отображает запланированные задачи (scheduled tasks). |
| sessions | Позволяет извлекать и удалять пользовательские сессии из хранилищ, поддерживаемых Spring Session. Недоступно при использовании Spring Session для реактивных веб-приложений. |
| shutdown | Позволяет приложению корректно завершить работу. |
| threaddump | Отображает информацию о потоках. |
Включение конечных точек
По умолчанию включены все конечные точки, кроме shutdown . Чтобы включить конечную точку, используйте следующее свойство в файле application.properties .
Примечание переводчика: по умолчанию доступ ко всем конечным точкам есть только через JMX, доступа через HTTP ко всем конечным точкам нет (см. ниже).
Чтобы включить конечную точку shutdown , нам нужно сделать следующую запись в файле application.properties :
Мы можем отключить все конечные точки, а затем включать только те, которые нам нужны. При следующей конфигурации все конечные точки, кроме info , будут отключены.
Доступ к конечным точкам через HTTP
Давайте перейдем по URL-адресу localhost:8080/actuator и посмотрим на доступные конечные точки.
Примечание: я использую Postman для тестирования, поскольку он показывает JSON в хорошо структурированном формате. Вы можете использовать любой другой инструмент или просто браузер.
Как вы уже заметили, здесь показаны только конечные точки health и info . Потому что это единственные конечные точки, которые по умолчанию доступны через http. Доступ через http к другим конечным точкам закрыт по умолчанию из соображений безопасности, поскольку они могут содержать конфиденциальную информацию и, следовательно, могут быть скомпрометированы.
Доступ к конкретным конечным точкам
Если мы хотим предоставить доступ через web (http) к другим конечным точкам то, нам нужно сделать следующие записи в файле application.properties .
Теперь, после добавления в application.properties указанной выше записи, давайте снова перейдем по http://localhost:8080/actuator
Как мы видим на скриншоте ниже, конечная точка env также включена.
Доступ ко всем конечным точкам
Если мы хотим включить все конечные точки, мы можем использовать знак * , как показано ниже.
Доступ ко всем конечным точкам, кроме некоторых
Две записи ниже активируют все конечные точки, но отключают конечную точку env.
Отключение всех конечных точек HTTP
Если вы не хотите предоставлять конечные точки через HTTP, это можно сделать, настроив в файле application.properties следующее:
Настройка URL для доступа к конечным точкам
По умолчанию все конечные точки доступны по URL /actuator по адресам вида /actuator/
Например, если вы хотите сделать базовый URL-адрес как /monitor вместо /actuator это можно сделать следующим образом:
При этом все конечные точки будут доступны как /monitor/
Конечные точки Spring Boot Actuator
Давайте обсудим некоторые из наиболее важных конечных точек.
Конечная точка health даёт общий статус приложения: запущено и работает или нет. Это очень важно для мониторинга состояния приложения, когда оно находится в продакшене. Эта конечная точка может быть интегрирована с приложениями мониторинга и будет очень полезна для определения работоспособности приложений в реальном времени.
Объем информации, предоставляемой конечной точкой health , зависит от свойства management.endpoint.health.show-details в файле application.properties .
Если management.endpoint.health.show-details=never , то никакая дополнительная информация не отображается. В этом случае вы увидите только следующее (это поведение по умолчанию).
Если management.endpoint.health.show-details=always , то дополнительная информация показывается всем пользователям. Как мы видим в ответе ниже, у нас появилась информация о дисковом пространстве (diskSpace). Если ваше приложение подключено к базе данных, то у вас также будет отображаться информация о состоянии базы данных.
Если management.endpoint.health.show-details=when-authorized , то дополнительная информация будет показана только авторизованным пользователям. Авторизацию можно настроить с помощью свойства management.endpoint.health.roles .
Spring Boot Actuator имеет множество автоматически настроенных “индикаторов здоровья” (HeathIndicators)для проверки работоспособности различных частей приложения. Например, DiskspaceHealthIndicator предоставляет информацию о дисковом пространстве. Если вы используете MongoDB, то MongoHealthIndicator проверит работоспособность БД Mongo (запущен сервер или нет) и отобразит соответствующую информацию. По умолчанию окончательный статус приложения определяет HealthAggregator , который просто сортирует список статусов, предоставленных каждым HealthIndicator . Первый статус в отсортированном списке используется как окончательный статус приложения.
Отключение всех преднастроенных индикаторов
Описанные выше “индикаторы здоровья” включены по умолчанию, однако, их можно отключить с помощью следующего свойства:
Отключение отдельного индикатора
В качестве альтернативы можно отключить отдельный HealthIndicator , как показано ниже, например, для отключения проверки дискового пространства:
Примечание: идентификатором любого HealthIndicator будет имя бина без суффикса HealthIndicator .
Написание своих индикаторов (HealthIndicator)
Наряду со встроенными HealthIndicator , предоставляемыми Spring Boot Actuator, мы можем создавать собственные индикаторы состояния. Для этого вам нужно создать класс, который реализует интерфейс HealthIndicator , реализовать его метод health() и вернуть Health в качестве ответа с соответствующей информацией, как показано ниже:
Давайте снова перейдем на конечную точку health и посмотрим, отражается ли наш индикатор или нет.
Мы видим наш индикатор.
Статус отдельного компонента
Можно также проверить состояние отдельного компонента. В приведенном выше примере мы видели написанный нами индикатор и diskSpace.
Если мы хотим видеть только состояние диска, мы можем использовать следующее URL:
Конечная точка info предоставляет общую информацию о приложении, которую она получает из файлов, таких как build-info.properties или git.properties , или из свойств, указанных в application.properties .
Так как в нашем проекте такого файла нет, то ответ будет пустой, как показано ниже:
Spring Boot Actuator отображает информацию о сборке, если присутствует файл META-INF/build-info.properties . Этот файл с информацией о проекте создается время сборки целью build-info . Здесь также можно добавить произвольное количество дополнительных свойств.
Давайте добавим в pom.xm l цель build-info для плагина spring-boot-maven-plugin .
Теперь давайте снова посмотрим на конечную точку info и увидим информацию о сборке, как показано ниже:
Кроме того, мы можем добавить информацию о приложении с ключом info в application.properties , как показано ниже, и она будет отображаться в конечной точке /info .
Конечная точка beans показывает все бины, определенные в Spring-контейнере со следующей информацией о каждом бине:
Например, я создал RestController с именем TestController и заинжектил компонент с именем TestService
Вы можете увидеть, как это показывается для testController, на скриншоте ниже.
/configprops
Конечная точка configProps показывает все бины, аннотированные @ConfigurationProperties .
На приведенном выше скриншоте мы видим два бина, которые определены в самом Spring Framework и снабжены аннотацией @ConfigurationProperties и, следовательно, отображаются в этой конечной точке.
На скриншоте ниже показан исходный код HttpTraceProperties , аннотированный @ConfigurationProperties .
Конечная точка env предоставляет всю информацию, относящуюся к окружению, в следующем порядке:
| Свойства системы | зависит от JVM (не зависит от платформы) |
|---|---|
| Системное окружение или переменные окружения | зависит от операционной системы (зависит от платформы) |
| Настройки уровня приложения | определены в application.properties |
Конечная точка heapdump делает дамп кучи приложения. Эта конечная точка возвращает двоичные данные в формате HPROF. Поскольку обычно возвращается много данных, вы должны их сохранить и проанализировать.
Конечная точка loggers предоставляет логгеры приложения с информацией об их настроенном уровне логирования (configuredLevel) и эффективном уровне (effectiveLevel). Если для логера и его родителя настроенный уровень не указан (null), то эффективным уровнем будет уровень корневого логера.
Свойство level указывает, какие уровни логирования поддерживаются фреймворком логирования.
Чтобы получить информацию для конкретного логера, передайте имя (ид) логера в URL-адресе после конечной точки /loggers , как показано ниже:
Конечная точка metrics показывает все метрики, которые вы можете отслеживать для вашего приложения.
Проверка индивидуальной метрики
Вы можете смотреть отдельную метрику, передав её в URL-адресе после /metrics , как показано ниже:
По устоявшейся традиции ждем ваши комментарии и приглашаем всех на день открытых дверей, который пройдет 23 мая.
Источник