Splunk® Common Information Model Add-on

Common Information Model Add-on Manual

Download manual as PDF

This documentation does not apply to the most recent version of CIM. Click here for the latest version.
Download topic as PDF

Databases

The fields and tags in the Databases data model describe events that pertain to structured and semi-structured data storage.

Tags used with Databases event objects

Object name Tag name
All_Databases database
|____ Database_Instance
instance
|____ Instance_Stats
stats
|____ Session_Info
session
|____ Lock_Info
lock
|____ Database_Query
query
|____ Tablespace
tablespace
|____ Query_Stats
stats

Fields for Databases event objects

Object name Field name Data type Description Possible values
All_Databases dest string The destination of the database event. May be aliased from more specific fields, such as dest_host, dest_ip, or dest_name.
All_Databases object string The name of the database object.
All_Databases product string The product name of the database system, such as MySQL or Mongo.
All_Databases src string The source of the database event. May be aliased from more specific fields, such as src_host, src_ip, or src_name.
All_Databases tag string This automatically generated field is used to access tags from within datamodels. Add-on builders do not need to populate it.
All_Databases vendor string The database vendor.
Database_Instance instance_name string The name of the database instance.
Database_Instance instance_version string The version of the database instance.
Database_Instance process_limit Number The maximum number of processes that the database instance can handle.
Database_Instance session_limit Number The maximum number of sessions that the database instance can handle.
Instance_Stats availability String The status of the database server. Available, Not Available
Instance_Stats avg_executions Number The average number of executions for the database instance.
Instance_Stats dump_area_used String The amount of the database dump area that has been used.
Instance_Stats instance_reads Number The total number of reads for the database instance.
Instance_Stats instance_writes Number The total number of writes for the database instance.
Instance_Stats number_of_users Number The total number of users for the database instance.
Instance_Stats processes Number The number of processes currently running for the database instance.
Instance_Stats sessions Number The total number of sessions currently in use for the database instance.
Instance_Stats sga_buffer_cache_size Number The total size of the buffer cache for the database instance, in bytes.
Instance_Stats sga_buffer_hit_limit Number The maximum number of number of buffers that can be hit in the database instance without finding a free buffer.
Instance_Stats sga_data_dict_hit_ratio Number The hit-to-miss ratio for the database instance's data dictionary.
Instance_Stats sga_fixed_area_size Number The size of the fixed area (also referred to as the fixed SGA) for the database instance, in bytes.
Instance_Stats sga_free_memory Number The total amount of free memory in the database instance SGA, in bytes.
Instance_Stats sga_library_cache_size Number The total library cache size for the database instance, in bytes.
Instance_Stats sga_redo_log_buffer Number The total size of the redo log buffer for the database instance, in bytes
Instance_Stats sga_shared_pool Number The total size of the shared pool for this database instance, in bytes.
Instance_Stats sga_sql_area_size Number The total size of the SQL area for this database instance, in bytes.
Instance_Stats start_time String The total amount of uptime for the database instance.
Instance_Stats tablespace_used String The total amount of tablespace used for the database instance, in bytes.
Session_Info buffer_cache_hit_ratio Number The percentage of logical reads from the buffer during the session (1-physical reads/session logical reads*100).
Session_Info commits Number The number of commits per second performed by the user associated with the session.
Session_Info cpu_used Number The number of CPU centiseconds used by the session. Divide this value by 100 to get the CPU seconds.
Session_Info cursor Number The number of the cursor currently in use by the session.
Session_Info elapsed_time Number The total amount of time elapsed since the user started the session by logging into the database server, in seconds.
Session_Info logical_reads Number The total number of consistent gets and database block gets performed during the session.
Session_Info machine String The name of the logical host associated with the database instance.
Session_Info memory_sorts Number The total number of memory sorts performed during the session.
Session_Info physical_reads Number The total number of physical reads performed during the session.
Session_Info seconds_in_wait Number The description of seconds_in_wait depends on the value of wait_time. If wait_time = 0, seconds_in_wait is the number of seconds spent in the current wait condition. If wait_time has a nonzero value, seconds_in_wait is the number of seconds that have elapsed since the start of the last wait. You can get the active seconds that have elapsed since the last wait ended by calculating seconds_in_wait - wait_time / 100.
Session_Info session_id String The unique id that identifies the session.
Session_Info session_status String The current status of the session. Online, Offline.
Session_Info table_scans Number Number of table scans performed during the session.
Session_Info user String Name of the database process user.
Session_Info wait_state String Provides the current wait state for the session. Can indicate that the session is currently waiting or provide information about the session's last wait. WAITING (the session is currently waiting), WAITED UNKNOWN TIME (the duration of the last session wait is unknown), WAITED SHORT TIME (the last session wait was < 1/100th of a second), WAITED KNOWN TIME (the wait_time is the duration of the last session wait).
Session_Info wait_time Number When wait_time = 0, the session is waiting. When wait_time has a nonzero value, it is displaying the last wait time for the session.
Lock_Info last_call_minute Number Represents the amount of time elapsed since the session_status changed to its current status. The definition of this field depends on the session_status value. If session_status = ONLINE, the last_call_minute value represents the time elapsed since the session became active. If session_status = OFFLINE, the last_call_minute value represents the time elapsed since the session became inactive.
Lock_Info lock_mode String The mode of the lock on the object.
Lock_Info lock_session_id String The session identifier of the locked object.
Lock_Info logon_time Number The database logon time for the session.
Lock_Info obj_name String The name of the locked object.
Lock_Info os_pid String The process identifier for the operating system.
Lock_Info serial_num String The mode of the lock on the object.
Database_Query query_id String The identifier for the database query.
Database_Query query_time String The time the system initiated the database query.
Tablespace free_bytes Number The total amount of free space in the tablespace, in bytes.
Tablespace tablespace_name String The name of the tablespace.
Tablespace tablespace_reads Number The number of tablespace reads carried out by the query.
Tablespace tablespace_status String The status of the tablespace. Offline, Online, Read Only
Tablespace tablespace_writes Number The number of tablespace writes carried out by the query.
Query_Stats indexes_hit String The names of the index or indexes hit by the database query.
Query_Stats query_plan_hit String The name of the query plan hist by the query.
Query_Stats stored_procedures_called String The names of the stored procedures called by the query.
Query_Stats tables_hit String The names of the tables hit by the query.
PREVIOUS
Change Analysis
  NEXT
Email

This documentation applies to the following versions of Splunk® Common Information Model Add-on: 4.0.0


Was this documentation topic helpful?

Enter your email address, and someone from the documentation team will respond to you:

Please provide your comments here. Ask a question or make a suggestion.

You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters