Cloud customer?
 Upgrade in MyJFrog >

Search





Overview

The Dashboard in the JFrog Platform provides administrators with visibility into the health and status of your registered JFrog Platform Deployments (JPDs) and services. You can see the connections between the JPDs across geographical locations around the world and even drill-down to view the status of a single JPD and its associated services.

The Dashboard provides these two main views:

  • Topology View: Provides the status of your JPDs and services on a map together with status updates on Replication and Access Federation.  Requires JFrog Mission Control with an Enterprise license or above.
  • Trends View: Provides in-depth health and performance information about your JPDs by tracking metrics around Storage, Security, Distribution and Replication.  Requires JFrog Mission Control with an Enterprise+ license.

Prerequisites and Guidelines

Page Contents


The following shows a Dashboard with replication successfully running between the RnD to Datacenter 2 and that replication has failed between the two JPDs in India.

Viewing JPD Health and Services

The Dashboard Topology page displays your registered JPDs across geographical areas in a map view with a set of indicators that provide insight into the health of your services running on each JPD. By default, the Topology page displays information about the Home JPD that was configured during the installation process. When you install Mission Control and connect it to JFrog Artifactory, the JPD that Mission Control is part of is automatically declared the Home JPD and is displayed in the Topology view as the default location.

The Topology page is divided into two main panels:

  • Map View: You can toggle between the Replication and Access Federation views or focus on specific JPDs by entering tags that were predefined during the JFrog Platform Deployment Registration ProcessTags are labels that help you to organize your JPDs according to logical categories. For example: you can group JPDs by location or by data centers including Development, Testing, and Production.
  • Information Panel: You can view basic status information and a list of services configured for the selected JPD. 

To access the Topology page, from the Application module, click Dashboard and select Topology.

The Topology page displays the JPDs on a map with one of the following health indicators next to each JPD, allowing you to quickly assess the state of your services running in the JPD.  

Indicates that one or more JPDs are running in the same location.

Indicates that the services are offline.

Indicates that only certain services are offline.
Proceed to view the detailed service information.

Indicates that all the services are online and functioning in the JPD.

Indicates that Access Federation information could not be retrieved.

Indicates that the JPD is offline.

View the topology metrics to find the problem.

Click the dropdown arrow in the bottom panel and scroll to view the service details.

A list of services installed on the JPD opens.

The following metrics are displayed in the bottom panel of the Dashboard providing information on the health of the selected JPD and its services.

  • Service Status: Displays the health of the selected JPD.
  • Storage: Displays storage utilisation for repositories and packages.
  • Replication: Displays the Replication status - Succeeded, Failed, Not Configured, or Not Run.
  • Licenses: Displays the JFrog license activated on the JPD.
  • Service Breakdown Per JPD: Displays a list of services installed.

Checking Data Replication Status

Replication ensures developers all work with the same version of remote artifacts and that build artifacts are shared efficiently between the different development teams. 

The Replication view tracks and displays information on all replications in which the selected JPD is involved. If multiple replications are configured for the JPD, you can filter the list by source or destination repository. Replication is used in a variety of use cases to synchronise repositories between remote JPDs. Depending on repository size this may require the transportation of huge quantities of data. Since speed of transportation is limited by bandwidth and network latency, this is a process that may take hours and even days to complete. For more information, see Repository Replication

To access Replication view, from the Application module, click Topology and select Replication from the Show list.

You can quickly check the Replication status for the selected JPD In the bottom panel. 
The arrows between the source and target JPDs indicate the direction of the replication data flow from the Target JPD to the Source JPD and colour indicates the replication status:

  • Green: Replication was completed successfully.
  • Blue: Replication is in progress.
  • Red: Replication has failures.

The Dashboard Topology view displays the most recent status of replications between five JPDs - a main RnD Center in Europe, an additional RnD Center in India, and three data centers around the world. As the topology shows, the last replication between RnD to the Datacenter 2 is in progress and between Datacenter 3 and Datacenter 2 was completed and successful. You can also see that the replication between RnD and DataCenter 1 (in India) has failed.

Viewing Access Federation Status

Access Federation gives you control over access to all, or any subset of your services from one location by synchronising all security entities (users, groups, permissions and access tokens) between the federated services. For more information, see Access Federation.

