--- sourceDocument: Yokohama IT Operations Management sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/yokohama/it-operations-management Release : - yokohama ft:locale : - en-US ft:publication_title : - Yokohama IT Operations Management ft:clusterId : - itom bundleId : - itom workflow : - Technology --- # Apache Cassandra database # Apache Cassandra database discovery {#ariaid-title1} * Release version: Yokohama * * Updated January 30, 2025 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 3 minutes to read Summarize ![AI sparkle icon](https://servicenow.com/docs/portal-asset/ai-sparkle-icon) Summarized using AI This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete. ## Summary of Apache Cassandra database discovery ServiceNow Discovery identifies Apache and DataStax Cassandra databases running on UNIX systems using the Cassandra Distributed DB pattern. To discover these resources, you may need to install Discovery and Service Mapping Patterns from the ServiceNow Store. The discovery process populates detailed configuration and operational data into the CMDB, enabling better management and visualization of Cassandra environments. Show full answer Show less ## Prerequisites * **Credentials:** Provide credentials for the hosts running Cassandra databases to enable horizontal discovery. * **CMDB CI Class Models:** Ensure your instance has the 1.14.0 version of the CMDB CI Class Models store app for Cassandra CI support. * **Permissions:** Verify the UNIX user has privileges for required Cassandra commands. * **Read Access:** Confirm read access to the `cassandra.yaml` configuration file, typically located in standard installation or configuration directories. ## Data Collected by Discovery Discovery populates multiple CI classes in the CMDB with detailed Cassandra information: * **Cassandra Cluster:** Captures cluster names as primary identifiers. * **Cassandra Cluster Node:** Includes cluster references, IP addresses, host machine references, and operational statuses. * **Cassandra Instance:** Records configuration directories, installation paths, IP addresses, process IDs, rack and data center info, TCP ports from `cassandra.yaml`, unique instance IDs, vendor info (Apache or DataStax), and workload names. * **Cassandra Keyspace:** Tracks keyspace names associated with clusters and their display names. ## CI Relationships Discovery creates relationships between discovered CIs to reflect the Cassandra deployment structure, such as: * Instances run on servers. * Cluster nodes hosted on servers. * Clusters containing nodes and keyspaces. * Keyspaces hosted on clusters. ## Service Mapping Top-Down Discovery Service Mapping performs a top-down discovery of Cassandra clusters, focusing on instances running on nodes within the cluster. It enriches the CMDB with additional fields such as accessible keyspaces and represents these in application service maps, showing real-time connections and dependencies. This enhances visibility into Cassandra workloads and their integration within your infrastructure. ServiceNow Discovery finds the Apache and the DataStax Cassandra database on UNIX using the Cassandra Distributed DB pattern. Discovering some of these resources requires installing the Discovery and Service Mapping Patterns from the ServiceNow® Store. ## Request apps on the Store {#cassandra-discovery__section_w4v_dmt_kmb} Visit the [ServiceNow Store](https://store.servicenow.com/sn_appstore_store.do#!/store/home) website to view all the available apps and for information about submitting requests to the store. For cumulative release notes information for all released apps, see the [ServiceNow Store version history release notes](https://www.servicenow.com/docs/r/store-release-notes/sn-store-release-notes.html).{#cassandra-discovery__inline-send-to-store} ## Prerequisites {#cassandra-discovery__section_anr_bmt_kmb} Provide credentials for discovering the host : Identify the servers hosting a Cassandra database and provide credentials necessary for horizontal discovery of these servers. For more information, see [Credentials required for host discovery](https://servicenow-prod.fluidtopics.net/9wrINqajrHPIWmwJQejr1g "There are credentials and permissions that Service Mapping requires for discovering hosts."). Verify CMDB CI Class Models store app is up to date : Ensure that your instance supports the Cassandra CI class models by deploying the 1.14.0 version of the CMDB CI Class Models store app from the ServiceNow Store. Verify permissions for Cassandra commands for UNIX : For the list of Cassandra commands, see the [Cassandra (for UNIX)](https://servicenow-prod.fluidtopics.net/PWerd39b5nEL~pJPadH4lQ#r_NonSudoCommands__table_dxn_bml_mmb) section in [Service Mapping commands requiring a privileged user](https://servicenow-prod.fluidtopics.net/KmX~uDsV3RoqnUbrW~2SFA "Service Mapping uses commands requiring elevated rights to discover and map Unix-based hosts in your organization. In addition to configuring necessary credentials, configure servers in your organization to allow Service Mapping to run these commands with elevated rights."). Verify read access to cassandra.yaml : Possible locations of the cassandra.yaml file: * `$config_directory + "/cassandra.yaml"` * `$process.environmentVariables.CASSANDRA_CONF.value + "/cassandra.yaml"` * `$install_directory + "/conf/cassandra.yaml"` {#cassandra-discovery__ul_mrg_xqk_ncc} ## Data collected by Discovery for Cassandra database {#cassandra-discovery__section_xj5_jjsg6_fdb} Discovery populates the data in the CMDB when running the Cassandra Distributed DB pattern. {#cassandra-discovery__table_ngb_ssk_ncc__entry__2} | Field | Description | |-|-| | Name \[name\] | Name of the cluster as well serves as a display name | [Table 1. Cassandra Cluster \[cmdb_ci_cassandra_cluster\]] {#cassandra-discovery__table_ngb_ssk_ncc} {#cassandra-discovery__table_fdh_tsk_ncc__entry__2} | Field | Description | |-|-| | Cluster \[cluster\] | Reference of the Cassandra cluster CI in which this node is part of. | | Cluster Name \[cluster_name\] | Name of the cluster. | | IP Address \[ip_address\] | IP Address of the cluster node (host machine). | | Name \[name\] | Display name in the following format: cluster_name@hostname. | | Operational status \[operational_status\] | Operational status of the cluster node. | | Server \[server\] | Reference of server (host machine) CI | [Table 2. Cassandra Cluster Node \[cmdb_ci_cassandra_cluster_node\]] {#cassandra-discovery__table_fdh_tsk_ncc} {#cassandra-discovery__table_m13_tsk_ncc__entry__2} | Field | Description | |-|-| | Cluster Name \[cluster_name\] | Name of the cluster. | | Configuration directory \[config_directory\] | Directory path where configuration files are available. | | Configuration file \[config_file\] | File path of base init configuration file where other configuration-related paths can be configured. | | Data Center \[data_center\] | Data center in which the cluster node is part of a cluster. | | Installation directory \[install_directory\] | The installation path. | | IP Address \[ip_address\] | IP address of the host machine where the process is running. | | Name \[name\] | Display name which is the same as the \. | | PID \[pid\] | Process ID running on the host machine. | | Rack \[rack\] | The rack information in which the cluster node is part of. | | Description \[short_description\] | The short description of the instance. | | TCP port(s) \[tcp_port\] | List of TCP ports configured as in "cassandra.yaml" configuration file (Format: ":port1:port2:port3:") | | UID \[uid\] | The unique ID to identify the instance (Format: \__\__\@hostname). | | Vendor \[vendor\] | Vendor name for reference from "core_company" table if already available. If it is not available, a new entry is logically created with the name "Apache" or "DataStax". | | Workload Running \[workload_running\] | The name of the workload running on the instance. | [Table 3. Cassandra Instance \[cmdb_ci_cassandra_instance\]] {#cassandra-discovery__table_m13_tsk_ncc} {#cassandra-discovery__table_st3_tsk_ncc__entry__2} | Field | Description | |-|-| | Cluster \[cluster\] | The reference of Cassandra cluster CI in which the keyspace is part of. | | Cluster Name \[cluster_name\] | Name of the cluster in which the keyspace is part of. | | Keyspace Name \[keyspace_name\] | Name of the keyspace. | | Name \[name\] | The display name in the following format: \@\. | [Table 4. Cassandra Keyspace \[cmdb_ci_cassandra_keyspace\]] {#cassandra-discovery__table_st3_tsk_ncc} Figure 1. Dependency Views showing discovered Apache Cassandra deployment ## CI relationships {#cassandra-discovery__section_tvb_xrn_wmb} Discovery creates these relationships to support the Apache Cassandra database discovery.{#cassandra-discovery__table_uvb_xrn_wmb__entry__3} | CI | Relationship | CI | |-|-|-| | Cassandra Instance \[cmdb_ci_cassandra_instance\] | Runs on::Runs | Server \[cmdb_ci_server\] | | Cassandra Cluster Node \[cmdb_ci_cassandra_cluster_node\] | Hosted on::Hosts | Server \[cmdb_ci_server\] | | Cassandra Cluster Node \[cmdb_ci_cassandra_cluster_node\] | Cluster of::Cluster | Cassandra Cluster \[cmdb_ci_cassandra_cluster\] | | Cassandra Keyspace \[cmdb_ci_cassandra_keyspace\] | Hosted on::Hosts | Cassandra Cluster \[cmdb_ci_cassandra_cluster\] | [ ] {#cassandra-discovery__table_uvb_xrn_wmb} ## Data discovered by Service Mapping during top-down discovery {#cassandra-discovery__section_zcm_wrm_wmb} Service Mapping performs the top-down discovery of Cassandra, which typically runs as a distributed database on a cluster of server nodes. During top-down discovery, Service Mapping discovers instances running on nodes and displays them on the application service map. In addition to the tables and fields discovered during horizontal discovery, the top-down discovery also discovers the fields listed in the following table. {#cassandra-discovery__table_adm_wrm_wmb__entry__2} | Field | Description | |-|-| | Keyspaces \[keyspaces\] | Keyspace(s) the instance can access (populated only in top-down discovery). | [Table 5. Cassandra Instance \[cmdb_ci_cassandra_instance\]] {#cassandra-discovery__table_adm_wrm_wmb} For incoming connections, the instance is discovered, as shown in the following image. Figure 2. Cassandra discovery top-down service map **Related concepts** * [Database Administrator (DBA) report discovery](https://servicenow-prod.fluidtopics.net/eLVe8e7rIpxxjlz1~ahIgQ "Discovery and Service Mapping uses the Patterns extension sections to provide a Database Administrator report (DBA report) for the Apache Cassandra, Microsoft SQL, MySQL, MongoDB, and Oracle databases. The extension sections for each DB pattern populate the related entries tables. Discovering some of these resources may require updating to the latest version of the Discovery and Service Mapping Patterns application from the ServiceNow Store.")