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 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 Insight with an Enterprise+ license or standalone JFrog Mission Control with Enterprise+ license. You cannot view trends if you use the Mission Control microservice without using JFrog Insight.

    From JFrog Artifactory version 7.27.3, Mission Control has been integrated directly into Artifactory as a service. You no longer need to install Mission Control to use the features it provides. You must enable the service in Artifactory through the Artifactory system YAML file. The metrics capabilities that were provided Mission Control is now available through JFrog Insight. To learn more about how to install Insight, see Installing Insight .

    To learn more about how Mission Control has been integrated into Artifactory and to migrate to Mission Control microservice, see Migrating Platform Deployments and License Buckets.

    You must install JFrog Insights to use trends and charts after you migrate to Mission Control microservice. For more information, see Migrating from Mission Control to Insight.

    You can still install Mission Control with Artifactory version 7.27.3 and later, until the end-of-life of Mission Control as a standalone product. Mission Control will continue to receive critical fixes and security updates.

Prerequisites and Guidelines

The following shows a Dashboard with replication successfully running between the Home to 50-box.

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 enable Mission Control as an Artifactory microservice, 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 Process. Tags 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, f rom 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 utilization 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 synchronize 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.

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 your JFrog Platform deployments.

To view a trend, navigate to Application > Dashboard >  Trends.

The following trends are available:

  • Storage Trends: Track Artifactory storage garbage collection metrics, Repository Storage metrics, and Optimization Info.

Repository Storage trend is available in Cloud and Self-Hosted.
Garbage Collection and Optimization Info trends are available in Cloud and Self-Hosted.
Available in Cloud and Self-Hosted.
Available in Cloud and Self-Hosted.

  • Performance Metrics: Gain insights on the performance of your platform deployments, such as slow queries, DB Connections, Heap Size, and remote repository HTTP connections. 

Available in Self-Hosted.

  • Replication Trends : Tracks full or incremental replication from the selected JPD to any of the target JPDs.

Available in Cloud and Self-Hosted.

  • System Metrics : Provides insights on the server that is hosting the JFrog Platform and its products.

Available in Self-Hosted.
Available in Cloud and Self-Hosted.

Insight does not consolidate data from all the JPDs and you cannot select the JPD from which you want to view the data. You must install Insight in each JPD and view trends for that individual JPD.

Insight shows information from Artifactory Edge nodes if you apply an Enterprise+ license and install Insight.

Enabling Trends

Most of trends rely on the Open Metrics framework; to view these, you must enable metrics and Filebeat in the products that support it:

Supported Products

  • JFrog Artifactory 7.7 and above
  • JFrog Xray 3.17.2 and above
  • JFrog Insight 1.1.1 and above with JFrog Artifactory 7.29.x and above

Enable Metrics

Enable metrics in the system YAML of the product. For more information, see Open Metrics.

To enable metrics in Artifactory, make the following configuration changes to the Artifactory System YAML.

artifactory:
    metrics:
        enabled: true

To enable metrics in Xray, make the following configuration changes to the Xray System YAML .

xray:
    metrics:
        enabled: true

To enable metrics in Insight, make the following configuration changes to the Insight System YAML .

## Insight scheduler template
insight-scheduler:
    metrics:
        enabled: true
## Insight server template
insight-server:
    metrics:
        enabled: true

Enable Filebeat

Allows  Filebeat (bundled with the products) to send log and metric data to Elasticsearch.

shared:
    metrics:
        enabled: true
        filebeat:
            enabled: true
            elasticsearch:
                url: <URL_TO_JFMC_ELASTICSEARCH>
                username: <ELASTICSEARCH_USERNAME>
                password: <ELASTICSEARCH_PASSWORD>

The Elasticsearch URL should be:

  • If using the ElasticSearch bundled with JFrog Insight, use the Insight address: http://<insight-ip>:<insight-port>/elasticsearch. If you are using JFrog Mission Control, use the JFMC address: http://<jfmc-ip>:<jfmc-port>/elasticsearch.

  • If using an external ElasticSearch, use the ElasticSearch request port.

Global Trend Filters

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

  • Type: Select the trend that you wish to display.

  • Product: View trends for a specific product such as Artifactory or Xray.

  • 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. If Last quarter or Last year is selected, the data is displayed based on a weekly interval.

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. 

Increase Elasticsearch Shard Size

If you see the following error in the UI, "507 - Insufficient Storage", it indicates that Elasticsearch has exceeded the number of shards. You can increase the number of shards in Elasticsearch by increasing the value of  cluster.max_shards_per_node to a higher value by using the Elasticsearch API. The default is 1000. For more information, refer to the Elasticsearch documentation.