Spring Boot Actuator: информация о приложении (info endpoint)

Информация о приложении предоставляет различную информацию, собранную из всех компонентов InfoContributor, определенных в вашем ApplicationContext. Spring Boot включает в себя несколько автоматически настраиваемых компонентов InfoContributor, и вы можете написать свой собственный.

Автоконфигурированные InfoContributors

Следующие компоненты InfoContributor автоматически настраиваются Spring Boot, когда это необходимо:

Название Описание 
EnvironmentInfoContributor
 Предоставляет любой ключ из Environment под info ключом. 
GitInfoContributor
 Предоставляет информацию о git, если файл git.properties доступен. 
BuildInfoContributor
 Предоставляет информацию о сборке, если доступен файл META-INF/build-info.properties.

Их можно отключить, установив свойство management.info.defaults.enabled.

Настраиваемая информация о приложении

Вы можете настроить данные, предоставляемые конечной точкой info, установив info.* свойства Spring. Все свойства среды под info ключом выставляются автоматически. Например, вы можете добавить следующие параметры в ваш файл application.properties:

info.app.encoding=UTF-8
info.app.java.source=1.8
info.app.java.target=1.8

Вместо жесткого кодирования этих значений вы также можете расширить свойства info во время сборки.

Предполагая, что вы используете Maven, вы можете переписать предыдущий пример следующим образом:

info.app.encoding=@project.build.sourceEncoding@
info.app.java.source=@java.version@
info.app.java.target=@java.version@

Информация о git коммитах

Еще одна полезная функция конечной точки info - это возможность публиковать информацию о состоянии вашего git репозитория исходного кода при создании проекта. Если доступен компонент GitProperties, будут доступны свойства git.branch, git.commit.id и git.commit.time.

Компонент GitProperties автоматически настраивается, если в корневом каталоге пути к файлу доступен файл git.properties.

Если вы хотите отобразить полную информацию о git (то есть полное содержимое git.properties), используйте свойство management.info.git.mode следующим образом:

management.info.git.mode=full

Информация о сборке

Если доступен компонент BuildProperties, конечная точка info также может публиковать информацию о вашей сборке. Это происходит, если в пути к классам доступен файл META-INF/build-info.properties.

Плагины Maven и Gradle могут генерировать этот файл.

Написание пользовательских InfoContributors

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

В следующем примере добавляется пример записи с одним значением:

import java.util.Collections;

import org.springframework.boot.actuate.info.Info;
import org.springframework.boot.actuate.info.InfoContributor;
import org.springframework.stereotype.Component;

@Component
public class ExampleInfoContributor implements InfoContributor {

    @Override
    public void contribute(Info.Builder builder) {
        builder.withDetail("example",
                Collections.singletonMap("key", "value"));
    }

}

Если вы достигнете конечной точки info, вы должны увидеть ответ, который содержит следующую дополнительную запись:

{
    "example": {
        "key" : "value"
    }
}

Читайте также:


Комментарии

Отправить комментарий

Популярные сообщения из этого блога

Как получить текущий timestamp в Java

Изображение
Чтобы получить текущий timestamp в Java : package main; import java.sql.Timestamp; public class Main { public static void main(String[] args){ Timestamp timestamp = new Timestamp(System.currentTimeMillis()); System.out.println(timestamp); } } Вывод: 2019-10-03 10:09:21.61 Вот еще два более подробных примера как получить текущий timestamp в Java: 1. java.sql.Timestamp Есть два метода получить текущий java.sql.Timestamp package main; import java.sql.Timestamp; import java.text.SimpleDateFormat; import java.util.Date; public class Main { private static final SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy.MM.dd.HH.mm.ss"); public static void main(String[] args) { // Метод 1 Timestamp timestamp = new Timestamp(System.currentTimeMillis()); System.out.println(timestamp); // Метод 2 - через Date Date date = new Date(); System.out.println(new Timestamp(date.getTime()...
Далее...

Методы класса Object в Java

Изображение
Класс Object является корнем иерархии классов. У каждого класса есть Object как суперкласс. Все объекты, включая массивы, реализуют методы этого класса. Методы класса Object Метод getClass() public final Class getClass() Возвращает класс времени исполнения (runtime class) этого Object. Возвращенный объект Class - это объект, который заблокирован статическими синхронизированными методами представленного класса. Фактический тип результата - Class<? extends |X|> где |X| заменяется статическим типом выражения, для которого вызывается getClass. Например, в этом фрагменте кода не требуется приведение: Number n = 0; Class c = n.getClass(); Метод getClass() возвращает: Объект Class, представляющий класс времени исполнения (runtime class) этого объекта. Метод hashCode public int hashCode() Возвращает значение хэш-кода для объекта. Этот метод поддерживается для использования хэш-таблиц, таких как те, что предоставляются HashMap. Основной контракт метода hashCo...
Далее...

Основные опции JVM для повышения производительности и отладки

Изображение
Если вы являетесь Java-разработчиком или администратором Java приложения, вам поможет в работе знание того, что означают опции JVM, а также их важность и как они влияют на ваше приложение. Обзор параметров JVM Если говорить о параметрах JVM, то есть три типа параметров, которые вы можете включить в JVM: стандартные, нестандартные и расширенные параметры. Если вы используете расширенную опцию, вы всегда используете опцию с -XX. Точно так же, если вы применяете нестандартную опцию, вы используете -X. Стандартные опции ничего не добавляют к опции. Какие параметры JVM используются вашим приложением? Если приложение работает в Linux, вы можете использовать ps -ef | grep java для идентификации процесса Java и просмотра параметров JVM, напечатанных как аргументы процесса. Если в системе выполняется более одного Java-процесса, вам может потребоваться использовать ключевое слово, уникальное для вашего Java-приложения. Если ваш аргумент слишком длинный, попробуйте использовать ps...
Далее...