Introduction
In this article, we will provide a concise walkthrough of Xray's microservices and outline the steps to enable debug logging for each service.
Below is an overview of each microservice:
- Indexer: Extracts artifacts and builds, collects metadata, and constructs artifact component graphs.
- Persist: Matches component graphs with public info, completes names, and stores data in PostgreSQL.
- Analysis: Enriches component metadata with vulnerabilities, licenses, and version information.
- Server: Hosts API/UI endpoints, generates violations, and manages scheduled jobs like database sync.
- Policy Enforcer: Generates violations by aligning analysis data with Xray Watches and Policies.
- SBOM: Manages, stores, and enriches scan results from Xray and JFrog Security products.
- Router: Responsible for performing health checks between internal microservices and with Artifactory for authentication and reporting the Xray heartbeat to Artifactory.
In some scenarios, the JFrog Support team may request debug logs for enhanced analysis and troubleshooting. We can enable debug logging for each microservice based on your specific use case and the errors being captured that necessitate this level of logging by editing the Xray’s system.yaml file.
server:
logging:
application:
level: debug
persist:
logging:
application:
level: debug
analysis:
logging:
application:
level: debug
indexer:
logging:
application:
level: debug
router:
logging:
application:
level: debug
sbom:
logging:
application:
level: debug
policyenforcer:
logging:
application:
level: debug
Please find the documentation for your reference;
https://jfrog.com/help/r/jfrog-installation-setup-documentation/override-the-default-system-yaml-file-in-helm-installation
Enabling Debug loggers for Rabbitmq within Xray:
You can enable debug logging for RabbitMQ by adding the following line to the rabbitmq.conf file located at /opt/jfrog/xray/app/bin/rabbitmq/. Please note that a restart is required for this change to take effect:
log.file.level = debug
Alternatively, you can enable debug mode during runtime without requiring a restart by navigating to /opt/jfrog/xray/app/third-party/rabbitmq/sbin/rabbitmqctl. If you are using Docker or Helm installation, access the RabbitMQ container and execute the following command:
rabbitmqctl -n rabbit@target-host set_log_level debug
To Disable Debug Logging
If you wish to turn off debug logging, you can revert to the default log level with the following command:
rabbitmqctl -n rabbit@target-host set_log_level info
Note: use hostname -s to determine the hostname.