Driven User Guide: Configuring Teams for Collaboration

version 2.2.6

Driven User Guide: Configuring Teams for Collaboration

1. Overview of Monitored Applications: 1.1. Logging In

1.2. Status Views
2. Searches, Saved Views, and Accessing Relevant Data: 2.1. Starting a Search

2.2. Saving Search Queries as Views

2.3. My Teams Views

2.4. Case Examples of Searches, Views, and Teams

2.5. Customizing Searches

2.6. Periodic Views

2.7. Counter Data and Other Metrics in Tables

2.8. Sharing and Limiting Access to Application Information
3. Using the App Details Page: 3.1. Searching App Details

3.2. Viewing Application Details

3.3. Understanding the Directed Acyclic Graph

3.4. Viewing the Graph

3.5. Real-Time Visibility into Your Application

3.6. Details Table
4. Understanding the Unit of Work Details Page: 4.1. Viewing Unit-of-Work Details

4.2. The Directed Acyclic Graph

4.3. Step Table and Slice Histograms

4.4. Viewing the Hadoop Dashboard
5. Managing Applications with Tags: 5.1. Best Practice for Tags

5.2. Assigning Tags as Application-Level Properties

5.3. Assigning Tags in the Driven Plugin Configuration File

5.4. Using Tags in a Search Query

5.5. Finding Tagged Applications with the Column Chooser
6. Configuring Teams for Collaboration: 6.1. Creating and Managing Teams

6.2. Team Details

6.3. Associating an Application with a Team
7. Using Annotations: 7.1. Creating Custom Annotations

7.2. Data Visibility
8. Execute Hive Queries as Cascading HiveFlow: 8.1. Using HiveFlow

8.2. Driven for HiveFlow
9. Execute Cascading MapReduce Flows
10. User Profile: 10.1. User Actions

10.2. User Credentials

10.3. User Statistics

10.4. Invitations

10.5. Teams

Configuring Teams for Collaboration

Applications are not deployed and monitored in isolation. Usually, application development is a collaboration between the IT administrators and developers, engineering, business analysts, and other data scientists. When applications become operational, it becomes vital to create collaboration to investigate job behavior and observe characteristics. Organizing application execution data by groups of stakeholders can help you and your colleagues focus on metrics that you are targeting.

On the other hand, most organizations want to categorize and restrict viewing of application metrics for governance, regulatory compliance, developing models for chargebacks, or other reasons. For example, in a bank you may have the Hadoop production cluster as a single enterprise capability, shared between different lines of businesses such as marketing, fraud, operational risk, and across organizations in different geographies. The bank runs many applications that contain confidential data. In this scenario, it is possible that information about the xyz application should be revealed only to the fraud and operational risk business units because the xyz application processes confidential data that needs to be monitored by these units.

Using teams, you can both share and restrict views of specific application metrics. In Driven a team is associated with an API key. For any application using the API key, the data from the application is visible only to users who are team members and to Driven administrators. As a result, when a team member saves a status or application view with programmed API keys, the view is accessible to other team members and the Driven administrator.

Tip

For the sake of comparing multiple applications that are restricted by teams, you might need a user with administrator privileges to perform this analysis efficiently, or to configure the discoverability and visibility settings on those teams. For more information, see Application Execution Detail Access

Access a team view by clicking Teams from the header and selecting one of the links that appear in that section. Alternatively, hover over Teams and select a team from the drop-down menu.

Figure 1. Accessing a team view

By default, a user who creates a team is the team leader. However, the default team leader can transfer the role to another user on the team. Team leaders can also invite users to join the team, remove users, and delete the team altogether.

Creating and Managing Teams

The following procedure permits users who are not logged in to Driven as an administrator to create a team and assign existing user accounts to the team. See Using the Driven Admin Console in the Driven Administrator Guide for more information about administrator configuration of teams and users.

Create a Team

Perform the following tasks to create a team:

Figure 2. Link to Teams page

