Is there a way to set custom property values from your groovy script in your datasource? | Product Discussions

domenicbetters · 2023-05-16T19:47:23Z

Hey there. I’m relatively new to logic monitor and I received a request from a client. The request is as follows. They wanted us to be able to provide not only blocked processes alerts for their SQL dbs but also for us to provide a breakdown of what is blocking what.My solution to this was to edit the datasource that contains the processblocked datapoint. I made some good progress. I was able to create a custom property field for the instances that I’m monitoring. I then edited the script for the collector attribute so that in theory that if particular datapoint (processessblocked) shows a value of greater than 0, it uses hostSets() to change that custom property value to the blocker session ids using some custom sql script within. When I test it using the test button pointed at my sql server, it works exactly as i expected. It shows the default value of the property unless it hits that block process value of 1 or more. then the property reads with the needed info. However after I save the datasource. And put this in to practice, no matter what the custom property on those instances never update or change. I also tried applying similar logic to the active discovery script with the same results. Seems to work fine through testing but then nothing in the actual instance changes. I can post any or all of the groovy script if need be. Is it something simple like some sort of syntax I’m not getting or am I not even in the right area to do what I’m attempting to do?Any help would be appreciated and like I said, I’ll gladly provide any more info or code if need be. Thanks

domenicbetters

OP3 years ago

It seems the issue has something to do with API calls in general, and if I can get anything out of support, I’ll post an update. But for the purpose of the original post, I’d say mission accomplished.

I’d guess there’s a problem with those collectors accessing the internet. In postman, there’s an option on the right that looks like “</>”. If you pop that open, it’ll auto generate simple code to make your API call. If you select cURL, you should be able to paste that into a bash shell on the collector (presuming the token in that code is recent). If that fails with a similar error, that would mean a problem on the host, not related to the collector software.

Good idea, and after testing it, it works fine through powershell and bash. So looks like it is a collector issue.

LM User

·3 years ago

It seems the issue has something to do with API calls in general, and if I can get anything out of support, I’ll post an update. But for the purpose of the original post, I’d say mission accomplished.

I’d guess there’s a problem with those collectors accessing the internet. In postman, there’s an option on the right that looks like “</>”. If you pop that open, it’ll auto generate simple code to make your API call. If you select cURL, you should be able to paste that into a bash shell on the collector (presuming the token in that code is recent). If that fails with a similar error, that would mean a problem on the host, not related to the collector software.

domenicbetters

OP3 years ago

Alright, I know you’ve already got yours working but I’ve been meaning to simplifying this into a single function for years and never got around to it. Well, now I have. Hopefully the documentation is sufficient. I’m not sure it’ll fix the issue you’re having with the devices on the lab collectors, but I’d be interested to know how it goes for you.

Actually, I dipped into your github and tested out your version already. I love how it’s cleaned up but unfortunately, in regard to that issue with the two training devices, that unknownhostexception persists.

It seems the issue has something to do with API calls in general, and if I can get anything out of support, I’ll post an update. But for the purpose of the original post, I’d say mission accomplished.

LM User

·3 years ago

Alright, I know you’ve already got yours working but I’ve been meaning to simplifying this into a single function for years and never got around to it. Well, now I have. Hopefully the documentation is sufficient. I’m not sure it’ll fix the issue you’re having with the devices on the lab collectors, but I’d be interested to know how it goes for you.

domenicbetters

OP3 years ago

Well, I still haven’t been able to resolve this issue with a few of our training devices. That aside, the modified script works as intended and I finally have a solution to my original problem posed in first message of this post.

Huge thanks to Stuart for letting me bug him every step of the way.

So the solution was to use API calls within int he collector attribute script inside the mysql global performance datasource.

I won’t share the whole script but I will post parts that seem relevant to my issue and solution.

A lot of extra imports were needed to get this working and before the base script starts i establish to GET requests to obtain info needed to get to my final GET and PUT request

