Skip to content

Groups


Overview

CloudAEye SaaS uses few grouping constructs. This topic describes these groups and their intended use-cases.

Service Groups

Service Groups helps user associate a group of services that are supporting the same application environment. For example, to support a microservices style application running on a Kubernetes cluster, user may create the following services:

CloudAEye Architecture

  • Logs Service for centralized logging, parsing logs and viewing logs using Kibana
  • Metrics Service for centralized metrics,
  • Logs Analyzer for realtime log analysis and anomaly detection,
  • Metrics Analyzer for realtime metrics/KPI analysis, anomaly detection and root-cause analysis,
  • Dashboards/Grafana Service to view both metrics and logs data in dashboards,
  • Notifications to setup notification delivery using email and SMS

Automatic Wiring

Service Groups makes it convenient to associate all the services that belongs together for optimal automatic wiring between services. For example, Grafana is wired to recognize logs and metrics services as data sources. Logs Analyzer is wired to the logs and metrics services. Metrics Analyzer automatically connects to metrics services. Notifications has default configuration that automatically sends notifications to tenant administrators and the service administrators for a group.

Task Command Name
List all service groups caeops service-groups list
Create a service group caeops service-groups create
Get details of a service group caeops service-groups get
List all services for a service group caeops service-groups list-services
Add logs service to a group caeops logs add-to-group
Remove logs service from a group caeops logs remove-from-group
Add metrics service to a group caeops metrics add-to-group
Remove metrics service from a group caeops metrics remove-from-group

CLI Examples

Create a Service Group

Select Services > Service Groups from the left navigation. A list of all available Service Groups will be shown.

To create a new Service Group, click on CREATE button on the top right corner. A new form will appear. Enter the following information:

  • Name - Name of the Service Group.
  • Description - A short description for the Service Group.
  • Logs service - Select the logs service from the drop-down menu that will be associated with this group. This step can be performd later if the logs service is not created yet.
  • Metrics service - Select the metrics service from the drop-down menu that will be associated with this group. This step can be performed later if the metrics service is not created yet.

Click SUBMIT to create the Service Group.

caeops service-groups create --group-name demo-grp

Output:
{
  "groupName": "demo-grp",
  "description": "",
  "createdAt": 1629907186607,
  "updatedAt": 1629907186607
}
List Service Groups

Select Services > Service Groups from the left navigation. A list of all available Service Groups will be shown. The table may be empty if there are no Service Groups in the system.

caeops service-groups list

Output: 
[
  {
    "groupName": "demo-grp",
    "description": "",
    "createdAt": 1629526059548,
    "updatedAt": 1629526059548
  },
  {
    "groupName": "demo-grp1",
    "description": "",
    "createdAt": 1629641073459,
    "updatedAt": 1629641073459
  }
]
Attach a Logs Service to a Group

To see list of already created logs services, select Services > Logs from the left navigation. You will see a list of logs services that are already created.

To see details of a specific logs service, click on the name of the logs service under Service Name column. A new page will appear under Logs > <Name-of-logs-service>.

On the top right side section, the following information is shown:

  • Group name: This is the name of the Service Group associated with the logs service. If no Service Group is associated with the logs service, select the desired group from the drop-down menu.

If the logs service is already assocaited with a Service Group, changing that may cause problems. You must delete the Logs Analyzer associated with this logs service before making a change to the Service Group.

caeops logs add-to-group --name demo-logs-service --group-name demo-grp

Output:
{
    "serviceName": "demo-logs-service",
    "serviceRegion": "us-east-2",
    "serviceEndpoint": "https://demo-logs-service-km4s7fd5kydgbhfcug43nygbuq.us-east-2.es.amazonaws.com",
    "serviceType": "logs-service",
    "groupName": "demo-grp",
    "labels": {},
    "createdAt": 1629641060239,
    "updatedAt": 1629643171344
}
Attach a Metrics Service to a Group

To see list of already created metrics services, select Services > Metrics from the left navigation. You will see a list of metrics services that are already created in the system.

To see details of a specific metrics service, click on the name of the metrics service under Service Name column. A new page will appear under Metrics > <Name-of-metrics-service>.

On the top right side section, the following information is shown:

  • Group name: This is the name of the Service Group associated with the metrics service. If no Service Group is associated with the metrics service, select the desired group from the drop-down menu.

If the metrics service is already assocaited with a Service Group, changing that may cause problems. You must delete the Logs Analyzer and Metrics Analyzer associated with this metrics service before making a change to the Service Group.

caeops metrics add-to-group --name demo-metrics-service --group-name demo-grp

Output: 
{
    "serviceName": "demo-metrics-service",
    "serviceRegion": "us-east-2",
    "serviceEndpoint": "https://aps-workspaces.us-east-2.amazonaws.com/workspaces/ws-81425125-1049-438c-9d4e-372ba3128f3f",
    "serviceType": "metrics-service",
    "groupName": "demo-grp",
    "labels": {},
    "createdAt": 1629726914026,
    "updatedAt": 1629726914026
}
List Services under a Group

To see list of already created Service Groups, select Services > Service Groups from the left navigation. You will see a list of Service Groups that are already created in the system.

To see details of a specific Service Group, click on the name of the service group under Group Name column. A new page will appear under Service Groups > <Name-of-service-group>.

Under 'Services in the group' section, all services associated with this group is shown. If there are no services in the group, the table will be empty.

caeops service-groups list-services --group-name demo-grp

Output: 
[
  {
    "serviceName": "demo-logs-service",
    "serviceRegion": "us-east-2",
    "serviceEndpoint": "https://demo-logs-service-km4s7fd5kydgbhfcug43nygbuq.us-east-2.es.amazonaws.com",
    "serviceType": "logs-service",
    "groupName": "demo-grp",
    "labels": {},
    "createdAt": 1629641060239,
    "updatedAt": 1629643171344
  },
  {
    "serviceName": "demo-metrics-service",
    "serviceRegion": "us-east-2",
    "serviceEndpoint": "https://aps-workspaces.us-east-2.amazonaws.com/workspaces/ws-81425125-1049-438c-9d4e-372ba3128f3f",
    "serviceType": "metrics-service",
    "groupName": "demo-grp",
    "labels": {},
    "createdAt": 1629726914026,
    "updatedAt": 1629726914026
  }
]

Labels

Labels are key/value pairs that are attached to a service. Labels provide a flexible mechanism to identify attributes of a service that is meaningful to users. One may add labels during creation time of a service or at a later point using the following commands.

Task Command Name
Add labels during creation of a logs service caeops logs create --labels <value>
Add labels to a logs service caeops logs add-labels
Get labels for a logs service caeops logs get-labels
Delete labels for a logs service caeops logs delete-labels
Add labels during creation of a metrics service caeops metrics create --labels <value>
Add labels to a metrics service caeops metrics add-labels
Get labels for a metrics service caeops metrics get-labels
Delete labels for a metrics service caeops metrics delete-labels

User Groups

CloudAEye SaaS grouped privileges in 3 broad categories for convenience:

  • Root administrator for the account
  • Administrators of the services
  • Users of the services

A user group is a collection of users who shares the same privileges. Refer to the Groups section of User Management for a list of available groups created out-of-the-box. By adding a user to a specific group, the user is assigned the privileges from that group. For example, all users in the LogsServiceAdminGroup are assigned administrative privileges for logs service.