Cloudera Docs

Specifying Role and Service types

The Role Type and Service Type lists expect the usual all-caps strings (identifiers) to identify role and service types used in most other places throughout Cloudera Manager. For example, OZONE_PROMETHEUS is a role type, and OZONE is a service type. List elements are separated by the comma character.

Minimum Required Role: Limited Cluster Administrator (also provided by Full Administrator and Cluster Administrator)

Use case examples for Role or Service lists

These lists are applicable in use cases such as routing alerts to the appropriate teams based on their expertise:
  • MGMT (Cloudera Management Service) alerts: Route to personnel experienced in operating Cloudera Manager.
  • OZONE_PROMETHEUS alerts: Route to monitoring-focused teams.
  • OZONE and HDFS alerts: Route to storage experts.
  • KAFKA alerts: Route to Kafka Subject Matter Experts (SMEs). (This use case is also mentioned in the Sample Custom Alert Script).
  • RANGER alerts: Route to teams concerned with security.

Finding exact Role and Service type values

To find the exact possible all-caps strings (identifiers) to use for Role Types and Service Types, you can perform any of the following actions within Cloudera Manager:

  1. Using the Diagnostics filter
    1. Go to Diagnostics > Events.
    2. Click Add a filter.
    3. Select Role Type (or Service Type) from the Content drop-down list, and select the != (not equal to) relation.
      The value field becomes a drop-down list of the possible identifiers.
  2. Inspecting existing Events
    1. On Diagnostics > Events page, find an event related to the Role Type or Service Type of interest.
    2. The ROLE_TYPE and SERVICE_TYPE attributes reveal the strings to use.
  3. Using the Cloudera Manager API
    1. Request the list of roles or services through the Cloudera Manager API:
      • For Roles: GET /clusters/{clusterName}/services/{serviceName}/roles
      • For Services: GET /clusters/{clusterName}/services
    2. The type field of each item contains the appropriate identifier.
  4. Inspecting Chart Stream Attributes
    1. On any chart of a Role Type or Service Type of interest, click on a data point.
    2. The Role Type and Service Type stream attributes contain the required strings.
  5. Using Chart Builder type-ahead
    1. Use the type-ahead feature in Chart Builder (see Building a Chart with Time-Series Data) to explore possible values of the attributes mentioned above.
      For example, enter SELECT * WHERE serviceType = into the query field, and start typing to get suggestions.