Skip to main content

Agents and modules generated by the plugin

The plugin will create an agent for the Redis instance with the name specified in the configuration. If no name is specified, the agent name will be <redis_<host redis>>.

Running the integration will create the defined custom query modules and the following modules in the agents:

If the Scan server stats token is enabled:

- redis_version
- redis_git_sha1
- redis_git_dirty
- redis_build_id
- redis_mode
- os
- arch_bits
- monotonic_clock
- multiplexing_api
- atomicvar_api
- gcc_version
- process_id
- process_supervised
- run_id
- tcp_port
- server_time_usec
- uptime_in_seconds
- uptime_in_days
- hz
- configured_hz
- lru_clock
- executable
- config_file
- io_threads_active
- listener0

If the Scan clients stats token is enabled:

- connected_clients
- cluster_connections
- maxclients
- client_recent_max_input_buffer
- client_recent_max_output_buffer
- blocked_clients
- tracking_clients
- pubsub_clients
- watching_clients
- clients_in_timeout_table
- total_watched_keys
- total_blocking_keys
- total_blocking_keys_on_nokey

If the Scan memory stats token is enabled:

- used_memory
- used_memory_human
- used_memory_rss
- used_memory_rss_human
- used_memory_peak
- used_memory_peak_human
- used_memory_peak_time
- used_memory_peak_perc
- used_memory_overhead
- used_memory_startup
- used_memory_dataset
- used_memory_dataset_perc
- allocator_allocated
- allocator_active
- allocator_resident
- allocator_muzzy
- total_system_memory
- total_system_memory_human
- used_memory_lua
- used_memory_vm_eval
- used_memory_lua_human
- used_memory_scripts_eval
- number_of_cached_scripts
- number_of_functions
- number_of_libraries
- used_memory_vm_functions
- used_memory_vm_total
- used_memory_vm_total_human
- used_memory_functions
- used_memory_scripts
- used_memory_scripts_human
- maxmemory
- maxmemory_human
- maxmemory_policy
- allocator_frag_ratio
- allocator_frag_bytes
- allocator_rss_ratio
- allocator_rss_bytes
- rss_overhead_ratio
- rss_overhead_bytes
- mem_fragmentation_ratio
- mem_fragmentation_bytes
- mem_not_counted_for_evict
- mem_replication_backlog
- mem_total_replication_buffers
- mem_replica_full_sync_buffer
- mem_clients_slaves
- mem_clients_normal
- mem_cluster_links
- mem_aof_buffer
- mem_allocator
- mem_overhead_db_hashtable_rehashing
- active_defrag_running
- lazyfree_pending_objects
- lazyfreed_objects


If the Scan persistence stats token is enabled:

- loading
- async_loading
- current_cow_peak
- current_cow_size
- current_cow_size_age
- current_fork_perc
- current_save_keys_processed
- current_save_keys_total
- rdb_changes_since_last_save
- rdb_bgsave_in_progress
- rdb_last_save_time
- rdb_last_bgsave_status
- rdb_last_bgsave_time_sec
- rdb_current_bgsave_time_sec
- rdb_saves
- rdb_last_cow_size
- rdb_last_load_keys_expired
- rdb_last_load_keys_loaded
- aof_enabled
- aof_rewrite_in_progress
- aof_rewrite_scheduled
- aof_last_rewrite_time_sec
- aof_current_rewrite_time_sec
- aof_last_bgrewrite_status
- aof_rewrites
- aof_rewrites_consecutive_failures
- aof_last_write_status
- aof_last_cow_size
- module_fork_in_progress
- module_fork_last_cow_size


If the Scan threads stats token is enabled:

-io_thread_0

If the Scan stats token is enabled:

