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

     1  plugin_name: go.d.plugin
     2  modules:
     3    - meta:
     4        id: collector-go.d.plugin-activemq
     5        module_name: activemq
     6        plugin_name: go.d.plugin
     7        monitored_instance:
     8          categories:
     9            - data-collection.message-brokers
    10          icon_filename: activemq.png
    11          name: ActiveMQ
    12          link: https://activemq.apache.org/
    13        alternative_monitored_instances: []
    14        keywords:
    15          - message broker
    16        most_popular: false
    17        info_provided_to_referring_integrations:
    18          description: ""
    19        related_resources:
    20          integrations:
    21            list:
    22              - plugin_name: go.d.plugin
    23                module_name: httpcheck
    24              - plugin_name: apps.plugin
    25                module_name: apps
    26      overview:
    27        data_collection:
    28          metrics_description: This collector monitors ActiveMQ queues and topics.
    29          method_description: It collects metrics by sending HTTP requests to the Web Console API.
    30        additional_permissions:
    31          description: ""
    32        default_behavior:
    33          auto_detection:
    34            description: |
    35              This collector discovers instances running on the local host that provide metrics on port 8161.
    36              On startup, it tries to collect metrics from:
    37              
    38              - http://localhost:8161
    39          limits:
    40            description: ""
    41          performance_impact:
    42            description: ""
    43        multi_instance: true
    44        supported_platforms:
    45          include: []
    46          exclude: []
    47      setup:
    48        prerequisites:
    49          list: []
    50        configuration:
    51          file:
    52            name: go.d/activemq.conf
    53          options:
    54            description: |
    55              The following options can be defined globally: update_every, autodetection_retry.
    56            folding:
    57              title: Config options
    58              enabled: true
    59            list:
    60              - name: update_every
    61                description: Data collection frequency.
    62                default_value: 1
    63                required: false
    64              - name: autodetection_retry
    65                description: Recheck interval in seconds. Zero means no recheck will be scheduled.
    66                default_value: 0
    67                required: false
    68              - name: url
    69                description: Server URL.
    70                default_value: http://localhost:8161
    71                required: true
    72              - name: webadmin
    73                description: Webadmin root path.
    74                default_value: admin
    75                required: true
    76              - name: max_queues
    77                description: Maximum number of concurrently collected queues.
    78                default_value: 50
    79                required: false
    80              - name: max_topics
    81                description: Maximum number of concurrently collected topics.
    82                default_value: 50
    83                required: false
    84              - name: queues_filter
    85                description: |
    86                  Queues filter. Syntax is [simple patterns](https://github.com/netdata/netdata/blob/master/src/libnetdata/simple_pattern/README.md#simple-patterns).
    87                default_value: ""
    88                required: false
    89              - name: topics_filter
    90                description: |
    91                  Topics filter. Syntax is [simple patterns](https://github.com/netdata/netdata/blob/master/src/libnetdata/simple_pattern/README.md#simple-patterns).
    92                default_value: ""
    93                required: false
    94              - name: username
    95                description: Username for basic HTTP authentication.
    96                default_value: ""
    97                required: false
    98              - name: password
    99                description: Password for basic HTTP authentication.
   100                default_value: ""
   101                required: false
   102              - name: proxy_username
   103                description: Username for proxy basic HTTP authentication.
   104                default_value: ""
   105                required: false
   106              - name: proxy_password
   107                description: Password for proxy basic HTTP authentication.
   108                default_value: ""
   109                required: false
   110              - name: method
   111                description: HTTP request method.
   112                default_value: GET
   113                required: false
   114              - name: timeout
   115                description: HTTP request timeout.
   116                default_value: 1
   117                required: false
   118              - name: body
   119                description: HTTP request body.
   120                default_value: ""
   121                required: false
   122              - name: headers
   123                description: HTTP request headers.
   124                default_value: ""
   125                required: false
   126              - name: not_follow_redirects
   127                description: Redirect handling policy. Controls whether the client follows redirects.
   128                default_value: false
   129                required: false
   130              - name: tls_skip_verify
   131                description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
   132                default_value: false
   133                required: false
   134              - name: tls_ca
   135                description: Certification authority that the client uses when verifying the server's certificates.
   136                default_value: ""
   137                required: false
   138              - name: tls_cert
   139                description: Client TLS certificate.
   140                default_value: ""
   141                required: false
   142              - name: tls_key
   143                description: Client TLS key.
   144                default_value: ""
   145                required: false
   146          examples:
   147            folding:
   148              title: Config
   149              enabled: true
   150            list:
   151              - name: Basic
   152                folding:
   153                  enabled: false
   154                description: A basic example configuration.
   155                config: |
   156                  jobs:
   157                    - name: local
   158                      url: http://127.0.0.1:8161
   159                      webadmin: admin
   160              - name: HTTP authentication
   161                description: Basic HTTP authentication.
   162                config: |
   163                  jobs:
   164                    - name: local
   165                      url: http://127.0.0.1:8161
   166                      webadmin: admin
   167                      username: foo
   168                      password: bar
   169              - name: Filters and limits
   170                description: Using filters and limits for queues and topics.
   171                config: |
   172                  jobs:
   173                    - name: local
   174                      url: http://127.0.0.1:8161
   175                      webadmin: admin
   176                      max_queues: 100
   177                      max_topics: 100
   178                      queues_filter: '!sandr* *'
   179                      topics_filter: '!sandr* *'
   180              - name: Multi-instance
   181                description: |
   182                  > **Note**: When you define multiple jobs, their names must be unique.
   183                  
   184                  Collecting metrics from local and remote instances.
   185                config: |
   186                  jobs:
   187                    - name: local
   188                      url: http://127.0.0.1:8161
   189                      webadmin: admin
   190                  
   191                    - name: remote
   192                      url: http://192.0.2.1:8161
   193                      webadmin: admin
   194      troubleshooting:
   195        problems:
   196          list: []
   197      alerts: []
   198      metrics:
   199        folding:
   200          title: Metrics
   201          enabled: false
   202        description: ""
   203        availability: []
   204        scopes:
   205          - name: global
   206            description: These metrics refer to the entire monitored application.
   207            labels: []
   208            metrics:
   209              - name: activemq.messages
   210                availability: []
   211                description: Messaged
   212                unit: messages/s
   213                chart_type: line
   214                dimensions:
   215                  - name: enqueued
   216                  - name: dequeued
   217              - name: activemq.unprocessed_messages
   218                availability: []
   219                description: Unprocessed Messages
   220                unit: messages
   221                chart_type: line
   222                dimensions:
   223                  - name: unprocessed
   224              - name: activemq.consumers
   225                availability: []
   226                description: Consumers
   227                unit: consumers
   228                chart_type: line
   229                dimensions:
   230                  - name: consumers