Federation Status Dashboard Field Reference

Look up every field and control on the Federation Status dashboard.

This reference documents every UI element, field, and interaction on the Federation Status dashboard.

Who can view this page: Platform Administrators

Navigation: Administration > Platform Monitoring > Federation Status

Requires: Artifactory 7.104.2 or later with the Artifactory Federation Service (RTFS) installed.


Dashboard Overview

The Federation Status page has two levels:

  1. Repository Federations list: Overview of all Federated repositories on this JPD with status summaries.
  2. Repository detail view: Metadata event connections for a selected Federated repository.

Level 1: Repository Federations List

Status Summary Panels

These panels show aggregate counts of Federated repositories by their current status.

PanelColorDescription
HealthyGreenAll members are synchronizing metadata events in a timely manner. A Federation attains this status only when no member has an error, is in a Full Sync, or is experiencing delays.
DelayedYellowAt least one member has high latency, meaning synchronization is taking longer than expected. DELAYED is derived from worker lag metrics (when lag exceeds rtfs.workers.lag.threshold.sec, default: 20 seconds), not from a distinct member state.
ErrorRedAt least one member has synchronization errors. This covers ERROR_GENERIC, ERROR_INACTIVE, and ERROR_OUT_OF_SYNC member states. See the Member State Reference for full state definitions.
Pending Full SyncBlueAt least one member is waiting for a Full Sync to be initiated. A Full Sync is performed during the initialization process when a Federation is created, and as a way to restore synchronization when regular synchronization and auto-healing are insufficient (for example, if there are purged events that are no longer available to be synchronized).
Full Sync RunningBlueAt least one member is currently undergoing a Full Sync operation.

The remaining row-level status badges (Disabled, Unsupported, Receiving Only, N/A) don't have their own summary panel. They all share a neutral gray badge in the repository table's Status column.

Interaction: Click a panel to filter the repository table to show only repositories with that status. Click the same panel again to clear the filter.

Repository Federations Table

The repository table includes the following columns.

ColumnSortableDescription
PriorityYes (default sort, ascending)A flag icon indicates the repository has been assigned HIGH priority for system resources. Hover over the column to toggle priority.
Repository KeyYesThe local repository key. Click to navigate to the repository detail view.
MembersNoThe number of JPDs participating in this Federation. Click the member count badge to open the Federation Members popup.
StatusYesThe overall status, determined by the most severe status among all members. For example, if the Federation has 5 members and some are in Error status, the overall status is shown as Error together with an indication of how many members have that status.

Status severity order (highest to lowest): Error > Delayed > Pending Full Sync > Full Sync Running > Disabled > Unsupported > Healthy > N/A.

Sorting: The table is initially sorted by Priority (HIGH repositories first). Within the same priority, repositories are sorted by status severity.

Table Filtering

You can filter the repository table using the following methods.

Filter MethodDescription
Status panel clickFilter by a single status category.
Filter sidebarClick the filter icon to open a radio-button list with all statuses: Error, Delayed, Pending Full Sync, Full Sync Running, Disabled, Healthy, Unsupported, N/A.
Search boxFree-text search across repository keys and status text.

Priority Assignment

You can assign or remove HIGH priority using the following actions. For the mechanics behind prioritization, see Set Federation Priority.

ActionHowLimits
Assign HIGH priorityHover over the Priority column for a repository and click the flag icon.Maximum 10 repositories or 20% of total repositories (whichever is lower).
Remove priorityClick the flag icon again to revert to STANDARD priority.N/A
EffectHIGH priority repositories get larger worker batch sizes (up to 400 events per batch versus 200 for STANDARD), resulting in faster event processing.Setting too many repositories to HIGH dilutes the benefit.

API: PUT /ui/admin/repositories/federatedRepo/prioritization/{repoKey}?priorityLevel=HIGH|STANDARD

Federation Members Popup

Click the member count badge in the Members column to open this popup.

