Системный журнал EVPT#

scheduler_vm:
  logback_kafka_appender:
    enable: false # включение механизма отправки логов в Kafka через logback
    topic: evpt_topic # топик для отправки логов
    never_block: false # блокировка работы приложения при недоступности Kafka (по умолчанию - блокируется, при true недоставленные сообщения в kafka отбрасываются)
    discarding_threshold: 20 # процент свободного места в очереди отправки сообщений при достижении которого будут удаляться сообщения уровня TRACE, DEBUG, INFO
    queue_size: 512 # размер очереди для отправки в Кафку
    retries: 3 # Количество переиницилизации продьюсера, если параметр не задан, по умолчанию значение 3
    interval: 1000 # Интервал между переиницилизациями, по умолчанию 1000 мс. Задается в мс.
    multiplier: 1 # Множитель интервала переинициализации, по умолчанию значение 1.
    producer_configs: # настройка Kafka продюсера
      bootstrap.servers: kafka-host-1:9093,kafka-host-2:9093 # bootstrap подключения к Apache Kafka вида host:port,host2:port2
      security.protocol: SSL # тип протокола подключения. Значение по умолчанию: SSL
      ssl.keystore.location: /opt/scheduler/ssl/scheduler.jks # путь до хранилища сертификатов, для подключения к Kafka
      ssl.keystore.password: _PLACEHOLDER_ # пароль от keystore
      ssl.truststore.location: /opt/scheduler/ssl/scheduler.jks # путь до truststore
      ssl.truststore.password: _PLACEHOLDER_ # пароль от truststore
      ssl.endpoint.identification.algorithm: "" # обязательный параметр. Значение не изменять. Отключение проверки хостнейма в сертификате, обязательно для стендов Kafka

scheduler:
  logback:
    level: info # Общий уровень логирования (error, debug, info, warn)
  #    loggers: # Настройка дополнительных loggers. В примере ниже указан пакет и уровень логирования
  #      - name: "org.apache.kafka"
  #        level: warn
  #      - name: "com.typesafe.akka"
  #        level: debug
       kafka:
         topic: <topic_name> # Наименование топика
         retries: 3 # Количество переиницилизаций продюсера
         interval: 1000 # Интервал между переиницилизациями
         multiplier: 1 # Множитель интервала переинициализации
         properties:
           "bootstrap.servers": "hostname-1:9092,hostname-2:9092" # Bootstrap подключения к Apache Kafka вида host:port,host2:port2
           "client.id": "scheduler" # Client id для подключения
           "config.providers": decode # Объявление провайдера шифрования паролей. Значение не изменять
           "config.providers.decode.class": ru.sbt.ss.kafka.DecryptionConfigProvider # Класс провайдера шифрования паролей. Значение не изменять
           "config.providers.decode.param.security.encoding.key": ssl/secret.pass # Путь до файла, содержащего ключ шифрования паролей
           "config.providers.decode.param.security.encoding.class": ru.sbt.ss.password.BaseEncryptor # Класс шифрования паролей. Значение не изменять
           "security.protocol": SSL # Тип протокола подключения. Значение по умолчанию: SSL
          "ssl.endpoint.identification.algorithm": "" # Обязательный параметр. Значение "" не изменяемое. Отключение проверки хостнейма в сертификате, обязательно для стендов Kafka
          "ssl.keystore.location": "/path/to/*.jks" # Путь до хранилища сертификатов, для отправки логов в kafka
          "ssl.truststore.location": "/path/to/*.jks" # Путь до truststore
          "ssl.keystore.password": <password> Пароль от keystore
          "ssl.truststore.password": <password> # Пароль от truststore
          "ssl.key.password": <password> # Пароль для key.password

openapi: 3.0.1
info:
  description: "Logger runtime update"
  version: "1.0.0"
  title: "Logging swagger"
servers:
  - url: "http://localhost:8080"
    description: "Logger runtime update"
paths:
  /loggers:
    get:
      summary: "Текущее состояние логеров"
      description: |
        **Текущее состояние логеров** \
        curl http://localhost:8080/loggers
      responses:
        "200":
          description: "Success"
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    name:
                      type: string
                      example: "ru.sbt.ss"
                    level:
                      type: string
                      example: "INFO"
        "405":
          description: "Incorrect method"
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: "Incorrect method"
    put:
      summary: "Изменение уровня логирования логера с указанным именем"
      description: |
        **Изменение уровня логирования логера с указанным именем** \
        curl -X PUT http://localhost:8080/loggers -d '{"name":"ru.sbt.ss","level":"info"}'
      requestBody:
        required: true
        content:
          "application/json":
            schema:
              type: object
              required:
                - name
                - level
              properties:
                name:
                  type: string
                  example: "ru.sbt.ss"
                level:
                  type: string
                  example: "INFO"
      responses:
        "200":
          description: "Success"
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: "Change logger ru.sbt.ss to level info"
        "400":
          description: "Incorrect data"
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: "Incorrect data"
        "403":
          description: "Изменение незаданных в logback логеров"
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: "Changing level of org.apache.kafka logger is prohibited"
        "404":
          description: "Not found"
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: "Logger with name ru.sbt.ss not found"
        "405":
          description: "Incorrect method"
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: "Incorrect method"
  /loggers/{loggerName}:
    get:
      summary: "Текущий уровень логирования логера с указанным именем"
      description: |
        **Текущий уровень логирования логера с указанным именем** \
        curl -v http://localhost:8080/loggers/ru.sbt.ss
      parameters:
        - in: path
          name: loggerName
          schema:
            type: string
          required: true
          description: "Имя логгера, информация о котором требуется"
      responses:
        "200":
          description: "Success"
          content:
            application/json:
              schema:
                type: object
                properties:
                  name:
                    type: string
                    example: "ru.sbt.ss"
                  level:
                    type: string
                    example: "INFO"
        "400":
          description: "Incorrect data"
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: "Incorrect data"
        "404":
          description: "Not found"
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: "Logger with name ru.sbt.ss not found"
        "405":
          description: "Incorrect method"
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: "Incorrect method"