Working with the Analytics Group API

[#1]

Our team is attempting to configure an on-prem Apigee Edge installation. We are working through the steps provided by Apigee Professional Services for configuring Analytics in an Active/Active fashion. During these steps, we're asked to modify the configuration of the analytics group axgroup001. I was wondering if there is any good documentation on the management API for this group. Specifically, the apis from /v1/analytics/groups/ax/axgroup001/.

My current struggle is removing postgres datastores from a consumer-group.

[adas]

@Steven Wolfe I need to check if there's any public facing documentation for the AX Group APIs. But there's what I have. I will check with our doc guys, if there's any way we can make this publicly available at least for the on-premise customers:

-List all groups
curl -v -u admin:secret  "http://${mgmt}:8080/v1/analytics/groups/ax"

-List given group 
curl -v -u admin:secret  "http://${mgmt}:8080/v1/analytics/groups/ax/axgroup1"

-List all groups of a type filtered by a scope.
curl -v -u admin:secret  "http://${mgmt}:8080/v1/analytics/groups/ax?org=t23&env=qa"

-List all groups of a type filtered by a server.
curl -v -u admin:secret  "http://${mgmt}/v1/analytics/groups/ax?serverType=postgres-server&server=70ce6aa5-abf6-41f3-a0db-4316fdd136e9"

Add/RemoveServer/Group

-Add a newgroup
curl -v -u admin:secret -X POST "http://$mgmt:8080/v1/analytics/groups/ax/group_10"

-Addnew server to an existing group
curl -v -u admin:secret -X POST  -H'Accept:application/json'-H'Content-Type:application/json'"http://${mgmt}:8080/v1///group_10/servers?uuid=${pg_uuid}&type={serverType}"

-Addnew scope to an existing group
curl -v -u admin:secret -X POST "http://${mgmt}:8080/v1/analytics/groups/ax/axgroup6/scopes?org=Org&env=Env"

-AddMaster-Slave to a group
curl -v -u admin:secret -X POST "http://${mgmt}:8080/v1/analytics/groups/ax/axgroup2/servers?uuid=70ce6aa5-abf6-41f3-a0db-4316fdd136e9,d6621be0-6cf7-4888-99f5-9f8e1732e1ff&type=postgres-server"

-RemoveScope 
curl -v -u admin:secret -X DELETE "http://${mgmt}:8080/v1/analytics/groups/ax/axgroup6/scopes?org=Org&env=Env"

-RemoveServer
curl -v -X DELETE 
"http://${mgmt}:8080/v1/analytics/groups/ax/axgroup2/servers?uuid=d6621be0-6cf7-4888-99f5-9f8e1732e1ff&type=postgres-server"

Add properties to group

-Add a new meta name/value pair
curl -v -u admin:secret -X POST "http://${mgmt}:8080//v1/analytics/groups/ax/{groupName}/properties?propName={name}∝Value={value}"

Remove properties to group

-Remove meta name/value pair
curl -v -u admin:secret -X DELETE "http://${mgmt}:8080//v1/analytics/groups/ax/{groupName}/properties?propName={name}"

Hope this helps.

@sgilson Do you think we can make the above calls available to the private cloud customers in the doc ?

[sgilson]

@arghya das I'll work with the Private Cloud team. This is part of a larger effort to update the doc for an Active/Active configuration.

Stephen

[#4]

Hi

Is there any documentation in regards to Analytic group ? Do we need to have multiple Analytic group when we are building multi-az infrastructure?

e.g. AZ 1 -> axgroup1 and AZ 2 -> axgroup2

Thanks,

Reza

[#5]

Hi Reza - as an Apigee customer, I have not seen any official documentation on the analytics group. Our team configured our PostGres/QPID servers in an Active/Active fashion. That way, we would not require manual intervention in the event an AZ was down. For this configuration, we created a second analytics group (axgroup002). Apigee professional services provided us with documentation on how to accomplish this. You might want to reach out to them for your particular use case.