SSH

Supported OS Linux Windows

Integrationv2.3.2

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. No additional installation is needed on your server.

Configuration

Host

To configure this check for an Agent running on a host:

  1. Edit the ssh_check.d/conf.yaml file in the conf.d/ folder at the root of your Agent’s configuration 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.

Containerized

For containerized environments, see the Autodiscovery Integration Templates for guidance on applying the parameters below.

ParameterValue
<INTEGRATION_NAME>ssh_check
<INIT_CONFIG>blank or {}
<INSTANCE_CONFIG>{"host": "%%host%%", "port":"22", "username":"<USERNAME>"}

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.

Service Checks

ssh.can_connect
Returns CRITICAL if the Agent check is unable to connect to the SSH host. Returns OK otherwise.
Statuses: ok, critical

sftp.can_connect
Returns CRITICAL if the Agent check is unable to connect to the SFTP host. Returns OK otherwise.
Statuses: ok, critical

Troubleshooting

Need help? Contact Datadog support.