XRay User’s Guide
The XRay User’s Guide is an overview of the XRay system. Use this document as a starting point to learn of XRay’s features. Explore samples and demos, learn how to access and customize the system and see how data is imported/exported. XRay functions are also discussed, as well as an introduction to using the jKool Query Language (jKQL).
XRay Custom Installation Guide
The recommended methods of installing XRay are to use a deployment pack or to install using docker. By contrast, this Custom Installation Guide document addresses the needs of customers who are performing a custom install (for example, using some components that were previously installed) or upgrading XRay components within an existing installation. It covers the manual equivalents of the installation and configuration scripts that are automated through the XRay deployment pack. It contains instructions for the minimum steps required to install, configure, and run XRay.
XRay Upgrade Guide v1.5 to v1.6
Follow this guide to upgrade from XRay version 1.5 to 1.6.
XRay Upgrade Guide v1.4 to v1.5
Follow this guide to upgrade from XRay version 1.4 to 1.5.
XRay Upgrade Guide v1.3 to v1.4
Follow this guide to upgrade from XRay version 1.3 to 1.4.
XRay Upgrade Guide v1.2 to v1.3
Follow this guide to upgrade from XRay version 1.2 to 1.3.
jKQL Reference Guide
jKQL (the jKool Query Language) defines the syntax of statements used for manipulating data in the XRay Data Model. Use this guide as a reference to learn how to use jKQL to analyze anomalies, behavior, flows, relationships and patterns in your data as it relates to your business.
XRay Database Maintenance Utility Guide
The XRay Database Maintenance Utility Guide describes the tasks that XRay Database Maintenance Utility provides for managing XRay SolrCloud clusters. The utility supports the backup, restore, import, export, migration, and purge operations. Please review this guide carefully before using the utility.
Single Sign On Setup Guide
Single sign-on (SSO) is an authentication method that allows users to securely sign on to several software systems with one set of credentials. This guide covers the setup and configuration of SSO using the Auth0, Keycloak, Okta, and Ping Identity providers.
XRay is using Machine Learning to provide insights into data that would not normally be seen by simply viewing the data. Read this guide for more information on what is required and how Machine Learning is used with XRay.
jKQL Streaming and Query API with REST
The JKQL Streaming & Query API using REST allows you to run queries against your data repository, as well as send events, metrics, and transactions.