Driven Administration Guide
version 1.1.1Using the Driven Admin Console
When users are logged in Driven with admin privileges, they can access the Driven Admin Console, where the following task can be performed:
-
Monitor Driven health
-
Manage users
-
Manage teams
-
View backup Repositories
-
Update license information
Figure 1: Select the Admin settings option to launch the Driven Health dashboard (default)
Navigate to other adminstrative views by clicking on the left pane menu:
Driven Health
Use the Driven Health view to track performance issues related to your cluster server. This page provides statistics about your cluster including node metrics and Elasticsearch information. Driven aggregates cluster wide statistics and events and offers a single interface to view and analyze them.
Figure 2: Driven Health view
This screen is a summary view of the health of the Driven cluster, more notably the health of Driven persistence layer, which is based on Elasticsearch.
|
Note
|
All metrics displayed in the Driven Health page are not stored by the server but are rather kept in memory. Therefore, if the server is shut down for any reason all counters are reset. |
| 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 amount of available storage space that is usable by Elasticsearch. This is the total across all nodes in the Elasticsearch cluster. |
| Available Processors |
The amount 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 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 link to display node information. |
| Node IP Address |
The IP address of each node in the Driven cluster. |
| 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 aren’t accounted for in the above categories. |
| Total |
The total of all HTTP requests for each server. |
| Bulk Puts (Total) |
The number of plug-in document PUT requests to each server. The plug-in sends documents in batches so each request may be many documents. |
| Bulk Docs (Errors) |
The number of plug-in documents submitted that resulted in errors and were therefore rejected by the server. |
| Bulk Docs (Totals) |
The numbers of plug-in documents that were successfully processed and stored by the server. |
| Versions |
The version numbers of all the Elasticsearch nodes in the cluster as visible by Driven. |
| Status |
The cluster status that ElasticSearch is currently reporting at the shard level where; 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 installed a single node per instructions in the Driven Getting Started Guide, you will see the Summary: Status as YELLOW since it is a single-node installation with no replicas. |
To perform further analysis, you can invoke Elasticsearch APIs for cluster health.
Of particular interest, the cluster health API, returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins).
$ curl -XGET 'http://DRIVEN_HOST_URL:9200/_cluster/stats?mycurrentnode'Manage Users
After clicking on the Manage User icon, the Manage Users page appears where you can create, manage, and/or delete user accounts.
Figure 2: Use the Manage User page to manage user accounts on Driven.
As the Driven Administrator, you can create or delete a user account. Additionally, you can reset the user account password.
You a see when the user credential was created and modified. It also shows when the user last logged into Driven.
Manage Teams
After clicking the Manage Teams icon, the All Teams appears. It displays all created Teams. At first glance, you can see how many members and applications are associated with a team.
Figure 3: Use the Manage Teams page to manage Teams
Adding User to Team
To associate a user to a Team, click on the Team name link in the All Teams page to launch the Team’s detail screen.
Figure 4: The team name details allow you to edit team information including inviting a user
|
Note
|
For detailed information on how to add a user to a team, refer to Configuring Teams for Collaboration in the Driven User Guide. |
View backup Repositories
After clicking the Backup icon, the Repositories page appears. This page displays all repository information.
Figure 5: Expand the Repository information to see the Snapshot Name
|
Note
|
There are two types of repositories: Amazon s3 - which has buckets, regions, base path, and compress. filesystem (fs) - which has location and compress. |
| Expand |
Click on the plus or minus (+ or -) icons 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). |
Click the plus (+) icon to expand on the 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 was taken. |
| 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 Implementing a backup strategy for your Driven Application for detailed information. |
License Info
After clicking the License Info icon, the License Info page appears. This page displays all license information assigned to your Driven installation.
Figure 6: The License Info page displays details of all license for Driven
You can update your license key by clicking on the Update License link in Update field.
Figure 7: Use this page to update your installation license
Enter your new license key in the field, then click Install License Key.