- total_connections_received
- total_commands_processed
- instantaneous_ops_per_sec
- total_net_input_bytes
- total_net_output_bytes
- total_net_repl_input_bytes
- total_net_repl_output_bytes
- instantaneous_input_kbps
- instantaneous_output_kbps
- instantaneous_input_repl_kbps
- instantaneous_output_repl_kbps
- rejected_connections
- sync_full
- sync_partial_ok
- sync_partial_err
- expired_subkeys
- expired_keys
- expired_stale_perc
- expired_time_cap_reached_count
- expire_cycle_cpu_milliseconds
- evicted_keys
- evicted_clients
- evicted_scripts
- total_eviction_exceeded_time
- current_eviction_exceeded_time
- keyspace_hits
- keyspace_misses
- pubsub_channels
- pubsub_patterns
- pubsubshard_channels
- latest_fork_usec
- total_forks
- migrate_cached_sockets
- slave_expires_tracked_keys
- active_defrag_hits
- active_defrag_misses
- active_defrag_key_hits
- active_defrag_key_misses
- total_active_defrag_time
- current_active_defrag_time
- tracking_total_keys
- tracking_total_items
- tracking_total_prefixes
- unexpected_error_replies
- total_error_replies
- dump_payload_sanitizations
- total_reads_processed
- total_writes_processed
- io_threaded_reads_processed
- io_threaded_writes_processed
- io_threaded_total_prefetch_batches
- io_threaded_total_prefetch_entries
- client_query_buffer_limit_disconnections
- client_output_buffer_limit_disconnections
- reply_buffer_shrinks
- reply_buffer_expands
- eventloop_cycles
- eventloop_duration_sum
- eventloop_duration_cmd_sum
- instantaneous_eventloop_cycles_per_sec
- instantaneous_eventloop_duration_usec
- acl_access_denied_auth


If the Scan replication stats token is enabled

- role
- connected_slaves
- master_failover_state
- master_replid
- master_replid2
- master_repl_offset
- second_repl_offset
- repl_backlog_active
- repl_backlog_size
- repl_backlog_first_byte_offset
- repl_backlog_histlen

If the Scan CPU stats token is enabled:

- used_cpu_sys
- used_cpu_user
- used_cpu_sys_children
- used_cpu_user_children
- used_cpu_sys_main_thread
- used_cpu_user_main_thread

If the Scan command stats token is enabled

- cmdstat_FT.SEARCH
- cmdstat_ping
- cmdstat_config|get
- cmdstat_info
- cmdstat_client|setinfo

If the Scan latency stats token is enabled:

- latency_percentiles_usec_FT.SEARCH
- latency_percentiles_usec_ping
- latency_percentiles_usec_config|get
- latency_percentiles_usec_info
- latency_percentiles_usec_client|setinfo

If the Scan cluster stats token is enabled:

-cluster_enabled

If the Scan modules stats token is enabled:

- modules
- search_version
- search_redis_version
- search_number_of_indexes
- search_number_of_active_indexes
- search_number_of_active_indexes_running_queries
- search_number_of_active_indexes_indexing
- search_total_active_write_threads
- search_total_indexing_time
- search_fields_text
- search_fields_numeric
- search_fields_tag
- search_used_memory_indexes
- search_used_memory_indexes_human
- search_smallest_memory_index
- search_smallest_memory_index_human
- search_largest_memory_index
- search_largest_memory_index_human
- search_used_memory_vector_index
- search_global_idle_user
- search_global_idle_internal
- search_global_total_user
- search_global_total_internal
- search_gc_bytes_collected
- search_gc_total_cycles
- search_gc_total_ms_run
- search_gc_total_docs_not_collected
- search_gc_marked_deleted_vectors
- search_total_queries_processed
- search_total_query_commands
- search_total_query_execution_time_ms
- search_total_active_queries
- search_errors_indexing_failures
- search_errors_for_index_with_max_failures
- search_OOM_indexing_failures_indexes_count
- search_dialect_1
- search_dialect_2
- search_dialect_3
- search_dialect_4
- search_extension_load
- search_friso_ini
- search_enableGC
- search_minimal_term_prefix
- search_minimal_stem_length
- search_maximal_prefix_expansions
- search_query_timeout_ms
- search_timeout_policy
- search_cursor_read_size
- search_cursor_max_idle_time
- search_max_doc_table_size
- search_max_search_results
- search_max_aggregate_results
- search_gc_scan_size
- search_min_phonetic_term_length
- search_bm25std_tanh_factor


If the Scan keyspace stats token is enabled:

-db0

If the Scan error stats token is enabled:

-errorstat_Expected