github.com/netdata/go.d.plugin@v0.58.1/modules/springboot2/metadata.yaml (about)

     1  plugin_name: go.d.plugin
     2  modules:
     3    - meta:
     4        id: collector-go.d.plugin-springboot2
     5        plugin_name: go.d.plugin
     6        module_name: springboot2
     7        monitored_instance:
     8          name: Java Spring-boot 2 applications
     9          link: ""
    10          icon_filename: springboot.png
    11          categories:
    12            - data-collection.apm
    13        keywords:
    14          - springboot
    15        related_resources:
    16          integrations:
    17            list:
    18              - plugin_name: apps.plugin
    19                module_name: apps
    20        info_provided_to_referring_integrations:
    21          description: ""
    22        most_popular: true
    23      overview:
    24        data_collection:
    25          metrics_description: |
    26            This collector monitors Java Spring-boot 2 applications that expose their metrics using the Spring Boot Actuator included in the Spring Boot library.
    27          method_description: ""
    28        supported_platforms:
    29          include: []
    30          exclude: []
    31        multi_instance: true
    32        additional_permissions:
    33          description: ""
    34        default_behavior:
    35          auto_detection:
    36            description: |
    37              By default, it detects applications running on localhost.
    38          limits:
    39            description: ""
    40          performance_impact:
    41            description: ""
    42      setup:
    43        prerequisites:
    44          list:
    45            - title: Configure Spring Boot Actuator
    46              description: |
    47                The Spring Boot Actuator exposes metrics over HTTP, to use it:
    48  
    49                - add `org.springframework.boot:spring-boot-starter-actuator` and `io.micrometer:micrometer-registry-prometheus` to your application dependencies.
    50                - set `management.endpoints.web.exposure.include=*` in your `application.properties`.
    51  
    52                Refer to the [Spring Boot Actuator: Production-ready features](https://docs.spring.io/spring-boot/docs/current/reference/html/production-ready.html) and [81. Actuator - Part IX. ‘How-to’ guides](https://docs.spring.io/spring-boot/docs/current/reference/html/howto-actuator.html) for more information.
    53        configuration:
    54          file:
    55            name: go.d/springboot2.conf
    56          options:
    57            description: |
    58              The following options can be defined globally: update_every, autodetection_retry.
    59            folding:
    60              title: Config options
    61              enabled: true
    62            list:
    63              - name: update_every
    64                description: Data collection frequency.
    65                default_value: 1
    66                required: false
    67              - name: autodetection_retry
    68                description: Recheck interval in seconds. Zero means no recheck will be scheduled.
    69                default_value: 0
    70                required: false
    71              - name: url
    72                description: Server URL.
    73                default_value: ""
    74                required: true
    75              - name: timeout
    76                description: HTTP request timeout.
    77                default_value: 1
    78                required: false
    79              - name: username
    80                description: Username for basic HTTP authentication.
    81                default_value: ""
    82                required: false
    83              - name: password
    84                description: Password for basic HTTP authentication.
    85                default_value: ""
    86                required: false
    87              - name: proxy_url
    88                description: Proxy URL.
    89                default_value: ""
    90                required: false
    91              - name: proxy_username
    92                description: Username for proxy basic HTTP authentication.
    93                default_value: ""
    94                required: false
    95              - name: proxy_password
    96                description: Password for proxy basic HTTP authentication.
    97                default_value: ""
    98                required: false
    99              - name: method
   100                description: HTTP request method.
   101                default_value: GET
   102                required: false
   103              - name: body
   104                description: HTTP request body.
   105                default_value: ""
   106                required: false
   107              - name: headers
   108                description: HTTP request headers.
   109                default_value: ""
   110                required: false
   111              - name: not_follow_redirects
   112                description: Redirect handling policy. Controls whether the client follows redirects.
   113                default_value: no
   114                required: false
   115              - name: tls_skip_verify
   116                description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
   117                default_value: no
   118                required: false
   119              - name: tls_ca
   120                description: Certification authority that the client uses when verifying the server's certificates.
   121                default_value: ""
   122                required: false
   123              - name: tls_cert
   124                description: Client TLS certificate.
   125                default_value: ""
   126                required: false
   127              - name: tls_key
   128                description: Client TLS key.
   129                default_value: ""
   130                required: false
   131          examples:
   132            folding:
   133              title: Config
   134              enabled: true
   135            list:
   136              - name: Basic
   137                folding:
   138                  enabled: false
   139                description: A basic example configuration.
   140                config: |
   141                  jobs:
   142                    - name: local
   143                      url: http://127.0.0.1:8080/actuator/prometheus
   144              - name: HTTP authentication
   145                description: Basic HTTP authentication.
   146                config: |
   147                  jobs:
   148                    - name: local
   149                      url: http://127.0.0.1:8080/actuator/prometheus
   150                      username: username
   151                      password: password
   152              - name: HTTPS with self-signed certificate
   153                description: |
   154                  Do not validate server certificate chain and hostname.
   155                config: |
   156                  jobs:
   157                    - name: local
   158                      url: https://127.0.0.1:8080/actuator/prometheus
   159                      tls_skip_verify: yes
   160              - name: Multi-instance
   161                description: |
   162                  > **Note**: When you define multiple jobs, their names must be unique.
   163                  
   164                  Collecting metrics from local and remote instances.
   165                config: |
   166                  jobs:
   167                    - name: local
   168                      url: http://127.0.0.1:8080/actuator/prometheus
   169                  
   170                    - name: remote
   171                      url: http://192.0.2.1:8080/actuator/prometheus
   172      troubleshooting:
   173        problems:
   174          list: []
   175      alerts: []
   176      metrics:
   177        folding:
   178          title: Metrics
   179          enabled: false
   180        description: ""
   181        availability: []
   182        scopes:
   183          - name: global
   184            description: These metrics refer to the entire monitored application.
   185            labels: []
   186            metrics:
   187              - name: springboot2.response_codes
   188                description: Response Codes
   189                unit: requests/s
   190                chart_type: stacked
   191                dimensions:
   192                  - name: 1xx
   193                  - name: 2xx
   194                  - name: 3xx
   195                  - name: 4xx
   196                  - name: 5xx
   197              - name: springboot2.thread
   198                description: Threads
   199                unit: threads
   200                chart_type: area
   201                dimensions:
   202                  - name: daemon
   203                  - name: total
   204              - name: springboot2.heap
   205                description: Overview
   206                unit: B
   207                chart_type: stacked
   208                dimensions:
   209                  - name: free
   210                  - name: eden
   211                  - name: survivor
   212                  - name: old
   213              - name: springboot2.heap_eden
   214                description: Eden Space
   215                unit: B
   216                chart_type: area
   217                dimensions:
   218                  - name: used
   219                  - name: commited
   220              - name: springboot2.heap_survivor
   221                description: Survivor Space
   222                unit: B
   223                chart_type: area
   224                dimensions:
   225                  - name: used
   226                  - name: commited
   227              - name: springboot2.heap_old
   228                description: Old Space
   229                unit: B
   230                chart_type: area
   231                dimensions:
   232                  - name: used
   233                  - name: commited
   234              - name: springboot2.uptime
   235                description: TThe uptime of the Java virtual machine
   236                unit: seconds
   237                chart_type: line
   238                dimensions:
   239                  - name: uptime