System Maintenance and Monitoring

The overall status is an accumulation of the status for a variety of parameters. The table below describes the parameters monitored and the condition that generates a notification. Note that some notifications may be categorized as "warnings" or "errors" depending on the severity of the condition:

System Logs

You can view Xray's system logs from the Admin module under System Logs. 

System Messages

Xray administrators can view a list of all artifact and data failure messages in the System Messages page, under the Admin module. Each failure can be traced to the exact step in the scanning and impact analysis Xray process in which it failed, allowing administrators to fix the issue and retry the step. Or contact JFrog support for further investigation.

Search for specific failures using the "Filter by Subject" box and by selecting the specific scan and impact steps.

Scanning

Every time a new artifact or build is added to a connected Artifactory instance, Xray scans it and its dependencies for known vulnerabilities and compliance violations and generate Issues accordingly. This process is called "Scanning". That includes the following process steps:

1. Event
2. Index
3. Persist
4. Analysis
5. Alert
6. Notify
7. Artifactory Update

Impact Analysis

Every time new component metadata is available (vulnerabilities, licenses, etc.), Xray looks up the component in the components graph and if the update matches any watches, Xray will generate an issue and create a map of its impact to determine which artifacts are ultimately affected by it. This process is called "Impact Analysis". That includes the following process steps:

1. Analysis
2. Alert
3. Notify
4. Artifactory Update

Export and Import Configuration Settings

You can export Xray user-defined configurations to be imported to other Xray instances using a set of dedicated REST APIs. This is mainly useful when duplicating settings across multiple environments (Dev, Testing, Staging, and Production) or when moving to a single Xray to Artifactory instance ratio. The following settings include policies, watches, Ignore Rules, custom licenses, custom issues, webhooks, mail server, proxy configurations, and indexed resource settings.

REST API

Xray REST API provides the following endpoints you can use to work for exporting and importing Xray configuration settings.

Backup and Restore

JFrog Xray is made up of several " Go" services as well as some external services. Each needs to be handled separately.

Xray’s backup and restore solution is based on storage snapshotting to store data and configuration. In order to ensure data consistency and reliability, all Xray services must flush their data to disk before running the snapshot tool or keep a transaction log.

Backup Directories

The directories that should be backed up depend on whether you are running Xray in a Docker container or not.

Docker Backup Directories

To back up Xray running in a Docker container, you need to back up the $XRAY_MOUNT_ROOT directory which contains the following sub-directories:

• xray

• postgres

• rabbitmq

• mongodb

For example, if $XRAY_MOUNT_ROOT=/root/.jfrog/xray, you would need to back up the following directories:

• /root/.jfrog/xray/xray
• /root/.jfrog/xray/postgres
• /root/.jfrog/xray/rabbitmq
• /root/.jfrog/xray/mongodb

Non-Docker Backup Directories

For non-Docker distributions, Xray's data is distributed among the following directories:

Running a Backup

To run a backup, simply create a snapshot of each of the backup directories described in the previous section.

Restoring from a Backup

Before restoring from a snapshot, we recommend backing up your current state.

To restore Xray from a backup:

1. Stop Xray

2. Overwrite the data in the backup directories with the corresponding data in your backup

3. Start Xray

Getting Support

JFrog provides SLA based support for Pro and Enterprise licensing tiers. If you have purchased one of these tiers you may contact JFrog support through the JFrog Support Portal. In most cases, JFrog support will require some initial information about your system and relevant log files. In order to expedite handling of your issue, Xray lets you generate all the initially required information in the Admin module Support Zone screen. When opening a support ticket, you can attach the information bundle to expedite handling of your issue.

Requesting Support

To request support, create an information bundle with the relevant information, and login to  JFrog Support Portal to open a support ticket and attach the information bundle.

Collecting an Information Bundle

The support zone provides a variety of options to select what information is included in the bundle you provide JFrog support.

 Once you have checked all the information items you wish to include in your information bundle, click "Create" to create the bundle.