How to get server/instance info

Article

Kurro Lopez · Apr 1 1m read

#API #Business Service #InterSystems IRIS #Caché

Hi all,

As part of the development an API to know what is the instance of IRIS is connected, I've found some methods to know information about the server that can help you.

Get the server name: $SYSTEM.INetInfo.LocalHostName()

Get the server IP: $SYSTEM.INetInfo.HostNameToAddr($SYSTEM.INetInfo.LocalHostName())

Get the instance name: $PIECE($SYSTEM,":",2)

So, I have created the following code as BS class:

Class St.Common.Api Extends (%CSP.REST, Ens.BusinessService)
{
{

XData UrlMap [ XMLNamespace = "http://www.intersystems.com/urlmap" ]
{
<Routes>
	<Route Url="/check" Method="GET" Call="Check"/>
</Routes>
}

ClassMethod Check() As %Status
{
	set serverInfo = {}
	set serverInfo.ServerName = $SYSTEM.INetInfo.LocalHostName()
	set serverInfo.ServerIP = $SYSTEM.INetInfo.HostNameToAddr($SYSTEM.INetInfo.LocalHostName())
	set serverInfo.Instance = $PIECE($SYSTEM,":",2)
	
	write serverInfo.%ToJSON()
	quit $$$OK
}
}

Calling the method:

localhost:52773/common/api/check

{
  "ServerName": "LAPTOP-KURRO-3",
  "ServerIP": "11.52.197.99",
  "Instance": "HEALTHCONNECT"
}

I hope it is as useful to you as it has been to me.

Best regards

{ "result": "OK", "methods": [ { "test": "SQL_USERS", "result": "OK" }, { "test": "SQL_APPOINTMENT", "result": "OK" }, { "test": "VERSION", "result": "1.14.0.0327" }, { "test": "INSTALLED", "result": "2024-12-04T08:04:52+01:00" } ], "serverName": "SRVPROD01", "serverApi": "10.168.1.1", "serverInstance": "HEALTHCONNECT", "execution_time": "00:00:00.0597418" }

Brett Saviano · Apr 1

@Kurro Lopez The GET /api/atelier/ REST endpoint contains a lot of useful information about the server and it's been available since 2016.2. It does require %Development to call though.

0 0

Kurro Lopez · Apr 1

Thanks @Brett Saviano

I've already taken a look at the api/atelier APIs, and they've been very helpful in retrieving namespace names.

In our check method, in addition to server information, we return more information about production, such as the version number, last installation date, connection status with external databases, etc.

We have two mirrored servers, so if one of the servers goes down, the backup server is activated.

If the server name is different than expected, it's because the backup server has been activated and is providing service without issue, but we have an alert that the primary server has gone down.

This is an example of what our check service returns: