spec.yaml

name: Redis
files:
- name: redisdb.yaml
  options:
  - template: init_config
    options:
    - template: init_config/default

  - template: instances
    options:
    - name: host
      required: true
      description: Enter the host to connect to.
      value:
        type: string
        example: localhost
      fleet_configurable: true
    - name: port
      required: true
      description: Enter the port of the host to connect to.
      formats: ["port"]
      value:
        type: integer
        example: 6379
      fleet_configurable: true
    - name: unix_socket_path
      description: Connect through a unix socket instead of using a `host` and `port`.
      value:
        type: string
        example: /var/run/redis/redis.sock
        display_default: null
      fleet_configurable: true
    - name: db
      description: |
        The index of the database (keyspace) to use.
        The default is index 0. Any other index results in a SELECT command sent upon connection
        to choose the desired database. For redis.clone, this can also be NA in which case the same database is
        used as in rc.
      value:
        type: integer
        example: 0
      fleet_configurable: true
    - name: username
      description: The username for the connection. Redis 6+ only.
      value:
          type: string
      fleet_configurable: true
    - name: password
      description: The password for the connection.
      secret: true
      value:
        type: string
      fleet_configurable: true
    - name: collect_client_metrics
      description: |
        Collects metrics using the `CLIENT` command.
        This requires the Redis CLIENT command to be available on your servers.
      value:
        type: boolean
        example: false
      fleet_configurable: true
    - name: socket_timeout
      description: Custom timeout for the check request.
      value:
        type: integer
        example: 5
      fleet_configurable: true
    - name: ssl
      description: Enable SSL/TLS encryption for the check.
      value:
        type: boolean
        example: false
      fleet_configurable: true
    - name: ssl_keyfile
      description: The path to the client-side private keyfile.
      value:
        type: string
        example: "<CERT_KEY_PATH>"
      fleet_configurable: true
    - name: ssl_certfile
      description: The path to the client-side certificate file.
      value:
        type: string
        example: "<CERT_PEM_PATH>"
      fleet_configurable: true
    - name: ssl_ca_certs
      description:  The path to the CA certs file.
      value:
        type: string
        example: "<CERT_PATH>"
      fleet_configurable: true
    - name: ssl_cert_reqs
      description: |
        Specifies whether a certificate is required from the
        other side of the connection, and whether it's validated if provided.
          * 0 for ssl.CERT_NONE (certificates ignored)
          * 1 for ssl.CERT_OPTIONAL (not required, but validated if provided)
          * 2 for ssl.CERT_REQUIRED (required and validated)
      value:
        type: integer
        example: 2
      fleet_configurable: true
    - name: ssl_check_hostname
      description: |
        Verify the server's SSL certificate hostname matches the connection target.
        Redis-py 6.0+ defaults this to true. Set to false if your certificate
        does not match the connection hostname (for example, if connecting by IP).
      value:
        type: boolean
        example: true
      fleet_configurable: true
    - name: keys
      description: |
        Enter the list of keys to collect the lengths from.
        The length is 1 for strings.
        The length is zero for keys that have a type other than list, set, hash, or sorted set.
        Note: Keys can be expressed as patterns, see https://redis.io/commands/keys.
      value:
        type: array
        items:
          type: string
        example:
          - "<KEY_1>"
          - "<KEY_PATTERN>"
      fleet_configurable: true
    - name: warn_on_missing_keys
      description: |
        If you provide a list of 'keys', set this to true to have the Agent log a warning
        when keys are missing.
      value:
        type: boolean
        example: true
      fleet_configurable: true
    - name: slowlog-max-len
      description: |
        Set the maximum number of entries to fetch from the slow query log.
        By default, the check reads this value from the redis config, but is limited to 128.

        Set a custom value here if you need to get more than 128 slowlog entries every 15 seconds.
        Warning: Higher values may impact the performance of your Redis instance.
      value:
        type: integer
        example: 128
    - name: command_stats
      description: Collect INFO COMMANDSTATS output as metrics.
      value:
        type: boolean
        example: false
      fleet_configurable: true
    - name: disable_connection_cache
      description: |
        Enable the connections cache so the check attempts to reuse the same Redis connections
        at every collection cycle. If disabled, this prevents stale connections.
      value:
        type: boolean
        example: false
      fleet_configurable: true
    - template: instances/default

  - template: logs
    example:
    - type: file
      path:  /var/log/redis_6379.log
      source: redis
      service: "<SERVICE>"

- name: auto_conf.yaml
  options:
    - template: ad_identifiers
      overrides:
        value.example:
          - redis
    - template: init_config
      options: []
    - template: instances
      options:
        - name: host
          required: true
          description: Enter the host to connect to.
          value:
            example: '%%host%%'
            type: string
          fleet_configurable: true
        - name: port
          required: true
          description: Enter the port of the host to connect to.
          value:
            example: 6379
            type: integer
          fleet_configurable: true