Charmed-Kubernetes/nrpe/config.yaml

options:
  nagios_master:
    default: "None"
    type: string
    description: |
        IP address of the nagios master from which to allow rsync access        
  server_port:
    default: 5666
    type: int
    description: |
        Port on which nagios-nrpe-server will listen        
  nagios_address_type:
    default: "private"
    type: string
    description: |
        Determines whether the nagios host check should use the private
        or public IP address of an instance.  Can be "private" or "public".        
  nagios_host_context:
    default: "juju"
    type: string
    description: |
        A string which will be prepended to instance name to set the host name
        in nagios. So for instance the hostname would be something like:
            juju-postgresql-0
        If you're running multiple environments with the same services in them
        this allows you to differentiate between them.        
  nagios_hostname_type:
    default: "auto"
    type: string
    description: |
        Determines whether a server is identified by its unit name or
        host name.  If you're in a virtual environment, "unit" is
        probably best.  If you're using MaaS, you may prefer "host".
        Use "auto" to have nrpe automatically distinguish between 
        metal and non-metal hosts.        
  dont_blame_nrpe:
    default: False
    type: boolean
    description: |
        Setting dont_blame_nrpe to True sets dont_blame_nrpe=1 in nrpe.cfg
        This config option which allows specifying arguments to nrpe scripts.
        This can be a security risk so it is disabled by default. Nrpe is
        compiled with --enable-command-args option by default, which this
        option enables.        
  debug:
    default: False
    type: boolean
    description: |
        Setting debug to True enables debug=1 in nrpe.cfg        
  disk_root:
    default: "-u GB -w 25% -c 20% -K 5%"
    type: string
    description: |
        Root disk check. This can be made to also check non-root disk systems
        as follows:
            -u GB -w 20% -c 15% -r '/srv/juju/vol-' -C -u GB -w 25% -c 20%
        The string '-p /' will be appended to this check, so you must finish
        the string taking that into account. See the nagios check_disk plugin
        help for further details.
        .
        Set to '' in order to disable this check.        
  zombies:
    default: ""
    type: string
    description: |
      Zombie processes check; defaults to disabled. To enable, set the desired
      check_procs arguments pertaining to zombies, for example: "-w 3 -c 6 -s Z"      
  procs:
    default: ""
    type: string
    description: |
        Set thresholds for number of running processes.  Defaults to disabled;
        to enable, specify 'auto' for the charm to generate thresholds based
        on processor count, or manually provide arguments for check_procs, for
        example: "-k -w 250 -c 300" to set warning and critical levels
        manually and exclude kernel threads.        
  load:
    default: "auto"
    type: string
    description: |
        Load check arguments (e.g. "-w 8,8,8 -c 15,15,15"); if 'auto' is set,
        thresholds will be set to multipliers of processor count for 1m, 5m
        and 15m thresholds, with warning as "(4, 2, 1)", and critical set to
        "(8, 4, 2)". So if you have two processors, you'd get thresholds of
        "-w 8,4,2 -c 16,8,4".
        .
        Set to '' in order to disable this check.        
  conntrack:
    default: "-w 80 -c 90"
    type: string
    description: |
        Check conntrack (net.netfilter.nf_conntrack_count) against thresholds.
        .
        Set to '' in order to disable this check.        
  users:
    default: ""
    type: string
    description: |
        Set thresholds for number of logged-in users.  Defaults to disabled;
        to enable, manually provide arguments for check_user, for example:
        "-w 20 -c 25"        
  swap:
    default: ''
    type: string
    description: |
        Check swap utilisation.  See the nagios check_swap plugin help for
        further details. The format looks like "-w 40% -c 25%"
        .
        Set to '' in order to disable this check.        
  swap_activity:
    default: "-i 5 -w 10240 -c 40960"
    type: string
    description: |
        Swapout activity check. Thresholds are expressed in kB, interval in
        seconds.
        .
        Set to '' in order to disable this check.        
  mem:
    default: "-C -h -u -w 85 -c 90"
    type: string
    description: |
        Check memory % used.
        By default, thresholds are applied to the non-hugepages portion of the
        memory.
        .
        Set to '' in order to disable this check.        
  lacp_bonds:
    default: ''
    type: string
    description: |
        LACP bond interfaces, space-delimited (ie. 'bond0 bond1')        
  netlinks:
    default: ''
    type: string
    description: |
        Network interfaces to monitor for correct link state, MTU size
        and speed negotiated. The first argument is either an interface name or
        a CIDR expression. Parsed keywords are "mtu", "speed", and "op". Other
        keywords are ignored.
        .
        Note that CIDR expressions can match multiple devices.
        .
        For example (multi-line starts with pipe):
        - 10.1.2.0/24 mtu:9000 speed:25000
        - eth0 mtu:9000 speed:25000
        - lo mtu:65536 op:unknown
        - br0-mgmt mtu:9000
        - br0-sta mtu:9000
        - br0-stc mtu:9000
        - br0-api mtu:1500
        - bond0 mtu:9000 speed:50000
        - bond0.25 mtu:1500 speed:50000
        - ens3 mtu:1500 speed:-1 desc:openstack_iface
        - ...        
  netlinks_skip_unfound_ifaces:
    default: False
    type: boolean
    description: |
        add --skip-unfound-ifaces to check_netlinks.py.        
  monitors:
    default: ''
    type: string
    description: |
        Additional monitors defined in the monitors yaml format (see README)        
  hostgroups:
    default: ""
    type: string
    description: Comma separated list of hostgroups to add for these hosts
  hostcheck_inherit:
    default: "server"
    type: string
    description: Hostcheck to inherit
  export_nagios_definitions:
    default: False
    type: boolean
    description: |
        If True nagios check definitions are written to
        '/var/lib/nagios/export' and rync is configured to allow nagios_master
        to collect them. Useful when Nagios is outside of the juju environment        
  sub_postfix:
    default: ""
    type: string
    description: |
        A string to be appended onto all the nrpe checks created by this charm
        to avoid potential clashes with existing checks        
  xfs_errors:
    default: ""
    type: string
    description: |
        dmesg history length to check for xfs errors, in minutes
        .
        Defaults to disabled, set the time to enable.        
  ro_filesystem_excludes:
    default: "/snap/,/sys/fs/cgroup,/run/containerd,/var/lib/docker"
    type: string
    description: |
      Comma separated list of mount points to exclude from checks for readonly filesystem.
      Can be a substring rather than the entire mount point, e.g. /sys will match all filesystems
      beginning with the string /sys.
      The check is disabled on all LXD units, and also for non-container units if this parameter is
      set to ''.      
  cpu_governor:
    default: ""
    type: string
    description: |
      CPU governor check. The string value here will be checked against all CPUs in
      /sys/devices/system/cpu/cpu*/cpufreq/scaling_governor. The supported values are
      'ondemand', 'performance', 'powersave'. Unset value means the check will be disabled.
      There is a relation key called requested_cpu_governor='string', but the charm config value
      will take precedence over the relation data.