Click Teams in the Global Navigation.
Click the Create Team button in the Teams table.
Enter a name for your team. The newly created team will appear in the Teams table. By default you will become Team Leader of your newly created team.
Record or copy the API key that appears next to the newly created team. You need this to configure the Driven Plugin to display application run data to Driven users who belong to the team with the API key.

Team Details

In the Teams table, click on the team name of the team you wish to view the details of. If you are a Driven Admin or are the Team Leader of the team you are viewing, you have options to configure the different aspects of the team. As a regular team member, the information is read only.

Figure 3. Team details page

Team Info
Application Execution Detail Access
Members
Invitations
External Issue Tracking
Webhook Connections and Email Notifications
Messaging Rules

The team details page is the place where you can manage other aspects of the team, such as deleting a team from Driven.

Team Info

Figure 4. Team Information

If you are are a Driven Admin or the Team Leader, you can click on the Edit Team Name, Change Leader, and Delete Team buttons to perform their respective operations.

Figure 5. Edit Team Name

Figure 6. Change Team Leader

Figure 7. Delete Team

Application Execution Detail Access

The Discoverability setting determines who can see this team’s apps in search results. The Visibility setting determines who has access to view this team’s applications' details.

Figure 8. Application Execution Detail Access

Figure 9. Discoverability

Members

These are all of the members of the team. If you are a Driven Admin or are Team Leader, you can add Driven users directly to the team, or remove members from the team.

Figure 10. Team Members

To add members to the team, click the Add Member(s) button in the Members table. Choose the user(s) you would like add to the team, and click the Submit button.

Figure 11. Add Member to the Team

To remove members from the team, choose the member(s) you would like to remove, and click the Remove Member(s) button in the Members table. You will be prompted to confirm that you would like to remove the selected members. Click the Remove button to proceed.

Figure 12. Choose Members to Remove

Figure 13. Confirm Members to Remove

Invitations

Driven Admins and members of the team can invite other users to the team.

Figure 14. Team Invitations

If SMTP AND Users Account Lookup are enabled: To Invite a Driven user, click the Invite To Team button in the Invitations table. Search for and/or choose which users you would like to invite, and Driven will send them invitation email and an invitation within Driven. If you cannot find the user you are looking for, but know their email address, enter it in the input field below the table and click the plus button to include them.

Figure 15. Invitations if SMTP and User Account Lookup are both enabled

If SMTP is enabled AND User Account Lookup is disabled: To Invite a Driven user, click the Invite To Team button in the Invitations table. Enter the email address or username of the user you would like to invite, and Driven will send them invitation email.

team details invitations smpt yes account lookup no

Figure 16. Invitations if SMTP is enabled, but User Account Lookup is disabled

If SMTP is disabled AND User Account Lookup is enabled: To Invite a Driven user, click the Invite To Team button in the Invitations table. Search for and/or choose which users you would like to invite, and Driven will send them invitation within the Driven application.

team details invitations smpt no account lookup yes

Figure 17. Invitations if SMTP is disabled, but User Account Lookup is enabled

If SMTP AND User Account Lookup are disabled: To Invite a Driven user, click the Invite To Team button in the Invitations table. Enter the email address or username of the user you would like to invite, and Driven will send them invitation within the Driven application.

team details invitations smpt no account lookup no

Figure 18. Invitations if SMTP and User Account Lookup is disabled

To uninvite a user to the team, choose the user(s) you wish to uninvite and click the Uninvite To Team" button in the Invitations table. You will be prompted to confirm that you would like to uninvite the selected user. Click the Uninvite button to proceed.

Figure 19. Uninvite to Team

External Issue Tracking

Figure 20. Issue Tracking

Driven has the capability to link directly to Atlassian JIRA if your team reports and track issues with an up-and-running implementation of JIRA. If external issue-tracking is enabled by the team leader or Driven administrator, the link to the JIRA instance appears on views containing application and flow details.

When you click on the link, JIRA opens and prompts you to file an issue. The URL of the page that you are viewing is automatically placed in the description field for the issue. JIRA project ID and issue type are also prepopulated, based on the settings that the team leader or Driven administrator defined.