import groovy.sql.Sql<br/><br/>import com.santaba.agent.groovyapi.http.*;<br/><br/>import groovy.json.JsonSlurper;<br/><br/>import org.apache.http.HttpEntity<br/><br/>import org.apache.http.client.methods.CloseableHttpResponse<br/><br/>import org.apache.http.client.methods.HttpGet<br/><br/>import org.apache.http.client.methods.HttpPut<br/><br/>import org.apache.http.impl.client.CloseableHttpClient<br/><br/>import org.apache.http.impl.client.HttpClients<br/><br/>import org.apache.http.util.EntityUtils<br/><br/>import javax.crypto.Mac;<br/><br/>import javax.crypto.spec.SecretKeySpec;<br/><br/>import org.apache.commons.codec.binary.Hex;<br/><br/>import groovy.json.*;<br/><br/>import org.apache.http.entity.ContentType;<br/><br/>import org.apache.http.entity.StringEntity;<br/><br/>import org.apache.http.client.utils.URIBuilder<br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/>// ***  Establish API Creds  ***<br/><br/>def accessId = hostProps.get("lmaccess.id");<br/><br/>def accessKey = hostProps.get("lmaccess.key");<br/><br/>def account = 'micoresolutions';<br/><br/><br/><br/><br/>// *** Get Datasource ID for device as string. ***<br/><br/>def resourcePath = '/device/devices/'+hostProps.get("system.deviceID")+'/devicedatasources'<br/><br/>def url = "https://" + account + ".logicmonitor.com" + "/santaba/rest" + resourcePath;<br/><br/><br/><br/>    //get current time<br/><br/>epoch = System.currentTimeMillis();<br/><br/><br/><br/>    //calculate signature<br/><br/>requestVars = "GET" + epoch + resourcePath;<br/><br/><br/><br/>hmac = Mac.getInstance("HmacSHA256");<br/><br/>secret = new SecretKeySpec(accessKey.getBytes(), "HmacSHA256");<br/><br/>hmac.init(secret);<br/><br/>hmac_signed = Hex.encodeHexString(hmac.doFinal(requestVars.getBytes()));<br/><br/>signature = hmac_signed.bytes.encodeBase64();<br/><br/><br/><br/>    // HTTP GET<br/><br/>CloseableHttpClient httpdsid = HttpClients.createDefault();<br/><br/>httpGet = new HttpGet(url);<br/><br/>    // Add custom filter values to GET Request<br/><br/>URI uri = new URIBuilder(httpGet.getURI())<br/><br/>      .addParameter("fields", "id")<br/><br/>      .addParameter("filter", "dataSourceName:Microsoft_SQLServer_GlobalPerformance")<br/><br/>      .build();<br/><br/>      httpGet.setURI(uri);<br/><br/><br/><br/>httpGet.addHeader("Authorization" , "LMv1 " + accessId + ":" + signature + ":" + epoch);<br/><br/>response = httpdsid.execute(httpGet);<br/><br/>responseBody = EntityUtils.toString(response.getEntity());<br/><br/>    // Turn data into id string that can be inserted into next Request<br/><br/>datapull = new JsonSlurper().parseText(responseBody.toString());<br/><br/>datapull =   datapull.data.items.id.value.toString()<br/><br/>datapull = datapull.replace("[","")<br/><br/>datasouceid = datapull.replace("]","")<br/><br/><br/><br/>httpdsid.close()<br/><br/><br/><br/>//  *** get instance ID for each instance on device ***<br/><br/><br/><br/> resourcePath = "/device/devices/"+hostProps.get("system.deviceID")+"/devicedatasources/${datasouceid}/instances"<br/><br/> url = "https://" + account + ".logicmonitor.com" + "/santaba/rest" + resourcePath;<br/><br/><br/><br/>    //get current time<br/><br/>epoch = System.currentTimeMillis();<br/><br/><br/><br/>    //calculate signature<br/><br/>requestVars = "GET" + epoch + resourcePath;<br/><br/><br/><br/>hmac = Mac.getInstance("HmacSHA256");<br/><br/>secret = new SecretKeySpec(accessKey.getBytes(), "HmacSHA256");<br/><br/>hmac.init(secret);<br/><br/>hmac_signed = Hex.encodeHexString(hmac.doFinal(requestVars.getBytes()));<br/><br/>signature = hmac_signed.bytes.encodeBase64();<br/><br/><br/><br/>    // HTTP GET<br/><br/>CloseableHttpClient httpinstanceid = HttpClients.createDefault();<br/><br/>httpGet = new HttpGet(url);<br/><br/>httpGet.addHeader("Authorization" , "LMv1 " + accessId + ":" + signature + ":" + epoch);<br/><br/>response = httpinstanceid.execute(httpGet);<br/><br/>responseBody = EntityUtils.toString(response.getEntity());<br/><br/>    // Male array of instance ids for final get and put request<br/><br/>datapull = new JsonSlurper().parseText(responseBody.toString());<br/><br/>instanceids =   datapull.data.items.id<br/><br/><br/><br/>httpinstanceid.close()

My final resource path --- "/device/devices/"+hostProps.get("system.deviceID")+"/devicedatasources/${datasouceid}/instances/"+instanceids

requires a deviceID, a datasourceID and an instanceID. So the first get pulls the correct datasource ID and the second get uses that datasourceID to grab the instance IDs.

