Ranger KMS Server Metrics

Reference information for Ranger KMS Server Metrics

In addition to these base metrics, many aggregate metrics are available. If an entity type has parents defined, you can formulate all possible aggregate metrics using the formula base_metric_across_parents.

In addition, metrics for aggregate totals can be formed by adding the prefix total_ to the front of the metric name.

Use the type-ahead feature in the Cloudera Manager chart browser to find the exact aggregate metric name, in case the plural form does not end in "s".

For example, the following metric names may be valid for Ranger KMS Server:

  • alerts_rate_across_clusters
  • total_alerts_rate_across_clusters

Some metrics, such as alerts_rate, apply to nearly every metric context. Others only apply to a certain service or role.

alerts_rate

Description
The number of alerts.
Unit
events per second
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 5.0.0..CDH 6.0.0), [CDH 6.0.0..CDH 7.0.0), [CDH 7.0.0..CDH 8.0.0), [CM -1.0.0..CM -1.0.0]

cgroup_cpu_system_rate

Description
CPU usage of the role's cgroup
Unit
seconds per second
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 5.0.0..CDH 6.0.0), [CDH 6.0.0..CDH 7.0.0), [CDH 7.0.0..CDH 8.0.0), [CM -1.0.0..CM -1.0.0]

cgroup_cpu_user_rate

Description
User Space CPU usage of the role's cgroup
Unit
seconds per second
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 5.0.0..CDH 6.0.0), [CDH 6.0.0..CDH 7.0.0), [CDH 7.0.0..CDH 8.0.0), [CM -1.0.0..CM -1.0.0]

cgroup_mem_page_cache

Description
Page cache usage of the role's cgroup
Unit
bytes
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 5.0.0..CDH 6.0.0), [CDH 6.0.0..CDH 7.0.0), [CDH 7.0.0..CDH 8.0.0), [CM -1.0.0..CM -1.0.0]

cgroup_mem_rss

Description
Resident memory of the role's cgroup
Unit
bytes
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 5.0.0..CDH 6.0.0), [CDH 6.0.0..CDH 7.0.0), [CDH 7.0.0..CDH 8.0.0), [CM -1.0.0..CM -1.0.0]

cgroup_mem_swap

Description
Swap usage of the role's cgroup
Unit
bytes
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 5.0.0..CDH 6.0.0), [CDH 6.0.0..CDH 7.0.0), [CDH 7.0.0..CDH 8.0.0), [CM -1.0.0..CM -1.0.0]

cgroup_read_bytes_rate

Description
Bytes read from all disks by the role's cgroup
Unit
bytes per second
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 5.0.0..CDH 6.0.0), [CDH 6.0.0..CDH 7.0.0), [CDH 7.0.0..CDH 8.0.0), [CM -1.0.0..CM -1.0.0]

cgroup_read_ios_rate

Description
Number of read I/O operations from all disks by the role's cgroup
Unit
ios per second
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 5.0.0..CDH 6.0.0), [CDH 6.0.0..CDH 7.0.0), [CDH 7.0.0..CDH 8.0.0), [CM -1.0.0..CM -1.0.0]

cgroup_write_bytes_rate

Description
Bytes written to all disks by the role's cgroup
Unit
bytes per second
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 5.0.0..CDH 6.0.0), [CDH 6.0.0..CDH 7.0.0), [CDH 7.0.0..CDH 8.0.0), [CM -1.0.0..CM -1.0.0]

cgroup_write_ios_rate

Description
Number of write I/O operations to all disks by the role's cgroup
Unit
ios per second
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 5.0.0..CDH 6.0.0), [CDH 6.0.0..CDH 7.0.0), [CDH 7.0.0..CDH 8.0.0), [CM -1.0.0..CM -1.0.0]

cpu_system_rate

Description
Total System CPU
Unit
seconds per second
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 5.0.0..CDH 6.0.0), [CDH 6.0.0..CDH 7.0.0), [CDH 7.0.0..CDH 8.0.0), [CM -1.0.0..CM -1.0.0]

cpu_user_rate

