Metadata-Version: 2.0
Name: datadog-ssh-check
Version: 1.2.0
Summary: The SSH check
Home-page: https://github.com/DataDog/integrations-core
Author: Datadog
Author-email: packages@datadoghq.com
License: BSD
Keywords: datadog agent ssh_check check
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Topic :: System :: Monitoring
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Requires-Dist: cryptography (==2.2.2)
Requires-Dist: paramiko (==2.1.5)
Requires-Dist: pyasn1 (==0.4.2)
Requires-Dist: cffi (==1.11.5)
Requires-Dist: pycparser (==2.18)
Requires-Dist: enum34 (==1.1.6)
Requires-Dist: asn1crypto (==0.24.0)
Requires-Dist: ipaddress (==1.0.22)
Requires-Dist: datadog-checks-base

# Agent Check: SSH/SFTP

## 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][1] 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][2] for all available configuration options:

    ```yaml
        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][3] to start sending SSH/SFTP metrics and service checks to Datadog.

### Validation

[Run the Agent's `status` subcommand][4] and look for `ssh_check` under the Checks section.

## Data Collected
### Metrics

See [metadata.csv][5] for a list of metrics provided by this check.

### 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][6].

## Further Reading
Learn more about infrastructure monitoring and all our integrations on [our blog][7]


[1]: https://app.datadoghq.com/account/settings#agent
[2]: https://github.com/DataDog/integrations-core/blob/master/ssh_check/conf.yaml.example
[3]: https://docs.datadoghq.com/agent/faq/agent-commands/#start-stop-restart-the-agent
[4]: https://docs.datadoghq.com/agent/faq/agent-commands/#agent-status-and-information
[5]: https://github.com/DataDog/integrations-core/blob/master/ssh_check/metadata.csv
[6]: http://docs.datadoghq.com/help/
[7]: https://www.datadoghq.com/blog/