Then Once the collector begins its SQL query loop to find the values for all those datapoints, I insert my final GET and PUT, as well as using a custom SQL query script to find the blocker info I need.

 if ("${counter_name}"=="Processesblocked")<br/><br/>                        {<br/><br/>// ***Follow up if statement that decides between which Put request to use based on whether there is in fact a block or not. ***<br/><br/>                            if ("${cntr_value}".toInteger() > 0)<br/><br/>                            {<br/><br/>// ***For loop to cycle through each instance on the device pulled from instance array***<br/><br/>                                for(i=0; i < instanceids.size; i++)<br/><br/>                                {<br/><br/><br/><br/>                                    resourcePath = "/device/devices/"+hostProps.get("system.deviceID")+"/devicedatasources/${datasouceid}/instances/"+instanceids<i><br/><br/>                                    url = "https://" + account + ".logicmonitor.com" + "/santaba/rest" + resourcePath;<br/><br/><br/><br/>                                    //get current time<br/><br/>                                    epoch = System.currentTimeMillis();<br/><br/><br/><br/>                                    //calculate signature<br/><br/>                                    requestVars = "GET" + epoch + resourcePath;<br/><br/><br/><br/>                                    hmac = Mac.getInstance("HmacSHA256");<br/><br/>                                    secret = new SecretKeySpec(accessKey.getBytes(), "HmacSHA256");<br/><br/>                                    hmac.init(secret);<br/><br/>                                    hmac_signed = Hex.encodeHexString(hmac.doFinal(requestVars.getBytes()));<br/><br/>                                    signature = hmac_signed.bytes.encodeBase64();<br/><br/><br/><br/>                                    // HTTP GET<br/><br/>                                    CloseableHttpClient httpinprop = HttpClients.createDefault();<br/><br/>                                    httpGet = new HttpGet(url);<br/><br/>                                    httpGet.addHeader("Authorization" , "LMv1 " + accessId + ":" + signature + ":" + epoch);<br/><br/>                                    response = httpinprop.execute(httpGet);<br/><br/>                                    responseBody = EntityUtils.toString(response.getEntity());<br/><br/>                                    code = response.getStatusLine().getStatusCode();<br/><br/>                                    datapull = new JsonSlurper().parseText(responseBody.toString());<br/><br/>                                    instanceprops =   datapull.data<br/><br/>// ***if statement to ensure that the put request only applies to current SQL instance iteration by matching the instance displayname property with the SQL instancename ***<br/><br/>                                    if ("${instanceprops.displayName}"=="${instanceName}")<br/><br/>                                    {<br/><br/>                                       // ***SQL query to find blocker data***<br/><br/>                                        outputBlocks = runQuery("""SELECT SPID, BLOCKED, REPLACE (REPLACE (T.TEXT, CHAR(10), ' '), CHAR (13), ' ' ) AS BATCH INTO #T FROM sys.sysprocesses R CROSS APPLY sys.dm_exec_sql_text(R.SQL_HANDLE) T; WITH BLOCKERS (SPID, BLOCKED, LEVEL, BATCH) AS (SELECT SPID, BLOCKED, CAST (REPLICATE ('0', 4-LEN (CAST (SPID AS VARCHAR))) + CAST (SPID AS VARCHAR) AS VARCHAR (1000)) AS LEVEL, BATCH FROM #T R WHERE (BLOCKED = 0 OR BLOCKED = SPID) AND EXISTS (SELECT * FROM #T R2 WHERE R2.BLOCKED = R.SPID AND R2.BLOCKED <> R2.SPID) UNION ALL SELECT R.SPID, R.BLOCKED, CAST (BLOCKERS.LEVEL + RIGHT (CAST ((1000 + R.SPID) AS VARCHAR (100)), 4) AS VARCHAR (1000)) AS LEVEL, R.BATCH FROM #T AS R INNER JOIN BLOCKERS ON R.BLOCKED = BLOCKERS.SPID WHERE R.BLOCKED > 0 AND R.BLOCKED <> R.SPID ) SELECT N'    ' + REPLICATE (N'|         ', LEN (LEVEL)/4 - 1) + CASE WHEN (LEN(LEVEL)/4 - 1) = 0 THEN 'HEAD -  ' ELSE '|------  ' END + CAST (SPID AS NVARCHAR (10)) + N' ' + BATCH AS BLOCKING_TREE FROM BLOCKERS ORDER BY LEVEL ASC DROP TABLE #T;""", conn.connection, debug)<br/><br/><br/><br/>                                        blockerid = "${outputBlocks.data.blocking_tree}"<br/><br/><br/><br/>                                        instanceprops.customProperties = [[name:"blockerdetails", value:"${blockerid}"]]<br/><br/>                                        instanceprops = JsonOutput.toJson(instanceprops)<br/><br/>                                        StringEntity params = new StringEntity(instanceprops,ContentType.APPLICATION_JSON)<br/><br/><br/><br/>                                        epoch = System.currentTimeMillis(); //get current time<br/><br/><br/><br/>                                        requestVars = "PUT" + epoch + instanceprops + resourcePath;<br/><br/><br/><br/>                                        hmac = Mac.getInstance("HmacSHA256");<br/><br/>                                        secret = new SecretKeySpec(accessKey.getBytes(), "HmacSHA256");<br/><br/>                                        hmac.init(secret);<br/><br/>                                        hmac_signed = Hex.encodeHexString(hmac.doFinal(requestVars.getBytes()));<br/><br/>                                        signature = hmac_signed.bytes.encodeBase64();<br/><br/><br/><br/>                                        httpPut = new HttpPut(url);<br/><br/>                                        httpPut.addHeader("Authorization" , "LMv1 " + accessId + ":" + signature + ":" + epoch);<br/><br/>                                        httpPut.setHeader("Accept", "application/json");<br/><br/>                                        httpPut.setHeader("Content-type", "application/json");<br/><br/>                                        httpPut.setEntity(params);<br/><br/>                                        responsePut = httpinprop.execute(httpPut);<br/><br/>                                        responseBodyPut = EntityUtils.toString(responsePut.getEntity());<br/><br/>                                        codePut = responsePut.getStatusLine().getStatusCode();<br/><br/><br/><br/>                                    }<br/><br/>                                       <br/><br/><br/><br/>                                    httpinprop.close()<br/><br/>                                }<br/><br/><br/><br/>                            }<br/><br/>                            else<br/><br/>                            {<br/><br/>                                for(i=0; i < instanceids.size; i++)<br/><br/>                                {<br/><br/>                                   <br/><br/>                                    resourcePath = "/device/devices/"+hostProps.get("system.deviceID")+"/devicedatasources/${datasouceid}/instances/"+instanceids<i><br/><br/>                                    url = "https://" + account + ".logicmonitor.com" + "/santaba/rest" + resourcePath;<br/><br/><br/><br/>                                    //get current time<br/><br/>                                    epoch = System.currentTimeMillis();<br/><br/><br/><br/>                                    //calculate signature<br/><br/>                                    requestVars = "GET" + epoch + resourcePath;<br/><br/><br/><br/>                                    hmac = Mac.getInstance("HmacSHA256");<br/><br/>                                    secret = new SecretKeySpec(accessKey.getBytes(), "HmacSHA256");<br/><br/>                                    hmac.init(secret);<br/><br/>                                    hmac_signed = Hex.encodeHexString(hmac.doFinal(requestVars.getBytes()));<br/><br/>                                    signature = hmac_signed.bytes.encodeBase64();<br/><br/><br/><br/>                                    // HTTP GET<br/><br/>                                    CloseableHttpClient httpinprop = HttpClients.createDefault();<br/><br/>                                    httpGet = new HttpGet(url);<br/><br/>                                    httpGet.addHeader("Authorization" , "LMv1 " + accessId + ":" + signature + ":" + epoch);<br/><br/>                                    response = httpinprop.execute(httpGet);<br/><br/>                                    responseBody = EntityUtils.toString(response.getEntity());<br/><br/>                                    code = response.getStatusLine().getStatusCode();<br/><br/>                                    datapull = new JsonSlurper().parseText(responseBody.toString());<br/><br/>                                    instanceprops =   datapull.data<br/><br/>// ***if statement to ensure that the put request only applies to current SQL instance iteration by matching the instance displayname property with the SQL instancename ***<br/><br/>                                    if ("${instanceprops.displayName}"=="${instanceName}")<br/><br/>                                    {<br/><br/>                                        blockerid = "No Blocks"<br/><br/><br/><br/>                                        instanceprops.customProperties = [[name:"blockerdetails", value:"${blockerid}"]]<br/><br/>                                        instanceprops = JsonOutput.toJson(instanceprops)<br/><br/>                                        StringEntity params = new StringEntity(instanceprops,ContentType.APPLICATION_JSON)<br/><br/><br/><br/>                                        epoch = System.currentTimeMillis(); //get current time<br/><br/><br/><br/>                                        requestVars = "PUT" + epoch + instanceprops + resourcePath;<br/><br/><br/><br/>                                        hmac = Mac.getInstance("HmacSHA256");<br/><br/>                                        secret = new SecretKeySpec(accessKey.getBytes(), "HmacSHA256");<br/><br/>                                        hmac.init(secret);<br/><br/>                                        hmac_signed = Hex.encodeHexString(hmac.doFinal(requestVars.getBytes()));<br/><br/>                                        signature = hmac_signed.bytes.encodeBase64();<br/><br/><br/><br/>                                        httpPut = new HttpPut(url);<br/><br/>                                        httpPut.addHeader("Authorization" , "LMv1 " + accessId + ":" + signature + ":" + epoch);<br/><br/>                                        httpPut.setHeader("Accept", "application/json");<br/><br/>                                        httpPut.setHeader("Content-type", "application/json");<br/><br/>                                        httpPut.setEntity(params);<br/><br/>                                        responsePut = httpinprop.execute(httpPut);<br/><br/>                                        responseBodyPut = EntityUtils.toString(responsePut.getEntity());<br/><br/>                                        codePut = responsePut.getStatusLine().getStatusCode();<br/><br/>                                    }<br/><br/>                                    httpinprop.close()<br/><br/>                                }</i></i>

Now when the collector does it’s thing it will run that SQL query and per instance, update my custom property with either the blocker details or “no blocks”.

LM User

·3 years ago

It’s as if the other collector can’t resolve the DNS name.

domenicbetters

OP3 years ago

As a follow up, this specifically seems to only be affecting our other two virtual machines in our training environment here at the office

Are those devices monitored by a different collector that might have different DNS/internet path?

hmmm they are monitored by their own collectors. I am gonna go through them both to see if anything is different or maybe I messed something up in all my previous tests and failed scriptings.

domenicbetters

OP3 years ago

Is it micoresolutions or microresolutions?

micoresolutions

LM User

·3 years ago

Is it micoresolutions or microresolutions?

LM User

·3 years ago

As a follow up, this specifically seems to only be affecting our other two virtual machines in our training environment here at the office

Are those devices monitored by a different collector that might have different DNS/internet path?

domenicbetters

OP3 years ago

So the script works great for my main test device. However the collector does keep throwing that error

“java.net.UnknownHostException: micoresolutions.logicmonitor.com”

When I run it on another device. It is still the same account info so nothing should be different about it.

As a follow up, this specifically seems to only be affecting our other two virtual machines in our training environment here at the office

domenicbetters

OP3 years ago

Testing out the final script now. Hopefully I can post the finished code after a rousing success.

domenicbetters

OP3 years ago

Gonna call it a day for now. I think tomorrow I will be able to add the last bit of magic to get this all to work.

domenicbetters

OP3 years ago

CloseableHttpClient httpinstanceid = HttpClients.createDefault();

they are defined here right below the http get comments

and thanks for the shortening!

LM User

·3 years ago

Ah, Groovy error messages. So helpful.

FYI, this:

datapull = new JsonSlurper().parseText(responseBody.toString()); datapull = datapull.data.items.id.value.toString() datapull = datapull.replace("[","") datasouceid = datapull.replace("]","")

Can be just this:

datapull = new JsonSlurper().parseText(responseBody.toString())[0]

Are you closing something that doesn’t exist?

httpdsid.close()
httpinstanceid.close()

Where are these objects defined?

domenicbetters

OP3 years ago

my latest error when i test the script on a device other than the one i usually use

The script failed, elapsed time: 0 seconds - micoresolutions.logicmonitor.comjava.net.UnknownHostException: micoresolutions.logicmonitor.com	at java.base/java.net.InetAddress$CachedAddresses.get(InetAddress.java:797)	at java.base/java.net.InetAddress.getAllByName0(InetAddress.java:1519)	at java.base/java.net.InetAddress.getAllByName(InetAddress.java:1378)	at java.base/java.net.InetAddress.getAllByName(InetAddress.java:1306)	at org.apache.http.impl.conn.SystemDefaultDnsResolver.resolve(SystemDefaultDnsResolver.java:45)	at org.apache.http.impl.conn.DefaultHttpClientConnectionOperator.connect(DefaultHttpClientConnectionOperator.java:112)	at org.apache.http.impl.conn.PoolingHttpClientConnectionManager.connect(PoolingHttpClientConnectionManager.java:376)	at org.apache.http.impl.execchain.MainClientExec.establishRoute(MainClientExec.java:393)	at org.apache.http.impl.execchain.MainClientExec.execute(MainClientExec.java:236)	at org.apache.http.impl.execchain.ProtocolExec.execute(ProtocolExec.java:186)	at org.apache.http.impl.execchain.RetryExec.execute(RetryExec.java:89)	at org.apache.http.impl.execchain.RedirectExec.execute(RedirectExec.java:110)	at org.apache.http.impl.client.InternalHttpClient.doExecute(InternalHttpClient.java:185)	at org.apache.http.impl.client.CloseableHttpClient.execute(CloseableHttpClient.java:83)	at org.apache.http.impl.client.CloseableHttpClient.execute(CloseableHttpClient.java:108)	at org.apache.http.impl.client.CloseableHttpClient.execute(CloseableHttpClient.java:56)	at org.apache.http.client.HttpClient$execute.call(Unknown Source)	at Script11.run(Script11.groovy:60)

domenicbetters

OP3 years ago

This is the whole thing so far. Possible errors still. im gonna try switching tot he debug window tester.

domenicbetters

OP3 years ago

// *** Establish API Creds ***

def accessId = hostProps.get("lmaccess.id");

def accessKey = hostProps.get("lmaccess.key");

def account = 'micoresolutions';

// *** Get Datasource ID for device as string. ***

def resourcePath = '/device/devices/'+hostProps.get("system.deviceID")+'/devicedatasources'

def url = "https://" + account + ".logicmonitor.com" + "/santaba/rest" + resourcePath;

//get current time

epoch = System.currentTimeMillis();

//calculate signature

requestVars = "GET" + epoch + resourcePath;

hmac = Mac.getInstance("HmacSHA256");

secret = new SecretKeySpec(accessKey.getBytes(), "HmacSHA256");

hmac.init(secret);

hmac_signed = Hex.encodeHexString(hmac.doFinal(requestVars.getBytes()));

signature = hmac_signed.bytes.encodeBase64();

// HTTP GET

CloseableHttpClient httpdsid = HttpClients.createDefault();

httpGet = new HttpGet(url);

URI uri = new URIBuilder(httpGet.getURI())

.addParameter("fields", "id")

.addParameter("filter", "dataSourceName:Microsoft_SQLServer_GlobalPerformance")

.build();

httpGet.setURI(uri);

httpGet.addHeader("Authorization" , "LMv1 " + accessId + ":" + signature + ":" + epoch);

response = httpdsid.execute(httpGet);

responseBody = EntityUtils.toString(response.getEntity());

code = response.getStatusLine().getStatusCode();

datapull = new JsonSlurper().parseText(responseBody.toString());

datapull = datapull.data.items.id.value.toString()

datapull = datapull.replace("[","")

datasouceid = datapull.replace("]","")

httpdsid.close()

// *** get instance ID for each instance on device ***

resourcePath = "/device/devices/"+hostProps.get("system.deviceID")+"/devicedatasources/${datasouceid}/instances"

url = "https://" + account + ".logicmonitor.com" + "/santaba/rest" + resourcePath;

//get current time

epoch = System.currentTimeMillis();

//calculate signature

requestVars = "GET" + epoch + resourcePath;

hmac = Mac.getInstance("HmacSHA256");

secret = new SecretKeySpec(accessKey.getBytes(), "HmacSHA256");

hmac.init(secret);

hmac_signed = Hex.encodeHexString(hmac.doFinal(requestVars.getBytes()));

signature = hmac_signed.bytes.encodeBase64();

// HTTP GET

CloseableHttpClient httpinstanceid = HttpClients.createDefault();

httpGet = new HttpGet(url);

httpGet.addHeader("Authorization" , "LMv1 " + accessId + ":" + signature + ":" + epoch);

response = httpinstanceid.execute(httpGet);

responseBody = EntityUtils.toString(response.getEntity());

code = response.getStatusLine().getStatusCode();

datapull = new JsonSlurper().parseText(responseBody.toString());

device = datapull.data.items.id

httpinstanceid.close()

domenicbetters

OP3 years ago

Next hiccup. I have the script built out to the point where to GETs eventually pull in the various instance IDs attached to the device. Works perfectly for one device. The other. I get another damn red text error.

Although i believe this one may just be an error in how info is cached in the test box

The script failed, elapsed time: 0 seconds - micoresolutions.logicmonitor.comjava.net.UnknownHostException: micoresolutions.logicmonitor.com	at java.base/java.net.InetAddress$CachedAddresses.get(InetAddress.java:797)	at java.base/java.net.InetAddress.getAllByName0(InetAddress.java:1519)	at java.base/java.net.InetAddress.getAllByName(InetAddress.java:1378)	at java.base/java.net.InetAddress.getAllByName(InetAddress.java:1306)	at org.apache.http.impl.conn.SystemDefaultDnsResolver.resolve(SystemDefaultDnsResolver.java:45)	at org.apache.http.impl.conn.DefaultHttpClientConnectionOperator.connect(DefaultHttpClientConnectionOperator.java:112)	at org.apache.http.impl.conn.PoolingHttpClientConnectionManager.connect(PoolingHttpClientConnectionManager.java:376)	at org.apache.http.impl.execchain.MainClientExec.establishRoute(MainClientExec.java:393)	at org.apache.http.impl.execchain.MainClientExec.execute(MainClientExec.java:236)	at org.apache.http.impl.execchain.ProtocolExec.execute(ProtocolExec.java:186)	at org.apache.http.impl.execchain.RetryExec.execute(RetryExec.java:89)	at org.apache.http.impl.execchain.RedirectExec.execute(RedirectExec.java:110)	at org.apache.http.impl.client.InternalHttpClient.doExecute(InternalHttpClient.java:185)	at org.apache.http.impl.client.CloseableHttpClient.execute(CloseableHttpClient.java:83)	at org.apache.http.impl.client.CloseableHttpClient.execute(CloseableHttpClient.java:108)	at org.apache.http.impl.client.CloseableHttpClient.execute(CloseableHttpClient.java:56)	at org.apache.http.client.HttpClient$execute.call(Unknown Source)	at Script11.run(Script11.groovy:60)

LM User

·3 years ago

Yeah, I’d love to see it.

LM User

·3 years ago

Now I’m getting an authentication failed when i add in the filter elements. Why is groovy so mean to me? LOL

It’s in Groovy’s nature. It’s why it’s not a very popular language outside very specific circles.

domenicbetters

OP3 years ago

I got it. I’m using Apache for what it’s worth to putt the request. When you make a request with parameters using it you have to use

import org.apache.http.client.utils.URIBuilder

Then Build the URI like so

URI uri = new URIBuilder(httpGet.getURI())

.addParameter("fields", "id")

.addParameter("filter", "dataSourceName:Microsoft_SQLServer_GlobalPerformance")

.build();

httpGet.setURI(uri);

I can post the whole code if you want to see.

domenicbetters

OP3 years ago

Now I’m getting an authentication failed when i add in the filter elements. Why is groovy so mean to me? LOL

LM User

·3 years ago

FWIW: i had that happen once to me last week. In the time it took me to verify the DS was indeed on that device and I came back to postman, the same request resulted in data.

LM User

·3 years ago

Be careful with that. Postman corrects errors like encoding spaces and quote marks. In groovy, you’ll need to escape the double quotes.

/device/devices/{deviceId}/devicedatasources?filter=dataSourceName:\”Microsoft_SQLServer_GlobalPerformance\”&fields=id,dataSourceName

When all else fails, output your URL after creating it in groovy to make sure it looks right.

domenicbetters

OP3 years ago

/device/devices/{deviceId}/devicedatasources?filter=dataSourceName:Microsoft_SQLServer_GlobalPerformance&fields=id,dataSourceName

Taking the quotes off of the datasource name value fixed it for me in postman. now to test in logic mon

domenicbetters

OP3 years ago

As a brief follow up. I made a clone of the datasource to see if that one would show up with this get

{{url}}/device/devices/{id}/devicedatasources/

Turns out with device “A” I did fine my clone in the list

however device “B” does not show it.

I verified both devices had the datasource in question by checking my resources tab in the UI

domenicbetters

OP3 years ago

If you’ve got postman working, you’re doing well. That’s where most people trip up.

So, you need to construct this URL to do your patch:

/device/devices/{deviceId}/devicedatasources/{hdsId}/instances/{id}

To do that, you need three variables: deviceId, hdsId, and id. Sounds like you already have deviceId.

To get hdsId (hardware datasource id, don’t ask why it’s called that, it doesn’t matter), you’ll need to do a GET on :

/device/devices/{deviceId}/devicedatasources?filter=dataSourceName:"Microsoft_SQLServer_GlobalPerformance"&fields=id,dataSourceName

The response will give you, as you’ve seen, the list of datasources on that device, but with the filter specified above, you should only get a response if there’s been an instance discovered on the device whose device ID is {deviceId}. If there’s not one there, you have chosen the id of a device that doesn’t have an instance for that datasource.

From there, you can use the id from the response (which is different for every device, yay!) to get the list of instances that you will be attempting to patch. Do a GET on:

/device/devices/{deviceId}/devicedatasources/{hdsId}/instances

The id shown in the response for each instance is the id that should go in the PATCH url.

Also, when you go to do your patch, there’s a query parameter: opType that will affect how your patch works, especially when it comes to properties. The swagger docs don’t even tell you what the possible values are much less what they do, so here it is:

Define custom properties for this device. Each property needs to have a name and a value. To add or update just one or a few device properties in the customProperties object, but not all of them, you’ll need to additionally use the opType query parameter. The opType query parameter can be set to add, refresh or replace. opType=add indicates that the properties included in the payload will be added, but all existing properties will remain the same. opType=replace indicates that the properties included in the request payload will be added if they don’t already exist, or updated if they do already exist, but all other existing properties will remain the same. opType=refresh indicates that the properties will be replaced with those included in the request payload.

So, the possible values are add, replace, and refresh.

Add - You specify the properties you want to add. Existing properties are untouched. New properties are added. If your payload has a property that already exists, that property isn’t modified.

Replace - You specify the properties you want to update. New properties are added. If your payload has a property that already exists, that property is updated to match your payload.

Refresh - This is the nuclear option which will delete all properties and replace them with the properties in your payload.

You’d probably want to do replace.

Hey there, I’m circling back to this. I wonder why When I run the get that finds the datasouce id.

This part

/device/devices/{deviceId}/devicedatasources?filter=dataSourceName:"Microsoft_SQLServer_GlobalPerformance"&fields=id,dataSourceName

I come up blank. I found the datasource ID before in a very roundabout way but i realize if I want this script to work for any device, I’ll need to automate it a little more.

When I run a get on all datasources, it’s not even listed there. Is there a logic monitor setting I need to enable to make the datasource visible to the API?

domenicbetters

OP3 years ago

I got hit with an auth failure as well. I made sure its pulling the proper id and key. I tried seeing if anything was amiss myself but im coming up blank

Also I made sure data was in json string format and not a map or object or anything else.

domenicbetters

OP3 years ago

Sure I’ll give yours a shot first. And that was the doc I saw yesterday! Thanks for finding that one.

LM User

·3 years ago

import javax.crypto.Mac<br/>import javax.crypto.spec.SecretKeySpec<br/>import org.apache.commons.codec.binary.Hex<br/><br/>def generate_headers(id, key, path, data, verb) {<br/>  // Create encryption signature for authorization request<br/>  // data should be a json string (not a map)<br/>  try {<br/>    Long epoch_time = System.currentTimeMillis()<br/>    Mac hmac = Mac.getInstance("HmacSHA256")<br/>    hmac.init(new SecretKeySpec(key.getBytes(), "HmacSHA256"))<br/>    signature = Hex.encodeHexString(hmac.doFinal("${verb}${epoch_time}${data}${path}".getBytes())).bytes.encodeBase64()<br/>    return ["Authorization": "LMv1 $id:$signature:$epoch_time", "Content-Type": "application/json"]<br/>  } catch (Exception err) {println("ERROR: Unable to establish encryption for $path.\n${err.message}")}<br/>}

I think this works. When I tested it with the wrong verb, i got a 401 (auth fail). When i tested it with the right verb, i got a 403 (permission denied) (because the api creds i used are RO). I think that means i did get authenticated, but my creds don’t have permission. I did finally find this, which would probably work too; but do me a favor and see if the function above works.

domenicbetters

OP3 years ago

Lol. Have you ever generated the auth signature in groovy before. I see lots of examples in other languages and that post about generating it using postman but nothing so much in groovy. Although I could have sworn I saw one yesterday but for the life of me, I can’t find it now.

LM User

·3 years ago

Good thinking. In the mean time I’m gonna take a step back and figure out getting a proper auth signature in my script so i dont need to just copy and paste for testing. It will need to be done regardless so while I wait for a response from them ill tackle this

If your experience with the chat queue is like mine, you’ll have an hour or so to get it working while you’re waiting. How else would I have the time to be on the community as much as I am?

https://tenor.com/view/seriously-really-little-girl-gif-14394090

domenicbetters

OP3 years ago

Good thinking. In the mean time I’m gonna take a step back and figure out getting a proper auth signature in my script so i dont need to just copy and paste for testing. It will need to be done regardless so while I wait for a response from them ill tackle this

LM User

·3 years ago

Remember, the http client object is part of the santaba library (LM code), so IMO should be supported by LM. I’d push them in chat for help getting it working.

domenicbetters

OP3 years ago

I think groovy just doesn’t like patch at all. I’m gonna try figuring out a way instead to make put work.

LM User

·3 years ago

Well, your payload needs adjusting. Needs to be a list of maps:

def payload = [[name:"description", value:"New York"]]

This is what the .patch() method got as its arguments:

(org.codehaus.groovy.runtime.GStringImpl, groovy.json.internal.LazyMap, java.util.LinkedHashMap)

It would seem that the second argument (which is your payload?) is a LazyMap but needs to be json. The error message gives a ton of useless information, but doesn’t get far enough to tell you what type of object needs to be passed in as the payload. I’m guessing string. Here’s how you convert an array/map to json:

import groovy.json.*<br/>payload = [["name": "description", "value": "New York"]]<br/>jsonPayload = JsonOutput.toJson(payload)<br/>println(jsonPayload.getClass())

domenicbetters

OP3 years ago

def payload = [name: "description", value: "New York"]

I believe I tried using a map, assuming this is the correct way to do so. Same result sadly.

Appreciate all the help btw.

LM User

·3 years ago

I can’t remember what type of object should be passed in with the patch, but it seems like it wants a map. Try not converting it to json first.

domenicbetters

OP3 years ago

These are obviously the JSON equivalents of the Groovy map you might be using to construct the json.

Maybe that’s my hang up. I’ve tried every which way of json and groovy mapping i can think of and i still get this error

The script failed, elapsed time: 0 seconds - No signature of method: com.santaba.agent.groovyapi.http.Client.patch() is applicable for argument types: (org.codehaus.groovy.runtime.GStringImpl, groovy.json.internal.LazyMap, java.util.LinkedHashMap) values: [https://micoresolutions.logicmonitor.com/santaba/rest/device/devices/26/devicedatasources/3065/instances/69893279?patchFields=description&opType=replace, ...]Possible solutions: wait(), any(), each(groovy.lang.Closure)groovy.lang.MissingMethodException: No signature of method: com.santaba.agent.groovyapi.http.Client.patch() is applicable for argument types: (org.codehaus.groovy.runtime.GStringImpl, groovy.json.internal.LazyMap, java.util.LinkedHashMap) values: [https://micoresolutions.logicmonitor.com/santaba/rest/device/devices/26/devicedatasources/3065/instances/69893279?patchFields=description&opType=replace, ...]Possible solutions: wait(), any(), each(groovy.lang.Closure)	at org.codehaus.groovy.runtime.ScriptBytecodeAdapter.unwrap(ScriptBytecodeAdapter.java:71)	at org.codehaus.groovy.runtime.callsite.PojoMetaClassSite.call(PojoMetaClassSite.java:48)	at org.codehaus.groovy.runtime.callsite.CallSiteArray.defaultCall(CallSiteArray.java:47)	at org.codehaus.groovy.runtime.callsite.AbstractCallSite.call(AbstractCallSite.java:116)	at org.codehaus.groovy.runtime.callsite.AbstractCallSite.call(AbstractCallSite.java:144)	at Script190.run(Script190.groovy:25)

LM User

·3 years ago

FWIW: I just had a similar boneheaded moment with LM Support. I had an LM Logs pipeline alert setup, but it wasn’t triggering the alert because I had left it disabled.

Aaaaanyway, the body would simply be the stuff you want to update. Doing a PATCH to:

{{url}}/device/devices/:deviceid/devicedatasources/:hdsid/instances/:instanceid?opType=replace

The colons in my url are for Postman path variables. If you put the above URL in your postman, you should see it pop some additional fields into your Params tab. You can then put in the IDs without changing your url.

With a body like this:

{<br/>    "customProperties": [{"name": "test.property", "value": "testvalue"}]<br/>}

I was able to patch my instance. If you wanted multiple properties patched:

{<br/>    "customProperties": [<br/>        {"name": "test.property", "value": "testvalue"},<br/>        {"name": "test.property2", "value": "testvalue2"}<br/>    ]<br/>}

These are obviously the JSON equivalents of the Groovy map you might be using to construct the json.

domenicbetters

OP3 years ago

Can I pick your brain then on the proper syntax for the payload / body i would use for patching

LM User

·3 years ago

Well now i feel dumb. it was simple as dropping the ‘’

Don’t beat yourself up. Your mind was obviously working on the more difficult problems that you’ve still to surmount.

domenicbetters

OP3 years ago

Well now i feel dumb. it was simple as dropping the ‘’

LM User

·3 years ago

Yeah, that creates a string. In your working example, you create a map, not a string. Remove the single quotes from around the headers when you define it.

domenicbetters

OP3 years ago

def headers = ‘["Authorization": "LMv1 PHf4xEdZHA5sz8U5ECM8:NzJjNzMzZDkyZjdmMDY0MWYwMWUwZmU3Nzc1ZDUzZjIwY2I3OWEyZGU3NGU5MmE1YzhiNWM3NTA5NDViZmFhZA==:1684428033047","Content-Type":"application/json"]’

LM User

·3 years ago

Ah, ok good. Show me how you’re defining the headers variable?

domenicbetters

OP3 years ago

I made sure it wasn’t expired. Like i said when i just hard code the header i get a success. but when i try to put the same info into a variable and use it I get

The script failed, elapsed time: 0 seconds - No signature of method: com.santaba.agent.groovyapi.http.Client.get() is applicable for argument types:

I do understand that yea this method won’t work long term either way for that very reason. I’m just taking this one small step at a time so I know what I’m doing is working every step of the way if that makes sense

when the auth does expire i get an auth error within my test. not from the script itself

LM User

·3 years ago

Because your auth token from Postman expired. The pre-request script that you have in postman has to be built in groovy so that your signature is generated at runtime. AFAIK, authenticating using jsessionid will not work because those sessions also timeout.

No doubt, this would be easier in python, but you have to use groovy because you’re trying to expand the functionality of an existing groovy script. So, groovy is the right way to go.

domenicbetters

OP3 years ago

So I began trying to port over what I have done with postman into my groovy script. (I know you said you had much better success using python, but I still wanna give it a try first)

Interesting note. I was able to successfully make a get request using this line.

def http_body = httpClient.get(endpoint_url, ['Authorization': ‘{{the authtoken copied from postman','Content-Type': 'application/json','Cookie':'JSESSIONID=17513E3CB1FC4E623F829A629A16B811'] );

now when i try to take everything in those square brackets for the header and put them into a variable and use them the same way

def http_body = httpClient.get(endpoint_url, headers);

i get an error. interesting.

domenicbetters

OP3 years ago

Thanks for the heads up about replace vs. refresh. I was using refresh but I’ll switch it