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

     1  plugin_name: go.d.plugin
     2  modules:
     3    - meta:
     4        id: collector-go.d.plugin-pika
     5        plugin_name: go.d.plugin
     6        module_name: pika
     7        monitored_instance:
     8          name: Pika
     9          link: https://github.com/OpenAtomFoundation/pika
    10          icon_filename: pika.svg
    11          categories:
    12            - data-collection.database-servers
    13        keywords:
    14          - pika
    15          - databases
    16        related_resources:
    17          integrations:
    18            list: []
    19        info_provided_to_referring_integrations:
    20          description: ""
    21        most_popular: false
    22      overview:
    23        data_collection:
    24          metrics_description: |
    25            This collector monitors Pika servers.
    26            
    27            It collects information and statistics about the server executing the following commands:
    28            
    29            - [`INFO ALL`](https://github.com/OpenAtomFoundation/pika/wiki/pika-info%E4%BF%A1%E6%81%AF%E8%AF%B4%E6%98%8E)
    30          method_description: ""
    31        supported_platforms:
    32          include: []
    33          exclude: []
    34        multi_instance: true
    35        additional_permissions:
    36          description: ""
    37        default_behavior:
    38          auto_detection:
    39            description: ""
    40          limits:
    41            description: ""
    42          performance_impact:
    43            description: ""
    44      setup:
    45        prerequisites:
    46          list: []
    47        configuration:
    48          file:
    49            name: go.d/pika.conf
    50          options:
    51            description: |
    52              The following options can be defined globally: update_every, autodetection_retry.
    53            folding:
    54              title: Config options
    55              enabled: true
    56            list:
    57              - name: update_every
    58                description: Data collection frequency.
    59                default_value: 5
    60                required: false
    61              - name: autodetection_retry
    62                description: Recheck interval in seconds. Zero means no recheck will be scheduled.
    63                default_value: 0
    64                required: false
    65              - name: address
    66                description: Pika server address.
    67                default_value: redis://@localhost:9221
    68                required: true
    69                details: |
    70                  There are two connection types: by tcp socket and by unix socket.
    71                  
    72                  - Tcp connection: `redis://<user>:<password>@<host>:<port>/<db_number>`
    73                  - Unix connection: `unix://<user>:<password>@</path/to/redis.sock>?db=<db_number>`
    74              - name: timeout
    75                description: Dial (establishing new connections), read (socket reads) and write (socket writes) timeout in seconds.
    76                default_value: 1
    77                required: false
    78              - name: username
    79                description: Username used for authentication.
    80                default_value: ""
    81                required: false
    82              - name: password
    83                description: Password used for authentication.
    84                default_value: ""
    85                required: false
    86              - name: tls_skip_verify
    87                description: Server certificate chain and hostname validation policy. Controls whether the client performs this check.
    88                default_value: false
    89                required: false
    90              - name: tls_ca
    91                description: Certificate authority that client use when verifying server certificates.
    92                default_value: ""
    93                required: false
    94              - name: tls_cert
    95                description: Client tls certificate.
    96                default_value: ""
    97                required: false
    98              - name: tls_key
    99                description: Client tls key.
   100                default_value: ""
   101                required: false
   102          examples:
   103            folding:
   104              title: Config
   105              enabled: true
   106            list:
   107              - name: TCP socket
   108                description: An example configuration.
   109                config: |
   110                  jobs:
   111                    - name: local
   112                      address: 'redis://@localhost:9221'
   113              - name: TCP socket with password
   114                description: An example configuration.
   115                config: |
   116                  jobs:
   117                    - name: local
   118                      address: 'redis://:password@127.0.0.1:9221'
   119              - name: Multi-instance
   120                description: |
   121                  > **Note**: When you define multiple jobs, their names must be unique.
   122                  
   123                  Local and remote instances.
   124                config: |
   125                  jobs:
   126                    - name: local
   127                      address: 'redis://:password@127.0.0.1:9221'
   128                  
   129                    - name: remote
   130                      address: 'redis://user:password@203.0.113.0:9221'
   131      troubleshooting:
   132        problems:
   133          list: []
   134      alerts: []
   135      metrics:
   136        folding:
   137          title: Metrics
   138          enabled: false
   139        description: ""
   140        availability: []
   141        scopes:
   142          - name: global
   143            description: These metrics refer to the entire monitored application.
   144            labels: []
   145            metrics:
   146              - name: pika.connections
   147                description: Connections
   148                unit: connections
   149                chart_type: line
   150                dimensions:
   151                  - name: accepted
   152              - name: pika.clients
   153                description: Clients
   154                unit: clients
   155                chart_type: line
   156                dimensions:
   157                  - name: connected
   158              - name: pika.memory
   159                description: Memory usage
   160                unit: bytes
   161                chart_type: area
   162                dimensions:
   163                  - name: used
   164              - name: pika.connected_replicas
   165                description: Connected replicas
   166                unit: replicas
   167                chart_type: line
   168                dimensions:
   169                  - name: connected
   170              - name: pika.commands
   171                description: Processed commands
   172                unit: commands/s
   173                chart_type: line
   174                dimensions:
   175                  - name: processed
   176              - name: pika.commands_calls
   177                description: Calls per command
   178                unit: calls/s
   179                chart_type: stacked
   180                dimensions:
   181                  - name: a dimension per command
   182              - name: pika.database_strings_keys
   183                description: Strings type keys per database
   184                unit: keys
   185                chart_type: stacked
   186                dimensions:
   187                  - name: a dimension per database
   188              - name: pika.database_strings_expires_keys
   189                description: Strings type expires keys per database
   190                unit: keys
   191                chart_type: stacked
   192                dimensions:
   193                  - name: a dimension per database
   194              - name: pika.database_strings_invalid_keys
   195                description: Strings type invalid keys per database
   196                unit: keys
   197                chart_type: stacked
   198                dimensions:
   199                  - name: a dimension per database
   200              - name: pika.database_hashes_keys
   201                description: Hashes type keys per database
   202                unit: keys
   203                chart_type: stacked
   204                dimensions:
   205                  - name: a dimension per database
   206              - name: pika.database_hashes_expires_keys
   207                description: Hashes type expires keys per database
   208                unit: keys
   209                chart_type: stacked
   210                dimensions:
   211                  - name: a dimension per database
   212              - name: pika.database_hashes_invalid_keys
   213                description: Hashes type invalid keys per database
   214                unit: keys
   215                chart_type: stacked
   216                dimensions:
   217                  - name: a dimension per database
   218              - name: pika.database_lists_keys
   219                description: Lists type keys per database
   220                unit: keys
   221                chart_type: stacked
   222                dimensions:
   223                  - name: a dimension per database
   224              - name: pika.database_lists_expires_keys
   225                description: Lists type expires keys per database
   226                unit: keys
   227                chart_type: stacked
   228                dimensions:
   229                  - name: a dimension per database
   230              - name: pika.database_lists_invalid_keys
   231                description: Lists type invalid keys per database
   232                unit: keys
   233                chart_type: stacked
   234                dimensions:
   235                  - name: a dimension per database
   236              - name: pika.database_zsets_keys
   237                description: Zsets type keys per database
   238                unit: keys
   239                chart_type: stacked
   240                dimensions:
   241                  - name: a dimension per database
   242              - name: pika.database_zsets_expires_keys
   243                description: Zsets type expires keys per database
   244                unit: keys
   245                chart_type: stacked
   246                dimensions:
   247                  - name: a dimension per database
   248              - name: pika.database_zsets_invalid_keys
   249                description: Zsets type invalid keys per database
   250                unit: keys
   251                chart_type: stacked
   252                dimensions:
   253                  - name: a dimension per database
   254              - name: pika.database_sets_keys
   255                description: Sets type keys per database
   256                unit: keys
   257                chart_type: stacked
   258                dimensions:
   259                  - name: a dimension per database
   260              - name: pika.database_sets_expires_keys
   261                description: Sets type expires keys per database
   262                unit: keys
   263                chart_type: stacked
   264                dimensions:
   265                  - name: a dimension per database
   266              - name: pika.database_sets_invalid_keys
   267                description: Sets invalid keys per database
   268                unit: keys
   269                chart_type: stacked
   270                dimensions:
   271                  - name: a dimension per database
   272              - name: pika.uptime
   273                description: Uptime
   274                unit: seconds
   275                chart_type: line
   276                dimensions:
   277                  - name: uptime