You should monitor all paths to the Storage Connector, including paths to Orchestration, Apigee gateway, Syncplicity health, SMTP gateway (if using Syncplicity StorageVault Authentication), and any identity providers and administrative tools.
Orchestration
To monitor connectivity to Orchestration layer check the availability of the following url - https://xml.syncplicity.com/1.1.
Monitoring should expect 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 3 sequential connection with 5 second interval. If they fail alert should be generated considering an Orchestration layer connectivity down.
Use 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"
}
Apigee 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). Check that this port is open on firewalls and is accessible by the Storage Connector. A TCP connection on port 443 should be generated every 30 seconds. If a connection fails there should be up to 3 sequential connection with 5 second interval. If they fail alert should be generated considering an API gateway down.
Health
Instrumentation that serves monitoring & metering capability for the client to the service to monitor uptime
To monitor connectivity to Health check the availability of the following url - https://health.syncplicity.com/v1. Monitoring should expect 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 3 sequential connection with 5 second interval. If they fail alert should be generated considering an SMTP server down.
SMTP gateway
If StorageVault Authentication (SVA) is configured, you need to check the connectivity to the SMTP gateway. A TCP connection on port configured should be generated every 30 seconds. SMTP reply code 220 can be considered as positive. If a connection fails, there should be up to 3 sequential connections with 5 second intervals. If they fail, yopu should consider that the SMTP server is down. The SMTP server and port can be found in the /etc/syncp-storage/syncp-storage.conf file.
#smtp server configuration
smtp {
host: "mail.example.com"
port: 25
# port: 465
# user: "username"
# password:"password"
# ssl: true
}
Management
You should monitor the connectivity between the Storage Connector and any identity providers and user provisioning services. For example:
- Single Sign On Service. Make sure that the SSO login page is available.
- User Provisioning Service, such as the Active Directory Connector (ADC) process or your provisioning utility.