Citrix Cloud Monitoring


Userlevel 3

Installation

  1. 1. Install the package from LM Exchange "Citrix Cloud"
  2. 2. Install Cloud Connector property source: Locator JYW9D7

Configuration

This datasource requires several properties to be set:

  1. CITRIX.CLOUD.CUSTOMER
      - This is found in the Citrix Cloud Portal: Identity and Access Management > API Access > Secure Clients. Copy the bolded customer ID on the page.
  2. CITRIX.CLOUD.ID
  3.   - Create a secure client, you can name it "LogicMonitor". The ID here will be used for this property.
    CITRIX.CLOUD.PASS
  4.   - This is the secret when you created the secure client.
    CITRIXCLOUD.OAUTH.KEY
  5.   - This will be autogenerated and populated by LogicMonitor using the above credentials. There is a Citrix Cloud OAuth datasource that will generate a bearer token and save it as a property on the device.
    LM.API.ID
  6.   - Create an API token in LogicMonitor with administrator privileges, copy the Access ID.
    LM.API.KEY
  7.   - This is the API token access key that was created above.
    LM.API.ACCOUNT
  8.   - This is your LogicMonitor account name, you can probably copy the subdomain of your LM portal. https://yourco.logicmonitor.com

1. Set the properties above (except CITRIXCLOUD.OAUTH.KEY) wherever you'd like depending on your folder structure. I like to set the LM API properties at the root and the Citrix Cloud properties per client (folder).
2. Find your cloud connector device in LM and add the category "PrimaryCC". Make sure you have the Cloud Connector property source installed as well!
3. The OAuth datasource should run, generating a token that the other datasources will use to query Citrix Cloud's API. You can also do a manual "poll now" to speed up the process. You should now see the CITRIXCLOUD.OAUTH.KEY property on the device.

If you have any issues, feel free to private message me!


43 replies

Hi,

Thanks so much for this awesome data source. I'm aware that Citrix is changing the API's for the Cloud monitoring in July and I believe these data sources will be affected. 

Do you happen to be working on any updates to support the new method?

Thanks!

Userlevel 3
11 minutes ago, Brian Wagner said:

Hi,

Thanks so much for this awesome data source. I'm aware that Citrix is changing the API's for the Cloud monitoring in July and I believe these data sources will be affected. 

Do you happen to be working on any updates to support the new method?

Thanks!

I wasn't aware of any API changes. Do you have a link?

It was on my Citrix Cloud logon for the last few months. Of course now it seems to have disappeared. Wondering if they decided to hold off. 

At a high level things were moving from customer.xendesktop.net to https://api-us.cloud.com/monitorodata with different references. I see mention of it all here:

Accessing Monitor Service Data in Citrix Cloud

  • The "https://{Customer_Id}.xendesktop.net/Citrix/monitor/odata/v4/data" URL is replaced with "https://{ApiGatewayEndpoint}". The HTTP header "Customer" is now replaced with "Citrix-CustomerId".

 

Complete speculation here, but Citrix may be one of the new SaaS monitored apps. SaaS monitored apps can be monitored via the cloud collector instead of running from an on-prem collector in your environment. Go to the exchange and look for the "Cloud Integrations" tab. If you don't have it, reach out to your CSM.

Userlevel 3
22 minutes ago, Stuart Weenig said:

Complete speculation here, but Citrix may be one of the new SaaS monitored apps. SaaS monitored apps can be monitored via the cloud collector instead of running from an on-prem collector in your environment. Go to the exchange and look for the "Cloud Integrations" tab. If you don't have it, reach out to your CSM.


Thanks! I have access to the Cloud Integrations tab but don't see Citrix as an option. I will reach out to my CSM.

Cool. The CSM will help direct questions to product management who can give insight into how Citrix monitoring is being planned/changed.

Stuart, can you confirm if the cloud collector situation to which you are referring to is on the roadmap?

Thanks man.

I really can't speak to the roadmap, mainly because I don't have good visibility into it. Our SaaS monitoring is GA if that's what you're asking about.

PM sent GJon!  

Hey GJon, does this still work?

Hi All,

Would love to get this script working, added all the api elements but still getting this error:

Does the groovy script need updated to reflect any Change to API from Citrix side?

Has anyone out there still got this working?

Cheers

Jav

 

@Gjon Thanks for the datasource. I am trying to test this but I am unable to download the cloud Connector property source (JYW9D7). Are you able to provide this ?

 