The JIRA link icon appears on the top right corner of application details and flow details views if external issue-tracking is enabled.

Integrating JIRA Issue Links

Prerequisites: Know the JIRA base URL, project ID number, and issue type ID number that you want to associate with issues that are filed with the JIRA link in Driven.

To enable external issue-tracking links:

Open the team details page if you are not there already.
Click Add Project button in the Issue Tracking table. The Add External Link modal appears.
Enter a name for the link. The name will appear only on the team details page in Driven.
Enter the base URL, project ID number, and issue type number.
Click Submit. The JIRA link icon appears on pages with application- and flow-level details. Information about the link appears on the team details page, where you can also remove the link if you no longer want it to appear.

Figure 21. Issue Tracking

Webhook Connections and Email Notifications

If SMTP disabled, no email option.

Figure 22. Webhook Connections and Email Notifications

Driven can be integrated with third-party messaging platforms to automatically notify people when an application reaches one of the following states:

SUCCESSFUL status
FAILED status
Completed state (SUCCESSFUL, FAILED, or STOPPED status)

Driven supports webhooks that communicate with Slack, HipChat, and PagerDuty. The notifications that users receive typically contain a URL hyperlink to the application details page for the event.

The following procedure documents setup of both a new webhook connection and a new messaging ruleset. If you have an existing messaging ruleset that you want to apply to another webhook connection that was created in Driven previously, you can skip the Webhook Connections section and click Add rule to assign the ruleset to the connection.

To configure Webhook Connections and Email Notifications:

Email
HipChat: Refer to https://mydomain.hipchat.com/account/api, replacing "mydomain" with your HipChat domain name. On this web page you can create an access token and find information about API access.
PagerDuty: See Creating a Generic API Service for how to generate a service API key, which you use to fill in the Service Key field in the Add Webhook window. The API key enables automatic notification of application events to PagerDuty team members. If you have an existing PagerDuty incident where you want to record application events, you can fill in the Incident Key field to write status messages automatically to the incident log in addition to notifications that are sent to PagerDuty team members.
Slack: Refer to Slack API Incoming Webhooks documentation.
1. Click the Add Connection button in the Webhook Connections and Email Notifications table.
2. Of the "Type" options, select the connection type to which you want to apply the message rule.
3. Enter a name for the configuration. The name only appears a reference when viewing the team details page.
4. Optional: Enter a description. The name only appears a reference when viewing the team details page.

If Email is selected:

Select Entire Team to send emails to all team members, or select Specific Members to designate individual team members rather than the whole team as email recipients.

If HipChat or PagerDuty or Slack is selected:

Fill out the required fields

Then:

Click the Submit button.

Messaging Rules

Figure 23. Team Messaging Rules

Click Add Alert button in the Messaging Rules table.
In the Add Message Rule modal:
1. Select the application event to trigger a message in the On Event field.
2. Choose which Webhook Connection or Email Notification to apply the alert to.
3. Optional: Enter text in the Description field that will appear in the Messaging Rules part of the team details page.
4. If an Email notification is chosen, enter a subject line for the automatic emails.
5. Accept the default text in the Message Template field, or customize the message. The string "driven_url" in this field is treated as a token for the application details page URL. If you include "driven_URL", it is replaced by a URL hyperlink to the Driven page with specific details about an application event.
6. Click Add. ''' '''
  
  === Associating an Application with a Team

Driven allows applications to be associated with a team to limit access to the application metrics and to simplify segregating application resource usage among teams.

Before you run the application, you need to set the API key that is associated with the team that owns the application. You can set the API key configuring either Driven Agent or Driven Plugin to use it during runtime.

This value can be found by navigating to the team page the current application will be associated with.

When using the cloud version of Driven, a team API key is required to see any application data. If the API key is missing or incorrect, the application cannot be viewed.

To set the Driven API key see:

Note	The Driven Plugin is only installed for use with existing Cascading applications.