ColumnDescription
MemberRepository key and full URL of the member.
StatusThe most severe status of outgoing connections from this member.

Level 2: Repository Detail View

Navigation: Click a repository key in the list, or go directly to Administration > Platform Monitoring > Federation Status > select a repository.

Breadcrumb: Federation Status > Repository Key

Member Binary Tasks

The detail view displays these indicators next to the member selector.

IndicatorDescription
In ProgressNumber of binary transfer tasks currently being processed for the selected member.
FailedNumber of binary transfer tasks that have failed for the selected member.

If the selected member is unreachable or unsupported, both values show N/A.

Member Selector

Use this control to filter the connections table by member.

ControlDescription
Member dropdownSelect a source member to filter the connections table. Shows the member URL. An identification icon is displayed next to the selected member for easier identification. Click the x icon (or select "All Members") to clear the selection and show connections from all members.

Metadata Event Connections Table

Each row represents a connection between a source and target member.

ColumnDescription
SourceThe repository on the source member responsible for sending events. Shows repository key and platform URL. An icon highlights the row if it matches the selected member.
TargetThe repository on the target member responsible for receiving events. Shows repository key and platform URL.
StatusCurrent connection status: Healthy, Delayed, Error, Pending Full Sync, Full Sync Running, Disabled, Receiving Only, Unsupported, or N/A.
LatencyThe length of time that has passed since the last event that was handled successfully. Displayed as a human-readable duration (for example, "2 minutes ago", "1 hour ago") or N/A if not available.
Queued EventsTotal number of events waiting to be sent from the source to the target member.

The following table lists the tooltip text for each column.

ColumnTooltip
Source"The Federated repository on the source member responsible for sending events"
Target"The Federated repository on the target member responsible for receiving events"
Latency"The length of time that has passed since the last event that was handled successfully"
Queued Events"Total number of events waiting to be sent to the target member"

Connection Status Values

The connection Status column can show the following values. For workflow guidance, see Monitoring Connection States.

StatusColorDescription
HealthyGreenEvents are synchronizing normally between these members.
DelayedYellowSynchronization is slower than expected based on lag metrics.
ErrorRedSynchronization errors are occurring on this connection.
Pending Full SyncBlueWaiting for a Full Sync to be initiated on this connection.
Full Sync RunningBlueA Full Sync is in progress on this connection.
DisabledGrayThe target member has been disabled by an administrator.
Receiving OnlyGrayThe target member is in receiving-only mode (receiver mirror mode).
UnsupportedGrayThe target member is running a version that does not support the Federation dashboard.
N/AGrayStatus cannot be determined because the source or target is unreachable.

API Endpoints Used by the Dashboard

The dashboard uses the following API endpoints.

MethodEndpointPurpose
GET/ui/federation/status/stateSummaryFetch status panel counts.
GET/ui/federation/status/stateListFetch the repository federations list with member information.
GET/ui/federation/status/connectionStates/{repoKey}Fetch metadata event connections for a specific repository.
GET/ui/federation/status/repoState/{repoKey}/binaries?url={memberUrl}Fetch binary task counts for a specific member.
GET/ui/system/configuration/platform/federatedUrlFetch the local platform's federated URL.
GET/ui/federation/rtfsCheck if RTFS is active (used for feature flag or legacy redirect).
PUT/ui/admin/repositories/federatedRepo/prioritization/{repoKey}?priorityLevel=...Set or remove priority on a repository.

For example, to fetch the status panel counts:

curl -X GET "https://<SERVER_URL>/ui/federation/status/stateSummary" \
  -u <USERNAME>:<ACCESS_TOKEN>

Where:

  • <SERVER_URL>: Your JFrog Platform server URL.
  • <USERNAME>: Your JFrog Platform username.
  • <ACCESS_TOKEN>: A valid JFrog access token.

For example:

curl -X GET "https://mycompany.jfrog.io/ui/federation/status/stateSummary" \
  -u admin:<ACCESS_TOKEN>

Related Topics


Did this page help you?