You can view the status and health of Access Federation with arrows indicating direction and the status of the synchronisation process according to your Access Federation topology set up in the system.

From the Application module, click Topology and select Access Federation from the Show list.

In the following example, Access Federation is configured in a star topology, with grey arrows indicating that Datacenter3 is the source federating DataCenter1 and Datacenter2.


Viewing Trends in the Dashboard

The Trends view displays metrics and a set of graphs related to Distribution, Replication, Security and Storage based on historical data collected and stored.

To view a trend, from the ApplicationDashboard click Trends and select a trend from the Type dropdown list.

Global Trend Filters

You can apply these global filters to gain different perspectives regarding the health of your JPD:

  • Platform Deployments: Allows you to select a JPD from a list of registered JPDs.
  • Type: You can view graphs for the following metrics: Distribution, Replication, Security and Storage.
  • Time Range: To set the time period, click Filter. You can select a predefined period: Last 24 hours, Last week, Last month, Last quarter, and Last year. You can also set a custom time range and select any period of time during which data was collected. 

In addition to the global filters, each trend supports a set of dedicated filters. For example, you can filter the Storage Trend by Repositories and Package Types. To view the filters for each trend type, see the specific Trend section. 

Storage Trends

Temporary Slow-Running Queries

When running queries including all the repositories in the Storage Trends page, you may experience slow-running queries if you have more than 300 repositories in the JPD. 

The Storage Trend tracks the physical storage for each of your registered JPDs. To gain deeper insight, you can filter the data by repositories or by supported package types. Tracking your storage allows you to manage, control, and plan your storage based on the actual storage usage against the maximum allocated space for each of the repositories. 

In the example above, the graph shows max space allocated and actual size in GB of your Maven repositories. Selecting a point on the graph displays the total used space, the max space allocated, and the size and number of artifacts in Maven repositories at that point in time. In addition to the graph, you can drill down and view a detailed breakdown by repository type for the current size and growth over time in the dialog view that opens to the left of the graph.

Cloud Deployments

The "Max allocated" and "Allocation by %" filters are not available for JPDs that are backed by Cloud providers.

Replication Trends

The Replication Trend tracks full or incremental replication from the selected JPD to any of the target JPDs according to status type - Failed, Finished, Running or Stopped. Tracking the Replication trends provides you with insight on the quality of the replication based on rate and errors. 

In the example above, the graph shows the incremental replication from Datacenter 1 to any repository in JPD-2Selecting a point on the graph shows that the replication was completed successfully with an average replication rate of 1 KB/S and an Upper Deviation of 90 KB/S. 

Known Timing issue

There is a known issue where metrics are not gathered correctly for replications which are in-progress when the metrics gathering task is triggered. 

Xray Scanning Trends

The Xray Scanning Trend tracks all the vulnerabilities found on your scanned repositories and builds. Tracking the security vulnerabilities allows you to detect problematic builds or repositories and analyze vulnerability trends over a period of time.

In the example above, you can view the number of vulnerabilities for builds and repositories.

Distribution Trends

The Distribution Trend tracks the Release Bundle distribution to the Edge nodes. Tracking the Release Bundle distribution process allows you to evaluate the quality of your distribution process from the selected JPD to any Edge nodes.

In the example above, you can view the number of successful and failed distributed Release Bundles. Selecting a point on the graph indicates the number of successful and failed distributed Release Bundles with a breakdown by Edge nodes.

Storage Garbage Collection Trends

Prerequisite

Enabling GC Trends

To enable Garbage Collection Trends, the following additional configurations will need to be added to the Artifactory System YAML file.

Enable Metrics

Enable metrics in the Artifactory System YAML. For more information, see Open Metrics.

Enable Filebeat

This allows Filebeat (now bundled with Artifactory) to parse the new logs and send their contents to Mission Control's Elasticsearch. 

shared:
    metrics:
        filebeat:
            enabled: true
            elasticsearch:
                url: <url_to_jfmc_elasticsearch>

The Garbage Collection Trends tracks Artifactory storage garbage collection metrics. It enables you to track metrics such as:

  • Details of a garbage collection jobs, such as their duration, run time, storage space reclaimed and completion time. This allows you to track possible performance issues and improve the garbage collection process.
  • The total storage size of all binaries allocated in a JPD, to track the storage capacity


  • No labels
Copyright © 2020 JFrog Ltd.