Driven Administrator Guide

version 1.3.8

Using the Driven Admin Console

If you are logged in to Driven with administrator (admin) privileges, you can access the Driven Admin Console to perform the following tasks:

Monitor Driven performance and status
Manage users
Manage teams
View backup repositories
Update license information

You can open the Driven Admin Console by clicking admin in the upper-right corner of the window. When you click here, the user profile menu displays administrative options.

Figure 1: admin user profile menu

Viewing Driven Status

Click Driven Health to see performance metrics related to your Driven deployment. This page provides statistics about your deployment including node metrics and Elasticsearch information. The Elasticsearch information can help uncover issues in the persistence layer. Driven aggregates deployment statistics and events and offers a single interface to view and analyze them.

Admin_Driven Health Figure 2: Driven Health view

Note	All metrics displayed in the Driven Health page are not stored by the server but rather are kept in memory. Therefore, if the server is shut down for any reason all counters are reset.

Cluster Statistics

Total Available Storage	The amount of available storage space that is usable by Elasticsearch. This is the total across all nodes in the Elasticsearch cluster.
Total Storage Capacity	The total amount of storage space that is usable by Elasticsearch, including both available and used space. This is the total across all nodes in the Elasticsearch cluster.
Available Processors	The number of available processors in the Elasticsearch cluster.
JVM Heap Used	The amount of total Java heap space currently in use. This is the total across all nodes in the Elasticsearch cluster.
JVM Heap Max	The maximum amount of Java heap space available across the cluster. This is the total across all all nodes in the Elasticsearch cluster.

Note	Click Show Individual Node Statistics to display node information.

Node Statistics

Node IP Address

The IP address of each node in the Driven installation.

Web Requests

OK	The number of OK (2xx) HTTP requests that have been processed by this server.
Server Error	The number of Server Error (5xx) HTTP requests that have been processed by this server.
Not Found	The number of Client Error (4xx) HTTP requests that have been processed by this server.
Other	The number of all other HTTP requests that have been processed by this server, which are not accounted for in the above categories.
Total	The total of all HTTP requests for each server.

Plugin

Bulk Puts (Total)	The number of plugin document PUT requests to each server. The plugin sends documents in batches so each request may be many documents.
Bulk Docs (Errors)	The number of plugin documents submitted that resulted in errors and were therefore rejected by the server.
Bulk Docs (Total)	The number of plugin documents that were successfully processed and stored by the server.

Elasticsearch Summary

Versions	The version numbers of all the Elasticsearch nodes that are visible by Driven.
Status	The cluster status that Elasticsearch is currently reporting at the shard level. RED status indicates that the specific shard is not allocated in the cluster. YELLOW indicates that the primary shard is allocated but replicas are not. GREEN status indicates that all shards are allocated.
Storage Used	The total amount of disk space that Elasticsearch (and therefore Driven) is using to store all Driven information.
Document Count	The total number of documents that Elasticsearch reports that it is storing across all nodes.

Note	When you have a single-node installation of Driven, the Status is YELLOW because a single node has no replicas.

To perform further analysis, you can invoke Elasticsearch APIs. Of particular interest, the Elasticsearch cluster health API returns basic index metrics (shard numbers, store size, and memory usage) and information about the current nodes that form the cluster (number, roles, OS, JVM versions, memory usage, CPUs, and installed plugins).

Managing Users

Click the Manage Users option to create, manage, or delete user accounts.

Manage_Users

Figure 3: The Manage Users page to manage user accounts on Driven

As the Driven admin, you can create or delete a user account. In addition, you can reset the user account password.

You see when the user credential was created and modified. The page also shows when the user last logged in to Driven.

Managing Teams

After selecting the Manage Teams option, the All Teams page appears. You can see how many members and applications are associated with a team. As well, you can see a chronological history of member and application associations with teams.

Manage_Teams

Figure 4: The All Teams page to manage teams

Note	For a more in-depth explanation of team functionality in Driven, see Configuring Teams for Collaboration in the Driven User Guide. The user guide information also explains how users without administrator privileges can create and set up teams.

Adding Users to Teams

To associate a user with a team, click on the Team Name link to launch the team’s detail screen.

Manage_Team_AddUsers Figure 5: The team details page allows you to edit a team and to invite a user to join

Note	For a more in-depth explanation of team functionality in Driven, see Configuring Teams for Collaboration in the Driven User Guide. The user guide information also explains how users without administrator privileges can create and set up teams.

Viewing Backup and Snapshot Repositories

Select the Repositories option on the admin menu or the Backups icon on the navigation pane to display all repository information.

To maximize or minimize display of snapshot details in a repository, click the + and - symbols in the Expand column.

Note	There are two types of repositories. Amazon S3 contains buckets, regions, base path, and compress. filesystem (fs) has location and compress.

Repositories

Expand	Click on the + or - symbols to expand or hide the details of the repository.
Repository Name	The name of the repository.
Type	One of the following type: fs (filesystem) or s3 (Amazon S3 bucket).
Compress	The store artifacts are compressed or not.
Base path	The prefix in S3 bucket (only applicable to s3 type).
Region	The region for S3 bucket (only applicable to s3 type).
Bucket	The S3 bucket (only applicable to s3 type).
Location	The shared filesystem path (only applicable to fs type).

Expanded Repository

Snapshot Name	The name of the snapshot.
Indices	The name of the indices (data stores) in the snapshot.
State	The state of the snapshot attempt.
Start time	The time when the snapshot started.
End time	The time when the snapshot finished.
Duration	The duration of the snapshot operation.

Note	Use the Snapshot Name to restore your backed up repository. Refer to Backing Up and Restoring Driven Repositories for detailed information.

Entering and Viewing License Key Information

Click License to oversee Driven license terms and keys.

If you need to enter a new license key to start or to continue using Driven, click Update in the last column of the License Information table. You are prompted to enter the key in the window that appears after selecting to update the license.

Next Topic

Backing Up and Restoring Driven Repositories