Monitoring connectivity

All paths to the Storage Connector should be monitored, including the following:

  • Orchestration
  • Syncplicity API Gateway
  • Syncplicity Health
  • SMTP Gateway (if using Syncplicity StorageVault Authentication)
  • Any identity providers and administrative tools

Orchestration

To monitor connectivity to the Orchestration layer:

  • Check the availability of this url: https://xml.syncplicity.com/1.1.
  • Monitoring should expect the HTTP 200 OK code to consider connectivity to Orchestration layer UP.
  • A connection should be generated every 30 seconds.
  • If a connection fails there should be up to three sequential connections with 5 second intervals. If they fail, an alert should be generated regarding the Orchestration layer connectivity down.

Use the access key configured in /etc/syncp-storage/syncp-storage.conf file under syncplicity.ws section. For example:

syncplicity.ws {
  # the access key used to authenticate this storage endpoint with Syncplicity
  accesskey: "ExAmPle+kEy"
}

Syncplicity API gateway

This connection is used only for custom integrations to access Syncplicity APIs.

To monitor connectivity to the API Gateway:

  • Check the connectivity of api.syncplicity.com via https (TCP/443).
  • Ensure this port is open on firewalls and is accessible using the Storage Connector.
  • A TCP connection on port 443 should be generated every 30 seconds.
  • If a connection fails there should be up to three sequential connections with 5 second intervals. If they fail, an alert should be generated regarding the API gateway down.

Syncplicity health

This connection is used for the instrumentation that serves the monitoring and metering capability for the client to the service to monitor uptime.

To monitor connectivity to health:

  • Check the availability of this url: https://health.syncplicity.com/v1.
  • Monitoring should expect the HTTP 200 OK code to consider connectivity to Storage UP.
  • A connection should be generated every 30 seconds.
  • If a connection fails there should be up to three sequential connections with 5 second intervals. If they fail an alert should be generated regarding the SMTP server down.

SMTP Gateway

This connection is used If StorageVault Authentication (SVA) is configured.

To monitor connectivity to the SMTP Gateway:

  • Check the connectivity to the SMTP gateway.
  • A TCP connection on the configured port should be generated every 30 seconds.
  • SMTP reply code 220 is considered positive.
  • If a connection fails, there should be up to three sequential connections with 5 second intervals. If they fail, the SMTP server may be down.

The SMTP server and port can be found in the /etc/syncp-storage/syncp-storage.conf file, for example:

#smtp server configuration
smtp {
    host: "mail.example.com"
    port: 25
#    port: 465
#    user: "username"
#    password:"password"
#    ssl: true
}

Management

It is important to monitor the connectivity between the Storage Connector and any identity providers and user provisioning services. For example:

  • Single Sign On Service. - ensure the SSO login page is available.
  • User Provisioning Service - such as the Active Directory Connector (ADC) process or your provisioning utility.

Related Links