Logging is here!

SSH Check

Agent Check Agent Check

Supported OS: Linux Mac OS Windows

Overview

This check lets you monitor SSH connectivity to remote hosts and SFTP response times.

Setup

Installation

The SSH/SFTP check is included in the Datadog Agent package, so you don’t need to install anything else on your server from which you’d like to test SSH connectivity.

Configuration

  1. Edit the ssh_check.d/conf.yaml file in the conf.d/ folder at the root of your Agent’s directory.
    See the sample ssh_check.d/conf.yaml for all available configuration options:

        init_config:
    
        instances:
          - host: <SOME_REMOTE_HOST>  # required
            username: <SOME_USERNAME> # required
            password: <SOME_PASSWORD> # or use private_key_file
        #   private_key_file: <PATH_TO_PRIVATE_KEY>
        #   private_key_type:         # rsa or ecdsa; default is rsa
        #   port: 22                  # default is port 22
        #   sftp_check: False         # set False to disable SFTP check; default is True
        #   add_missing_keys: True    # default is False
  2. Restart the Agent to start sending SSH/SFTP metrics and service checks to Datadog.

Validation

Run the Agent’s status subcommand and look for ssh_check under the Checks section.

Data Collected

Metrics

sftp.response_time
(gauge)
The response time of SFTP
shown as second

Events

The SSH Check does not include any events at this time.

Service Checks

ssh.can_connect:

Returns CRITICAL if the Agent cannot open an SSH session, otherwise OK.

sftp.can_connect:

Returns CRITICAL if the Agent cannot open an SFTP session, otherwise OK.

Troubleshooting

Need help? Contact Datadog Support.

Further Reading

Learn more about infrastructure monitoring and all our integrations on our blog