Description
Total CPU user time
Unit
seconds per second
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 5.0.0..CDH 6.0.0), [CDH 6.0.0..CDH 7.0.0), [CDH 7.0.0..CDH 8.0.0), [CM -1.0.0..CM -1.0.0]

events_critical_rate

Description
The number of critical events.
Unit
events per second
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 5.0.0..CDH 6.0.0), [CDH 6.0.0..CDH 7.0.0), [CDH 7.0.0..CDH 8.0.0), [CM -1.0.0..CM -1.0.0]

events_important_rate

Description
The number of important events.
Unit
events per second
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 5.0.0..CDH 6.0.0), [CDH 6.0.0..CDH 7.0.0), [CDH 7.0.0..CDH 8.0.0), [CM -1.0.0..CM -1.0.0]

events_informational_rate

Description
The number of informational events.
Unit
events per second
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 5.0.0..CDH 6.0.0), [CDH 6.0.0..CDH 7.0.0), [CDH 7.0.0..CDH 8.0.0), [CM -1.0.0..CM -1.0.0]

fd_max

Description
Maximum number of file descriptors
Unit
file descriptors
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 5.0.0..CDH 6.0.0), [CDH 6.0.0..CDH 7.0.0), [CDH 7.0.0..CDH 8.0.0), [CM -1.0.0..CM -1.0.0]

fd_open

Description
Open file descriptors.
Unit
file descriptors
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 5.0.0..CDH 6.0.0), [CDH 6.0.0..CDH 7.0.0), [CDH 7.0.0..CDH 8.0.0), [CM -1.0.0..CM -1.0.0]

health_bad_rate

Description
Percentage of Time with Bad Health
Unit
seconds per second
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 5.0.0..CDH 6.0.0), [CDH 6.0.0..CDH 7.0.0), [CDH 7.0.0..CDH 8.0.0), [CM -1.0.0..CM -1.0.0]

health_concerning_rate

Description
Percentage of Time with Concerning Health
Unit
seconds per second
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 5.0.0..CDH 6.0.0), [CDH 6.0.0..CDH 7.0.0), [CDH 7.0.0..CDH 8.0.0), [CM -1.0.0..CM -1.0.0]

health_disabled_rate

Description
Percentage of Time with Disabled Health
Unit
seconds per second
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 5.0.0..CDH 6.0.0), [CDH 6.0.0..CDH 7.0.0), [CDH 7.0.0..CDH 8.0.0), [CM -1.0.0..CM -1.0.0]

health_good_rate

Description
Percentage of Time with Good Health
Unit
seconds per second
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 5.0.0..CDH 6.0.0), [CDH 6.0.0..CDH 7.0.0), [CDH 7.0.0..CDH 8.0.0), [CM -1.0.0..CM -1.0.0]

health_unknown_rate

Description
Percentage of Time with Unknown Health
Unit
seconds per second
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 5.0.0..CDH 6.0.0), [CDH 6.0.0..CDH 7.0.0), [CDH 7.0.0..CDH 8.0.0), [CM -1.0.0..CM -1.0.0]

mem_rss

Description
Resident memory used
Unit
bytes
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 5.0.0..CDH 6.0.0), [CDH 6.0.0..CDH 7.0.0), [CDH 7.0.0..CDH 8.0.0), [CM -1.0.0..CM -1.0.0]

mem_swap

Description
Amount of swap memory used by this role's process.
Unit
bytes
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 5.0.0..CDH 6.0.0), [CDH 6.0.0..CDH 7.0.0), [CDH 7.0.0..CDH 8.0.0), [CM -1.0.0..CM -1.0.0]

mem_virtual

Description
Virtual memory used
Unit
bytes
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 5.0.0..CDH 6.0.0), [CDH 6.0.0..CDH 7.0.0), [CDH 7.0.0..CDH 8.0.0), [CM -1.0.0..CM -1.0.0]

oom_exits_rate

