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

     1  plugin_name: go.d.plugin
     2  modules:
     3    - meta:
     4        id: collector-go.d.plugin-energid
     5        module_name: apache
     6        plugin_name: energid
     7        monitored_instance:
     8          name: Energi Core Wallet
     9          link: ""
    10          icon_filename: energi.png
    11          categories:
    12            - data-collection.blockchain-servers
    13        keywords:
    14          - energid
    15        related_resources:
    16          integrations:
    17            list: []
    18        info_provided_to_referring_integrations:
    19          description: ""
    20        most_popular: true
    21      overview:
    22        data_collection:
    23          metrics_description: |
    24            This module monitors Energi Core Wallet instances.
    25            Works only with [Generation 2 wallets](https://docs.energi.software/en/downloads/gen2-core-wallet).
    26          method_description: ""
    27        supported_platforms:
    28          include: []
    29          exclude: []
    30        multi_instance: true
    31        additional_permissions:
    32          description: ""
    33        default_behavior:
    34          auto_detection:
    35            description: ""
    36          limits:
    37            description: ""
    38          performance_impact:
    39            description: ""
    40      setup:
    41        prerequisites:
    42          list: []
    43        configuration:
    44          file:
    45            name: go.d/energid.conf
    46          options:
    47            description: |
    48              The following options can be defined globally: update_every, autodetection_retry.
    49            folding:
    50              title: Config options
    51              enabled: true
    52            list:
    53              - name: update_every
    54                description: Data collection frequency.
    55                default_value: 1
    56                required: false
    57              - name: autodetection_retry
    58                description: Recheck interval in seconds. Zero means no recheck will be scheduled.
    59                default_value: 0
    60                required: false
    61              - name: url
    62                description: Server URL.
    63                default_value: http://127.0.0.1:9796
    64                required: true
    65              - name: timeout
    66                description: HTTP request timeout.
    67                default_value: 1
    68                required: false
    69              - name: username
    70                description: Username for basic HTTP authentication.
    71                default_value: ""
    72                required: false
    73              - name: password
    74                description: Password for basic HTTP authentication.
    75                default_value: ""
    76                required: false
    77              - name: proxy_url
    78                description: Proxy URL.
    79                default_value: ""
    80                required: false
    81              - name: proxy_username
    82                description: Username for proxy basic HTTP authentication.
    83                default_value: ""
    84                required: false
    85              - name: proxy_password
    86                description: Password for proxy basic HTTP authentication.
    87                default_value: ""
    88                required: false
    89              - name: method
    90                description: HTTP request method.
    91                default_value: GET
    92                required: false
    93              - name: body
    94                description: HTTP request body.
    95                default_value: ""
    96                required: false
    97              - name: headers
    98                description: HTTP request headers.
    99                default_value: ""
   100                required: false
   101              - name: not_follow_redirects
   102                description: Redirect handling policy. Controls whether the client follows redirects.
   103                default_value: no
   104                required: false
   105              - name: tls_skip_verify
   106                description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
   107                default_value: no
   108                required: false
   109              - name: tls_ca
   110                description: Certification authority that the client uses when verifying the server's certificates.
   111                default_value: ""
   112                required: false
   113              - name: tls_cert
   114                description: Client TLS certificate.
   115                default_value: ""
   116                required: false
   117              - name: tls_key
   118                description: Client TLS key.
   119                default_value: ""
   120                required: false
   121          examples:
   122            folding:
   123              title: Config
   124              enabled: true
   125            list:
   126              - name: Basic
   127                folding:
   128                  enabled: false
   129                description: A basic example configuration.
   130                config: |
   131                  jobs:
   132                    - name: local
   133                      url: http://127.0.0.1:9796
   134              - name: HTTP authentication
   135                description: Basic HTTP authentication.
   136                config: |
   137                  jobs:
   138                    - name: local
   139                      url: http://127.0.0.1:9796
   140                      username: username
   141                      password: password
   142              - name: HTTPS with self-signed certificate
   143                description: |
   144                  Do not validate server certificate chain and hostname.
   145                config: |
   146                  jobs:
   147                    - name: local
   148                      url: https://127.0.0.1:9796
   149                      tls_skip_verify: yes
   150              - name: Multi-instance
   151                description: |
   152                  > **Note**: When you define multiple jobs, their names must be unique.
   153                  
   154                  Collecting metrics from local and remote instances.
   155                config: |
   156                  jobs:
   157                    - name: local
   158                      url: http://127.0.0.1:9796
   159                  
   160                    - name: remote
   161                      url: http://192.0.2.1:9796
   162      troubleshooting:
   163        problems:
   164          list: []
   165      alerts: []
   166      metrics:
   167        folding:
   168          title: Metrics
   169          enabled: false
   170        description: ""
   171        availability: []
   172        scopes:
   173          - name: global
   174            description: These metrics refer to the entire monitored application.
   175            labels: []
   176            metrics:
   177              - name: energid.blockindex
   178                description: Blockchain index
   179                unit: count
   180                chart_type: area
   181                dimensions:
   182                  - name: blocks
   183                  - name: headers
   184              - name: energid.difficulty
   185                description: Blockchain difficulty
   186                unit: difficulty
   187                chart_type: line
   188                dimensions:
   189                  - name: difficulty
   190              - name: energid.mempool
   191                description: Memory pool
   192                unit: bytes
   193                chart_type: area
   194                dimensions:
   195                  - name: max
   196                  - name: usage
   197                  - name: tx_size
   198              - name: energid.secmem
   199                description: Secure memory
   200                unit: bytes
   201                chart_type: area
   202                dimensions:
   203                  - name: total
   204                  - name: used
   205                  - name: free
   206                  - name: locked
   207              - name: energid.network
   208                description: Network
   209                unit: connections
   210                chart_type: line
   211                dimensions:
   212                  - name: connections
   213              - name: energid.timeoffset
   214                description: Network time offset
   215                unit: seconds
   216                chart_type: line
   217                dimensions:
   218                  - name: timeoffset
   219              - name: energid.utxo_transactions
   220                description: Transactions
   221                unit: transactions
   222                chart_type: line
   223                dimensions:
   224                  - name: transactions
   225                  - name: output_transactions