Start Out with System Alerting and Monitoring
System Alerting and Monitoring (SAM) is a containerizedOpens in a new tab application that integrates an InterSystems IRIS instance called the SAM Manager with multiple open-source applications (Prometheus, Grafana, Alertmanager, and Nginx) to provide a resilient and scalable platform for monitoring InterSystems products.
This page and the pages which follow provide a guide to using SAM versions 1.0 and 1.1 to monitor your system. They assume that you have already completed the initial setup.
If you are using SAM version 2.0, please refer to the guide for SAM 2.0 instead.
You can also interface with SAM using its REST API.
Start and Stop SAM
To Start SAM
Using the cd command in the command line, navigate to the directory containing the SAM docker-compose.yml file, which was acquired during initial setup.
Next, run the start.sh script:
This runs a Docker Compose command to start the SAM application. (Alternatively, you can execute the equivalent commands directly on the command line.)
Optionally, you can use the docker ps command to confirm that all the containers are running. The output should look similar to the following:
$ docker ps CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES 2aaa06f06a9c nginx:1.17.9-alpine "nginx -g 'daemon of..." About an hour ago Up About an hour 80/tcp, 0.0.0.0:8080->8080/tcp sam_nginx_1 0e2b30fcb376 grafana/grafana:6.7.1 "/run.sh" About an hour ago Up About an hour 3000/tcp sam_grafana_1 d2c825f9d220 prom/alertmanager:v0.20.0 "/bin/alertmanager -..." About an hour ago Up About an hour 9093/tcp sam_alertmanager_1 4851893bc369 prom/prometheus:v2.17.1 "/bin/prometheus --w..." About an hour ago Up About an hour 9090/tcp sam_prometheus_1 61120be391df intersystems/sam:126.96.36.199 "/iris-main" About an hour ago Up About an hour (healthy) 2188/tcp, 1973/tcp, 1974/tcp sam_iris_1
For SAM version 1.1, the SAM image also includes an iris-init container, which runs an initialization service briefly at startup and then stops.
To Stop SAM
Using the cd command in the command line, navigate to the directory containing the SAM docker-compose.yml file.
Next, run the stop.sh script:
This runs a Docker Compose command to stop the SAM application. (Alternatively, you can execute the equivalent commands directly on the command line.)
Optionally, you can use the docker ps command to confirm that all the containers have stopped. Use the -a flag to view all containers, even those that are not running:
docker ps -a
Access the SAM Web Portal
When System Alerting and Monitoring is running, you can access it from a web browser at the following address:
where <sam-domain-name> is the DNS name or IP address of the system SAM is running on, and <port> is the configured Nginx port (8080 by default). You may want to bookmark this address.
When accessing SAM, you must log in using a valid User Name and Password. Like InterSystems IRIS, SAM includes several predefined accounts with the default password SYS. Choose any of these accounts with login permissions (such as Admin or SuperUser) and log in using the default password SYS.
To secure the SAM application, be sure to set a new password for all the predefined accounts. For a list of all the predefined accounts, see Predefined User AccountsOpens in a new tab in the “Users” chapter of the Security Administration Guide.
Upon successful login, SAM displays the Monitor Clusters page, which provides a system-wide performance overview.