Description
The number of times the role's backing process was killed due to an OutOfMemory error. This counter is only incremented if the Cloudera Manager "Kill When Out of Memory" option is enabled.
Unit
exits per second
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 5.0.0..CDH 6.0.0), [CDH 6.0.0..CDH 7.0.0), [CDH 7.0.0..CDH 8.0.0), [CM -1.0.0..CM -1.0.0]

read_bytes_rate

Description
The number of bytes read from the device
Unit
bytes per second
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 5.0.0..CDH 6.0.0), [CDH 6.0.0..CDH 7.0.0), [CDH 7.0.0..CDH 8.0.0), [CM -1.0.0..CM -1.0.0]

unexpected_exits_rate

Description
The number of times the role's backing process exited unexpectedly.
Unit
exits per second
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 5.0.0..CDH 6.0.0), [CDH 6.0.0..CDH 7.0.0), [CDH 7.0.0..CDH 8.0.0), [CM -1.0.0..CM -1.0.0]

uptime

Description
For a host, the amount of time since the host was booted. For a role, the uptime of the backing process.
Unit
seconds
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 5.0.0..CDH 6.0.0), [CDH 6.0.0..CDH 7.0.0), [CDH 7.0.0..CDH 8.0.0), [CM -1.0.0..CM -1.0.0]

write_bytes_rate

Description
The number of bytes written to the device
Unit
bytes per second
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 5.0.0..CDH 6.0.0), [CDH 6.0.0..CDH 7.0.0), [CDH 7.0.0..CDH 8.0.0), [CM -1.0.0..CM -1.0.0]

ranger_kms_current_key_count

Description
Request current key count
Unit
message.units.count
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 7.1.1..CDH 8.0.0)

ranger_kms_current_key_time

Description
Requests current key elapsed time
Unit
message.units.milliseconds
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 7.1.1..CDH 8.0.0)

ranger_kms_delete_key_count

Description
Requests delete key count
Unit
message.units.count
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 7.1.1..CDH 8.0.0)

ranger_kms_delete_key_time

Description
Request delete key elapsed time
Unit
message.units.milliseconds
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 7.1.1..CDH 8.0.0)

ranger_kms_eek_batch_keys_count

Description
Requests eek batch keys count
Unit
message.units.count
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 7.1.1..CDH 8.0.0)

ranger_kms_eek_decrypt_count

Description
Requests eek decrypt count
Unit
message.units.count
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 7.1.1..CDH 8.0.0)

ranger_kms_eek_decrypt_time

Description
Requests eek decrypt elapsed time
Unit
message.units.milliseconds
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 7.1.1..CDH 8.0.0)

ranger_kms_eek_generate_count

Description
Requests eek generate count
Unit
message.units.count
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 7.1.1..CDH 8.0.0)

ranger_kms_eek_generate_time

Description
Requests eek generate elapsed time
Unit
message.units.milliseconds
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 7.1.1..CDH 8.0.0)

ranger_kms_eek_reencrypt_batch_count

Description
Requests eek reencrypt batch count
Unit
message.units.count
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 7.1.1..CDH 8.0.0)

ranger_kms_eek_reencrypt_batch_time

Description
Requests eek reencrypt elapsed time
Unit
message.units.milliseconds
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 7.1.1..CDH 8.0.0)

ranger_kms_eek_reencrypt_count

Description
Requests eek reencrypt count
Unit
message.units.count
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 7.1.1..CDH 8.0.0)

ranger_kms_eek_reencrypt_time

Description
Requests eek reencrypt elapsed time
Unit
message.units.milliseconds
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 7.1.1..CDH 8.0.0)

ranger_kms_garbage_collection_max_time

Description
Garbage collection max time
Unit
message.units.milliseconds
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 7.1.1..CDH 8.0.0)

ranger_kms_garbage_collection_total_time

Description
Garbage collection total time
Unit
message.units.milliseconds
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 7.1.1..CDH 8.0.0)

ranger_kms_garbage_collector_run_count

Description
Garbage collector run count
Unit
message.units.count
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 7.1.1..CDH 8.0.0)

ranger_kms_invalidate_cache_count

Description
Requests invalidate cache count
Unit
message.units.count
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 7.1.1..CDH 8.0.0)

ranger_kms_invalidate_cache_time

