Note: SentryOne Portal requires SentryOne software version 20.0 or above.
What is SentryOne Portal?
SentryOne Portal is a browser-based option for accessing your SentryOne environment data that uses your existing SentryOne database. It replaces the previous mobile applications and Cloud Sync options.
Note: Chrome and Edge are the recommended browsers for using SentryOne Portal.
SentryOne Portal shares the same UI experience as the cloud-based SentryOne Monitor product. It provides views for health, top SQL, alerts, and performance dashboards (including custom dashboards). See the Using SentryOne Monitor article to familiarize yourself with the overall layout.
Additional Information: The SentryOne Portal feature page contains a feature overview.
Are all target types supported with SentryOne Portal?
SentryOne Portal currently supports the following target types:
- SQL Server (including Amazon RDS)
- Azure SQL Database
Where can SentryOne Portal be Installed?
SentryOne Portal can be installed on-premises in one of the following configurations:
- As a self-hosted configuration as a service
- Hosted in Internet Information Services (IIS)
Before installing SentryOne Portal on-premises, ensure your machine(s) meets the following system requirements:
- 64-bit Microsoft Windows Server 2012 or greater
- Microsoft .NET Core 2.2 Runtime
- Install the Runtime and Hosting Bundle if you are hosting in IIS
- Microsoft .NET Framework 4.8 Runtime
Note: Both Microsoft .NET Runtime prerequisites need to be installed on the Windows Server that will host SentryOne Portal.
- Configured SentryOne database (version 20.0 or greater) that's accessible by the web server
- For information about configuring a SentryOne database, see the SentryOne Installation article.
- Administrative access to the Windows Server hosting SentryOne Portal
- Latest SentryOne.Monitor.WebClient.Web artifact or the latest version of the Enterprise Platform Installer
- The preferred IP address and port that SentryOne Portal should use to listen for HTTP traffic
- The SentryOne Portal service can only listen to HTTP traffic. If you want to use HTTPS, you need to setup a reverse proxy through IIS or other reverse proxy solution.
- If you plan to change the binding address or port, ensure that there isn't already something listening to that address and port on the machine.
- It's recommended to set the IP address to 127.0.0.1 if you're planning to route requests through IIS or other reverse proxy on the same machine as the service. This will prevent external requests from directly reaching the service.
Installing SentryOne Portal using EPI
After you have ensured that your machine meets the prerequisite requirements, you can begin installing SentryOne Portal. Install SentryOne Portal on your machine with EPI by completing the following steps:
1. You must have installed or upgraded SentryOne to version 20 using EPI before proceeding. Follow the instructions on the Enhanced Platform Installer article if you haven't completed this process.
2. SentryOne Portal requires the SentryOne controller service on the machine where it is installed. Follow the Install Additional Monitoring Services instructions on the Install tab of the Enhanced Platform Installer article to install the controller service.
Note: If you are installing SentryOne Portal on a machine where you have installed a monitoring service, then it already has the required controller service, however, the recommended setup is a dedicated machine that does not have the full monitoring service.
3. Run the following command to complete SentryOne Portal installation:
so installmp -n <connectionName> -s <portalServerFQDN> -u <serviceAccount> -b <ipAddress:port>
- The -s switch is for the server that will host SentryOne Portal (<portalServerFQDN>) and must be the Fully Qualified Domain Name (FQDN). If needed, this name can be found by using the list command to view the Controller Service value. See the Commands tab of the EPI article for additional information on using list.
so list -t services -n <connectionName>
- The switch -b <ipAddress:port> is optional, and can be omitted if you're using the default value of 0.0.0.0:9991.
Installing SentryOne Portal On Premises Manually
Important: SentryOne Portal must be installed outside of the user's directory.
After you have ensured that your machine meets the prerequisite requirements, you can begin installing SentryOne Portal. Install SentryOne Portal on your machine manually by completing the following steps:
1. Unzip the SentryOne.Monitor.WebClient.Web artifact at the desired location on the machine hosting SentryOne Portal.
2. Update the appSettings.json file in the root of the project with the correct connection string for the client’s database.
3. Run the service install script OnPremServiceInstall.ps1 as administrator. Enter the IP address and port that you want to bind the service to in the appropriate prompt.
Note: To use integrated authentication for the database connection, you need to change the account that the SentryOne portal service is running under in the Windows Services Control panel after installation. The default account is LocalSystem.
Note: You can re-run the service install script OnPremServiceInstall.ps1 at any time to change the IP address or port and update the service. The SentryOne Portal service will be turned off during the script's execution.
IIS Reverse Proxy Configuration (Optional)
Additional Information: The following steps cover the process required to set up IIS as a reverse proxy to the SentryOne Portal service for SSL and request filtering. For information about IIS administration, see IIS.net.
IIS Reverse Proxy Prerequisites
The following modules must be installed before configuring your reverse proxy:
Note: These required modules are not installed by default.
IIS Reverse Proxy Instructions
Configure a reverse proxy in IIS to host SentryOne Portal by completing the following steps:
1. Create a website with your desired outward bindings. If you want to use HTTPS, this is where you will register your SSL certificate. Point the site to the default IIS directory.
Note: The default IIS directory is often C:\inetpub\wwwroot. The Application Pool settings wont have an effect on the behavior of this site because it will not be executing code. You can set the .NET CLR version to No Managed Code, but this is not required.
2. Open the Home window for the new site, and select the URL Rewrite feature.
3. Select the Add Rule action from the right window pane, and then select Reverse Proxy rule from the Inbound and Outbound Rules category.
4. Enter the IP address and port of the service in the Inbound Rules server name input. Ensure that Enable SSL Offloading is selected. Select OK to save the rule.
Note: Localhost:9991 is the default IP address.
Success: IIS now routes all requests to the website to the SentryOne Portal service.
Accessing your SentryOne Portal
Open your SentryOne Portal by completing the following steps:
1. Enter your domain for the SentryOne Portal in your preferred browser.
Note: In this example, the SentryOne Portal is bound to localhost, http://localhost/
2. Enter your authentication credentials to access the SentryOne Portal.