On 3/18/2021 at 3:47 AM, Gjon said:

Find your cloud connector device in LM and add the category "PrimaryCC". Make sure you have the Cloud Connector property source installed as well!

Also in your post what device we should be using? Can we use a collector ?

Let me know

 

Thanks

Userlevel 5
Badge +5

Bumping this again...

Where can we find the property source for the cloud connector 'Locator JYW9D7'? @Gjon can you advise? I'm no longer able to search using the locator code on our portal.
I see another used asked for this a few months ago but no further comments after it.

@Stuart Weenig / @Michael Rodrigues is there any other alternative to find custom modules on exchange? Since the locator code prompt no longer appears & we're directly redirected to exchange.

Already reached out to our CSM as well to confirm if there's any ETA for this cloud integration.

Userlevel 1
Badge

Also jumping back onto this!

I have managed to get the datasource setup and was working perfectly, but recently i have noticed that within the 'Citrix Cloud Machines' Datasource multiple machines are missing from the list. I have recreated the accounts ect but still seeing the same machines.

Has anyone else had this issue, or is this a configuration within Citrix Cloud? Any help would be great!

Thanks

Userlevel 5
Badge +5

Hey James,

Is it actually grabbing data currently (if you test the AD for example)? I've noticed that from those DS we need to change some code (due to API changes) - as mentioned by Brian Wagner in this thread...

This is what I've changed on ours:

 here using the 'api-eu' endpoint as an example.



From there it should work... if you did this already, disregard my message :)

Userlevel 1
Badge

Hi,

It is currently collecting data, but the citrix cloud machines DS is missing around 30 devices. AD is working for the devices but the missing ones are been filtered out as deleted (when on citrix cloud they are not deleted and are in production)

 

I have not made any changes but the groovy scripts for Active discovery is currently set to the below which does not match yours :/ 

Collector Attributes Groovy Script

 

 

Thanks,
James

1 hour ago, Vitor Santos said:

Hey James,

Is it actually grabbing data currently (if you test the AD for example)? I've noticed that from those DS we need to change some code (due to API changes) - as mentioned by Brian Wagner in this thread...

This is what I've changed on ours:

 here using the 'api-eu' endpoint as an example.



From there it should work... if you did this already, disregard my message :)

 

Userlevel 1
Badge

It seems the API Reference im after is the below, but after i tied this now getting issues using the AD

http://{ApiGatewayEndpoint}/Machines 

Any help would be greatly apricated! 

Thanks

James

Userlevel 1
Badge

Hi together, i have a question as we are moving to Citrix Cloud too. I can´t find the Citrix Cloud in the Exchange from LM anymore?! Is that correct?

I just found it in the public repo. Check your filters?

Userlevel 1
Badge
On 4/12/2022 at 9:00 PM, Stuart Weenig said:

I just found it in the public repo. Check your filters?

Hi Stuart firtst thanks for your reply. This is what i can find?! Why do i don´t see it?

It looks like you've got a filter on the Status field.

Userlevel 1
Badge

?wow just open the eyes ? Found it and give it a try

Userlevel 1
Badge

Ok - i got it working that i get some data from the Cloud now. I still see some issues with the machine Catalog informations. I changed the script code to get the new datasource setup.

But when i Poll the Data i get following Warning and no data back. Does anyone had the same?

I'd run that script in the Collector debug console and add some println statements to see what you actually are getting back. My guess is that your response is null, so some command after that is failing because it's not got the ability to fail gracefully on an empty response.

Userlevel 1
Badge

Hello guys, is someone familary with the groovyscripts?! I am looking into to pulling the license usage information? I have already the API request.

I thought it would be easiest to modify for example the code for the Citrix_Cloud_DeliveryGroups, but i am not really into the scripting language.

This is the output. I would like take each value and put display it then the Values beyond it.

Any suggestions?

{
    "currentCcu": {
        "reportTime""xxxxx",
        "assignedLicenseCount"xx,
        "totalLicenseCount"xyz
    },
    "last24HoursPeak": {
        "reportTime""xxxx",
        "assignedLicenseCount"xx,
        "totalLicenseCount"xyz
    },
    "monthPeak": {
        "reportTime""xxxx",
        "assignedLicenseCount": xx,
        "totalLicenseCount"xyz
    },
    "allTimePeak": {
        "reportTime""xxxxx",
        "assignedLicenseCount"xx,
        "totalLicenseCount": xyz
    }
}

Reply