Description
Requests invalidate cache elapsed time
Unit
message.units.milliseconds
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 7.1.1..CDH 8.0.0)

ranger_kms_jvm_host_processors_available_cores

Description
Available processors core on host
Unit
message.units.count
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 7.1.1..CDH 8.0.0)

ranger_kms_jvm_max_memory

Description
JVM heap max memory
Unit
bytes
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 7.1.1..CDH 8.0.0)

ranger_kms_jvm_threads_blocked

Description
JVM threads in blocked state
Unit
message.units.count
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 7.1.1..CDH 8.0.0)

ranger_kms_jvm_threads_busy

Description
JVM threads in busy state
Unit
message.units.count
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 7.1.1..CDH 8.0.0)

ranger_kms_jvm_threads_remaining

Description
JVM threads in standby/free state
Unit
message.units.count
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 7.1.1..CDH 8.0.0)

ranger_kms_jvm_threads_waiting

Description
JVM threads in waiting state
Unit
message.units.count
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 7.1.1..CDH 8.0.0)

ranger_kms_jvm_used_memory

Description
JVM heap used memory
Unit
bytes
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 7.1.1..CDH 8.0.0)

ranger_kms_key_count

Description
Requests key count
Unit
message.units.count
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 7.1.1..CDH 8.0.0)

ranger_kms_key_create_count

Description
Requests key create count
Unit
message.units.count
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 7.1.1..CDH 8.0.0)

ranger_kms_key_create_time

Description
Requests key create elapsed time
Unit
message.units.milliseconds
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 7.1.1..CDH 8.0.0)

ranger_kms_key_version_count

Description
Requests key version count
Unit
message.units.count
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 7.1.1..CDH 8.0.0)

ranger_kms_key_version_time

Description
Requests key version elapsed time
Unit
message.units.milliseconds
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 7.1.1..CDH 8.0.0)

ranger_kms_key_versions_count

Description
Requests key versions count
Unit
message.units.count
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 7.1.1..CDH 8.0.0)

ranger_kms_key_versions_time

Description
Requests key versions elapsed time
Unit
message.units.milliseconds
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 7.1.1..CDH 8.0.0)

ranger_kms_keys_elapsed_time

Description
Requests keys elapsed time
Unit
message.units.milliseconds
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 7.1.1..CDH 8.0.0)

ranger_kms_keys_metadata_count

Description
Requests keys metadata count
Unit
message.units.count
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 7.1.1..CDH 8.0.0)

ranger_kms_keys_metadata_keyname_count

Description
Requests keys metadata keyname count
Unit
message.units.count
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 7.1.1..CDH 8.0.0)

ranger_kms_keys_metadata_time

Description
Requests keys metadata elapsed time
Unit
message.units.milliseconds
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 7.1.1..CDH 8.0.0)

ranger_kms_metadata_count

Description
Requests metadata count
Unit
message.units.count
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 7.1.1..CDH 8.0.0)

ranger_kms_metadata_elapsed_time

Description
Requests metadata elapsed time
Unit
message.units.milliseconds
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 7.1.1..CDH 8.0.0)

ranger_kms_roll_new_version_count

Description
Requests roll new version count
Unit
message.units.count
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 7.1.1..CDH 8.0.0)

ranger_kms_roll_new_version_time

Description
Requests roll new version elapsed time
Unit
message.units.milliseconds
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 7.1.1..CDH 8.0.0)

ranger_kms_system_load

Description
Ranger Kms Server average load
Unit
message.units.float
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 7.1.1..CDH 8.0.0)

ranger_kms_total_call_count

Description
Requests total calls count
Unit
message.units.count
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 7.1.1..CDH 8.0.0)

ranger_kms_unauthenticated_call_count

Description
Requests unauthenticated calls count
Unit
message.units.count
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 7.1.1..CDH 8.0.0)

ranger_kms_unauthorized_call_count

Description
Requests unauthorized calls count
Unit
message.units.count
Parents
cluster, rack, ranger_kms
CDH Version
[CDH 7.1.1..CDH 8.0.0)