Skip to content
Visit booth 3171 at Google Cloud Next to see how to unlock real-time decisions at scaleMore info

Info Command Reference

The info protocol provides access to configuration and statistics for the Aerospike Database. The protocol can be accessed by clients, over telnet on the info port, or through asinfo. The examples here use asinfo.

Starting in Database 7.2:

  • The error response is standardized on ERROR:ERROR CODE:ERROR STRING. This does not apply to the UDF module.
  • In the command itself, you can send the parameter as either ns= (as before) or namespace=.  The older parameter (ns) is deprecated.
  • Using ns or id instead of namespace is deprecated in Database 7.2.

Commands

alumni-clear-std
command
Terminal window
alumni-clear-std
description

Supersedes “services-alumni” for non-TLS service. All neighbor addresses (peers-clear-std) this server has ever known about. Some diagnostic tools, eg. asadm, use alumni to enable full cluster view even during cluster disruptions.

introduced
3.11
removed
-
permission
-
output

Returns peers-generation, port, list of [ NodeIDs/Names, TLSName(ifdefined), [ List of endpoints/IPaddresses ]]

examples

bash title="Execute Command" asinfo -v "alumni-clear-std" 10,3000,[[BB9050011AC4202,,[172.17.0.5]]]

alumni-tls-std
command
Terminal window
alumni-tls-std
description

Supersedes “services-alumni” for TLS service. All neighbor addresses (peers-tls-std) this server has ever known about. Some diagnostic tools, eg. asadm, use alumni to enable full cluster view even during cluster disruptions.

introduced
3.11
removed
-
permission
-
output

Returns peers-generation, port, list of [ NodeIDs/Names, TLSName(ifdefined), [ List of endpoints/IPaddresses ]]

examples

bash title"Execute Command" asinfo -v "alumni-tls-std" 10,4333,[[BB9050011AC4202,clusternode,[172.17.0.5]]]

best-practices
command
Terminal window
best-practices
description

Report violated best-practice checks.

introduced
5.7
removed
-
permission
-
output

Returns a list of best-practice violations that occurred when the node started.

examples

bash title="Execute Command" asinfo -v "best-practices" failed_best_practices=min-free-kbytes,swappiness

bins
command
Terminal window
bins/[NAMESPACE]
description

bin usage information and used bin names for all or a particular namespace.

introduced
3.3.0
removed
7.0.0
permission
-
parameters

NAMESPACE

Where NAMESPACE is the name of a namespace that exists on this server.

output

Without NAMESPACE

stats and names for each namespace. Namespace names are suffixed with a colon ’:’ and the bin stats and names are comma ’,’ separated. Bin stat names and values are separated by an equals ’=’. The end of stats list is delimited by a semicolon ’;’ and may be followed by more namespaces.

With NAMESPACE

Returns comma ’,’ separated statistics and bin names for the provided namespace. Statistics are separated from their values by an equals ’=’.

examples

Without NAMESPACE

Terminal window
asinfo -v 'bins'
test:num-bin-names=7,bin-names-quota=65535,str_100_bin,
str_uniq_bin,int_uniq_bin,seed,dynamic_str,dynamic_int,
fill_bin;
asinfo -v 'bins'
test:num-bin-names=7,bin-names-quota=32768,str_100_bin,
str_uniq_bin,int_uniq_bin,seed,dynamic_str,dynamic_int,
fill_bin;

With NAMESPACE

Terminal window
asinfo -v 'bins/test'
num-bin-names=7,bin-names-quota=65535,str_100_bin,
str_uniq_bin,int_uniq_bin,seed,dynamic_str,
dynamic_int,fill_bin
asinfo -v 'bins/test'
num-bin-names=7,bin-names-quota=32768,str_100_bin,
str_uniq_bin,int_uniq_bin,seed,dynamic_str,
dynamic_int,fill_bin
build
command
Terminal window
build
description

Returns the build number for this server. In asadm, the table generated by info network contains this information under “Build”.

introduced
3.3.0
removed
-
permission
-
output

Aerospike build ID (version) of this server.

Version number format: Major.Minor.Build

examples

Execute Command

Terminal window
asinfo -v 'build'
3.2.8
cluster-stable
command
Terminal window
cluster-stable:size=TARGET_CLUSTER_size;ignore-migrations=TRUE/FALSE;namespace=NAMESPACE_NAME
description

The command checks if a node’s cluster-state has stabilized. A user typically runs this command across all nodes in the cluster to check if all nodes have converged to the same cluster state by checking that none of the nodes return an error and that they all return the same cluster_key. In asadm, the table generated by info network contains this information under “Cluster”.

introduced
4.3
removed
-
permission
-
parameters

size

Target size of the cluster to check the cluster-state for.

ignore-migrations

If migration state needs to be ignored when checking for cluster stability. Valid values are true or false. Default is false which does not ignore migrations.

namespace

Name of the namespace to check the cluster-state for. Not specifying the namespace will check across all namespaces.

output

Returns the current ‘cluster_key’ when the following are satisfied:

  • If ‘size’ is specified then the target node’s ‘cluster-size’ must match size.
  • If ‘ignore-migrations’ is either unspecified or ‘false’ then the target node’s migrations counts must be zero for the provided ‘namespace’ or all namespaces if ‘namespace’ is not provided.
examples

Execute Command

Terminal window
Admin+> asinfo -v "cluster-stable:ignore-migrations=true;size=3;namespace=test"
10.0.100.xxx:3000 returned:
7A54B93FDB52
10.0.100.yyy:3000 returned:
7A54B93FDB52
10.0.100.zzz:3000 returned:
7A54B93FDB52
dc/DC_NAME
command
Terminal window
dc/DC_NAME
description

Returns the XDR statistics specific to each XDR destination.

introduced
3.6.0
removed
5.0.0
permission
-
output

Returns the statistics such as the state of the destination, the timelag, the number of shipping and delete attempts to each remote datacenter etc. These are valid and available for the datacenters defined in the XDR stanza on the source cluster.

examples

Database 3.8 to 5.0

Terminal window
asinfo -v dc/REMOTE_DC_1 -l
dc_state=CLUSTER_UP
dc_timelag=0
dc_rec_ship_attempts=58374
dc_delete_ship_attempts=0
dc_remote_ship_ok=58121
dc_err_ship_client=38
dc_err_ship_server=0
dc_esmt_bytes_shipped=5662278
dc_esmt_ship_avg_comp_pct=0.00
dc_latency_avg_ship=0
dc_remote_ship_avg_sleep=0.000
dc_open_conn=192
dc_recs_inflight=216
dc_size=3

Up to Database 3.7.5

Terminal window
asinfo -v dc/REMOTE_DC_1 -p 3004 -l
xdr-dc-state=CLUSTER_UP
xdr-dc-timelag=0
xdr-dc-rec-ship-attempts=0
xdr-dc-delete-ship-attempts=0
esmt-bytes-shipped-compression=0
esmt-ship-compression=0.00%
lst-main=1459856431988
lst-windowship=18446744073709551615
lst-failednode=18446744073709551615
lst-localmin=0
dcs
command
Terminal window
dcs
description

Returns the list of datacenters configured in the XDR context. This includes the inactive DC’s and empty skeletons too.

introduced
-
removed
5.0.0
permission
-
examples

List of configured datacenters in XDR context

Terminal window
asinfo -v 'dcs'
DC2;DC3;DC4;DC5;DC6;DC7
dump-skew
command
Terminal window
dump-skew:
description

Print out clock skew information across the cluster nodes.

introduced
4.0
removed
-
permission
sys-admin
output

The clock skew for the cluster.

examples

Print clock skew between nodes in the log

Terminal window
asinfo -v 'dump-skew:'
ok
May 03 2018 23:54:09 GMT: INFO (skew): (skew_monitor.c:587) CSM: cluster-clock-skew:0
May 03 2018 23:54:09 GMT: INFO (skew): (skew_monitor.c:598) CSM: node:bb997a7833e1600 hlc-delta:0
May 03 2018 23:54:09 GMT: INFO (skew): (skew_monitor.c:598) CSM: node:bb96544c23e1600 hlc-delta:0
May 03 2018 23:54:09 GMT: INFO (skew): (skew_monitor.c:598) CSM: node:bb93fe99a3e1600 hlc-delta:0
eviction-reset
command
Terminal window
eviction-reset:namespace=NAMESPACE_NAME
description

Available in Database 4.5.1 and later.

Removes a namespace’s eviction void time entry in the associated SMD (System Meta Data) file. This allows some previously evicted records to be resurrected on a subsequent cold restart (only those records that have not had their persisted storage block overwritten by other records). This means that the prior eviction depth for the namespace is no longer enforced — subsequent NSUP cycles evict again with a recomputed eviction depth when another breach occurs.

introduced
4.5.1
removed
-
permission
data-admin
parameters

namespace

Name of the namespace for which to reset eviction.

output

ok

examples

Reset eviction for namespace test

Terminal window
asinfo -v 'eviction-reset:namespace=test'
feature-key
command
Terminal window
feature-key
description

For the Database Enterprise Edition, returns the contents of the feature-key-file (excluding the signature) at the time the server started.

For the Community Edition, returns the string null.

introduced
4.0
removed
-
permission
-
output

Items are separated by semicolons (default) or with the -l option, newlines.

examples

List feature keys

Terminal window
asinfo -v 'feature-key' -l
feature-key-version=2
serial-number=XXXXXXXX
valid-until-date=2021-12-31
valid-until-version=5.6
acc-command-center-app=true
acc-command-center-api=true
asdb-change-notification=true
asdb-cluster-nodes-limit=20
asdb-compression=true
asdb-encryption-at-rest=true
asdb-ldap=true
asdb-pmem=true
asdb-strong-consistency=true
mesg-jms-connector=true
mesg-kafka-connector=true
raf-realtime-analysis-framework=true
get-config
command
Terminal window
get-config[:context=CONTEXT]
get-config:context=namespace<;namespace=NAMESPACE_NAME>
description

Returns running configuration for all or a particular context. The equivalent command in asadm is show config.

introduced
3.3.0
removed
-
permission
-
parameters

context

Configuration context to retrieve.

Options:

  • namespace
  • network
  • security
  • service
  • xdr

If context is not included the behavior returns configuration for all contexts excluding namespaces.

namespace

Used for namespace context only. Name of the namespace to get the configuration for.

output

Security Report Sinks

In Database 5.6 and later, the log and syslog subcontext configuration parameters are reported individually, similar to other configuration parameters. However, in Database 5.5 and earlier, these parameters are reported in an aggregated format, as represented below.

“Security Report Sinks” show the settings of the log and syslog subcontexts of the security context. The corresponding configuration parameters do not have the -sinks suffix:

The values summarize the parameters’ true/false settings. The possible values are (default is 0):

  • 0: false in both the log and syslog subcontexts.
  • 1: true only in the log subcontext.
  • 2: true only in syslog subcontext.
  • 3: true in both subcontexts.
examples

Retrieve configuration for all contexts

Terminal window
asinfo -v "get-config" -l
advertise-ipv6=false
auto-pin=none
batch-index-threads=4
batch-max-buffers-per-queue=255
batch-max-requests=5000
batch-max-unused-buffers=256
cluster-name=null
debug-allocationamespace=none
disable-udf-execution=false
downgrading=false
enable-benchmarks-fabric=false
enable-health-check=false
enable-hist-info=false
enforce-best-practices=false
feature-key-file[0]=/etc/aerospike/features.conf
indent-allocationamespace=false
info-threads=16
keep-caps-ssd-health=false
log-local-time=false
log-millis=false
microsecond-histograms=false: migrate-fill-delay=0
migrate-max-num-incoming=4
migrate-threads=1
min-cluster-size=1
node-id=BB90DAD00290C00
node-id-interface=null
os-group-perms=false
pidfile=null
proto-fd-idle-ms=0
proto-fd-max=15000
query-max-done=100
query-threads-limit=128
run-as-daemon=true
salt-allocationamespace=false
service-threads=20
sindex-builder-threads=4
sindex-gc-period=10
stay-quiesced=false
ticker-interval=10
transaction-max-ms=1000
transaction-retry-ms=1002
vault-ca=null
vault-path=null
vault-token-file=null
vault-url=null
work-directory=/opt/aerospike
service.access-port=0
service.address=any
service.alternate-access-port=0
service.port=3000
service.tls-port=0
service.tls-access-port=0
service.tls-alternate-access-port=0
service.tls-name=null
service.disable-localhost=false
heartbeat.mode=multicast
heartbeat.multicast-group=239.1.99.222
heartbeat.port=9918
heartbeat.multicast-ttl=0
heartbeat.interval=150
heartbeat.timeout=10
heartbeat.connect-timeout-ms=500
heartbeat.mtu=1500
heartbeat.protocol=v3
fabric.tls-port=0
fabric.tls-name=null
fabric.channel-bulk-fds=2
fabric.channel-bulk-recv-threads=4
fabric.channel-ctrl-fds=1
fabric.channel-ctrl-recv-threads=4
fabric.channel-meta-fds=1
fabric.channel-meta-recv-threads=4
fabric.channel-rw-fds=8
fabric.channel-rw-recv-pools=1
fabric.channel-rw-recv-threads=16
fabric.keepalive-enabled=true
fabric.keepalive-intvl=1
fabric.keepalive-probes=10
fabric.keepalive-time=1
fabric.port=3001
fabric.recv-rearm-threshold=1024
fabric.send-threads=8
info.port=3003

Retrieve network configuration.

Terminal window
asinfo -v 'get-config:context=network' -l

Retrieve configuration for namespace test.

Terminal window
asinfo -v 'get-config:context=namespace;namespace=test' -l

For Database 5.0, display the XDR configuration of all defined datacenters.

Terminal window
asinfo -h hostIPaddress -v "get-config:context=xdr"

Same command with asadm.

Terminal window
Admin+> asinfo -h hostIPaddress -v "get-config:context=xdr"

For Database 5.0+, display the XDR configuration of a specific datacenter and all its namespaces. (Starting with Database 7.2, use “namespace=NAME” instead of ns=NAME”.`)

Terminal window
asinfo -h hostIPaddress -v "get-config:context=xdr;dc=DC1"

For Database 5.0+, display the XDR configuration a specific datacenter and a specific namespace.

(Starting with Database 7.2, use get-config “namespace=NAME”.`)

Terminal window
asinfo -h hostIPaddress -v "get-config:context=xdr;dc=DC1;namespace=test"
get-dc-config
command
Terminal window
get-dc-config
description

Returns the configurations for the XDR datacenters. For each datacenter, this lists the following information:

  • Database 3.8 to 4.9: Name of the DC, seeded destination nodes, internal to external IP mappings (if any), alternate services list in use or not, and namespaces configured to ship to the DC.
introduced
3.6.0
removed
5.0.0
permission
-
output

Return value is in the following format:

Database 4.7.0.2 to 4.9:

dc-name=DC_NAME:dc-typeAEROSPIKE|HTTP:tls-name=TLS_NAME:dc-security-config-file=</path/to/file>
nodes=IP+PORT:auth-mode=<INTERNAL|EXTERNAL|EXTERNAL-INSECURE>:int-ext-ipmap=INTERNAL-IP|EXTERNAL-IP:
dc-connectionamespace=CONNECTIONS:dc-connections-idle-ms=IDLE_TIME:dc-use-alternate-services=TRUE|FALSE:
namespaces=NS1,NS2,NS3;

Database 4.5.0.1 to 4.7.0.2:

dc-name=DC_NAME:dc-typeAEROSPIKE|HTTP:tls-name=TLS_NAME:dc-security-config-file=</path/to/file>
nodes=IP+PORT:int-ext-ipmap=INTERNAL-IP|EXTERNAL-IP:
dc-connectionamespace=CONNECTIONS:dc-connections-idle-ms=IDLE_TIME:dc-use-alternate-services=TRUE|FALSE:
namespaces=NS1,NS2,NS3;

Database 4.4.0.4 and 4.5.0.1:

dc-name=DC_NAME:dc-typeAEROSPIKE|HTTP:tls-name=TLS_NAME:nodes=IP+PORT:int-ext-ipmap=INTERNAL-IP|EXTERNAL-IP:
dc-connectionamespace=CONNECTIONS:dc-connections-idle-ms=IDLE_TIME:dc-use-alternate-services=TRUE|FALSE:
namespaces=NS1,NS2,NS3;

Database 3.15.0.1 TO 4.4.0.4:

dc-name=DC_NAME:nodes=IP+PORT:int-ext-ipmap=INTERNAL-IP|EXTERNAL-IP:
dc-connectionamespace=CONNECTIONS:dc-connections-idle-ms=IDLE_TIME:dc-use-alternate-services=TRUE|FALSE:
tls-name=TLS_NAME:namespaces=NS1,NS2,NS3;
examples

Database 4.7.0.2 to 4.9

Terminal window
asinfo -v get-dc-config
dc-name=REMOTE_DC:dc-type=aerospike:tls-name=:dc-security-config-file=/private/aerospike/security_credentials_REMOTE_DC.txt:\
nodes=192.168.100.140+3000,192.168.100.147+3000:auth-mode=internal:int-ext-ipmap=:dc-connectionamespace=64:\
dc-connections-idle-ms=55000:dc-use-alternate-services=false:namespaces=test

Database 4.5.0.1 to 4.7.0.2

Terminal window
asinfo -v get-dc-config
dc-name=REMOTE_DC:dc-type=aerospike:tls-name=:dc-security-config-file=/private/aerospike/security_credentials_REMOTE_DC.txt:\
nodes=192.168.100.140+3000,192.168.100.147+3000:int-ext-ipmap=:dc-connections=64:\
dc-connections-idle-ms=55000:dc-use-alternate-services=false:namespaces=test

Database 4.4.0.4 to 4.5.0.1

Terminal window
asinfo -v get-dc-config
dc-name=REMOTE_DC:dc-type=aerospike:tls-name=:\
nodes=192.168.100.140+3000,192.168.100.147+3000:int-ext-ipmap=:dc-connections=64:\
dc-connections-idle-ms=55000:dc-use-alternate-services=false:namespaces=test

Database3.15.0.1 to 4.4.0.4

Terminal window
asinfo -v get-dc-config
dc-name=REMOTE_DC:nodes=192.168.100.140+3000,192.168.100.147+3000:int-ext-ipmap=:dc-connectionamespace=64:\
dc-connections-idle-ms=55000:dc-use-alternate-services=false:tls-name=:namespaces=test
get-stats
command
Terminal window
get-stats:context=xdr;dc=dataCenterName
description

Returns the statistics for remote datacenters defined in the xdr of the specified host.

introduced
5.0.0
removed
-
permission
-
output

Returns a semi-colon-delimited-value list of datacenter statistics, such as the state of the destination, the timelag, the number of shipping and delete attempts to each remote datacenter defined in the XDR stanza on the source cluster.

examples

Show consolidated stats for all namespaces for datacenter someDataCenterName. (Starting with Database 7.2, use “namespace=NAME” instead of ns=NAME”.`)

Terminal window
asinfo -v "get-stats:context=xdr;dc=someDataCenterName" -l

Show XDR stats per datacenter, per namespace for datacenter DATA_CENTER_NAME. (Starting with Database 7.2, use “namespace=NAME” instead of ns=NAME”.`)

Terminal window
asinfo -v "get-stats:context=xdr;dc=DATA_CENTER_NAME;namespace=NAMESPACE_NAME" -l
health-outliers
command
Terminal window
health-outliers
description

Returns list of outliers found and their info. Requires the enable-health-check configuration to be enabled first.

The health-outliers command compares a number of metrics for each host to the same metrics for other nodes within the cluster. For instance, if looking at replication latency, for a given host the replication latency that host is experiencing is compared to the distribution of replication latencies experienced by the other nodes in the cluster.

The distributions are calculated using Inter Quartile Ranges.

A minimum of four nodes are required for this approach to work as three data points are needed to flag one of them as outlier. We cannot determine an outlier with 2 data points.

Metrics used are replication latency, device read latency, fabric connections opened, node arrivals and proxies.

Use of a statistical approach allows us to give confidence estimates with respect to how anomalous a point might be. In simple terms, the further away from existing points our node metric is, the more likely it is that a problem is indicated.

introduced
4.3.1.3
removed
-
permission
-
output

Returns a list of tuples.

id=… :

confidence-pct=… :

reason=…

where:

  • id is either node ID or the device ID which is declared as an outlier.

  • confidence-pct is a metric when high denotes that the stat is highly skewed.

  • reason is the description of the stat that is responsible for declaring id as an outlier.

examples

Execute Command

Terminal window
asinfo -v 'health-outliers' -l
id=bb9040011ac4202:confidence_pct=100:reason=fabric_connections_opened
id=bb9040011ac4202:confidence_pct=100:reason=proxies
id=bb9040011ac4202:confidence_pct=100:reason=node_arrivals
id=/opt/aerospike/data/bar2.dat:namespace=test:confidence_pct=100:reason=device_read_latency
health-stats
command
Terminal window
health-stats
description

Returns list of stats maintained by health-stats for reference. Requires the enable-health-check configuration to be enabled first.

introduced
4.3.1.3
removed
-
permission
-
output

Returns list of tuples.b

stat=…

value=…

node/device=…

where:

  • stat identifies the type of statistics.

  • valueis the current moving average.

  • node is the node id.

  • device is the device name, and the value for device_read_latency is in microseconds.

examples

Execute Command

Terminal window
asinfo -v 'health-stats' -l
stat=fabric_connections_opened:value=0:node=BB9070011AC4202
stat=fabric_connections_opened:value=0:node=BB9030011AC4202
stat=fabric_connections_opened:value=0:node=BB9050011AC4202
stat=fabric_connections_opened:value=153:node=BB9040011AC4202
stat=test_device_read_latency:value=1408:device=/opt/aerospike/data/bar1.dat:namespace=test
stat=test_device_read_latency:value=306132:device=/opt/aerospike/data/bar2.dat:namespace=test
stat=test_device_read_latency:value=11630:device=/opt/aerospike/data/bar3.dat:namespace=test
hist-track-start
command
Terminal window
hist-track-start:[back=BACK;slice=SLICE;thresholds=THRESHOLDS;hist=HIST]
description

Start or Restart histogram tracking.

introduced
3.9
removed
5.1
permission
sys-admin
parameters

hist

Histogram name - if none is provided, command applies to all namespace tracked histograms, which are the read, write, UDF and query histograms’.

[Default: all namespace tracked histograms]

Options (ns being the namespace name):

  • {ns}-read
  • {ns}-write
  • {ns}-udf
  • {ns}-query
  • batch-index

See Monitoring latencies for more information about histograms.

back

Total time span in seconds over which to cache data.

[Default: aerospike.conf value if defined, otherwise mandatory]

slice

Period in seconds at which to cache histogram data.

[Default: aerospike.conf value if defined, otherwise 10]

thresholds

Comma-separated bucket (ms) values to track, must be powers of 2.

eg. 1,4,16,64

[Default: aerospike.conf value if defined, otherwise 1,8,64]

output

On success returns “ok”, use get-config to confirm settings. To persist settings update aerospike.conf.

examples

Configure reads histogram

Terminal window
asinfo -v 'hist-track-start:hist={ns}-read;back=43200;slice=30;thresholds=1,4,16,64;'
ok

Configure all histograms

Terminal window
asinfo -v 'hist-track-start:hist={ns}-read;back=43200;thresholds=1,2,4,8,16,32;'
ok
hist-track-stop
command
Terminal window
hist-track-stop:[hist=HIST]
description

Stop histogram tracking.

introduced
3.9
removed
5.1
permission
sys-admin
parameters

hist

Histogram name - if none is provided, command applies to all namespace tracked histograms, which are the read, write, UDF and query histograms’.

[Default: all namespace tracked histograms]

Options (ns being the namespace name):

  • {ns}-read
  • {ns}-write
  • {ns}-udf
  • {ns}-query
  • batch-index

To know more about histograms, see Monitoring latencies.

output

On success returns “ok”, use get-config to confirm settings. To persist settings update aerospike.conf.

examples

Stop UDF histogram collection

Terminal window
asinfo -v 'hist-track-stop:hist={ns}-udf'
ok

Stop all histogram collection

Terminal window
asinfo -v 'hist-track-stop:'
ok
histogram
command
Terminal window
histogram:namespace=NAMESPACE_NAME;[set=SET;]type=TYPE
description

Returns a histogram snapshot for a namespace[/set] and histogram type. Prior to Database 4.5.1, the ttl histogram is computed by the namespace supervisor (NSUP), and is updated every NSUP interval or duration of an NSUP cycle (whichever is longer), while the object-size and object-size-linear histograms are updated every object-size-hist-period (default is 1 hour).

Starting with Database 4.5.1, all of these histograms are computed by NSUP and updated every nsup-hist-period (default is 1 hour).

Prior to Database 5.3, the object-size and object-size-linear histograms are not available for namespaces with storage-engine memory.

introduced
4.2.0.2
removed
-
permission
-
parameters

namespace

Name of the namespace to retrieve a histogram from.

type

Type of histogram to be retrieved.

Options:

  • ttl - Time to live distribution of records represented as a linear histogram.
  • object-size - Size distribution of objects (non-tombstones records) represented as a logarithmic histogram.
  • object-size-linear - Size distribution of objects (non-tombstones records) represented as a linear histogram.

set

(Optional) Name of a particular set to retrieve a histogram from.

output

Linear Histograms

Types: ttl, object-size-linear

Returns a linear histogram with the following format:

units=UNITS:hist-width=HIST-WIDTH:bucket-width=BUCKET-WIDTH:buckets=BUCKETS;

Where:

  • UNITS: The unit type being represented. Notice that for object-size, the unit is ‘bytes’ not ‘rblocks’.

  • HIST-WIDTH: The total size of the entire histogram.

  • BUCKET-WIDTH: The size of an individual bucket.

  • BUCKETS: 1024 comma separated counters for object-size-linear, 100 for TTL.

Logarithmic Histograms

Types: object-size

Returns a logarithmic histogram with the following format:

units=UNITS:INTERVALS

Where:

  • UNITS: The unit type being represented. Notice that for object-size, the unit is bytes’ not ‘rblocks’.
  • INTERVALS: Only intervals having a value greater than 0 are shown. Interval keys use interval notation where ’[’ means that it begins and includes this value and ’)’ means it ends at, but does not include that value. The value for each key is the number of elements that fall within this interval. Notice that the intervals will also include an SI unit such as K=[2^10 to 2^20), M=[2^20 to 2^30), G=[2^30 to 2^40), T=[2^40 to 2^50), P=[2^50 to 2^60], E=[2^60 to 2^70). Values exceeding 8E (8 Exaunits) are placed in the last bucket which would be represented as [8E-inf).
examples

Logarithmic ‘Object Size’ histogram for namespace ‘test’

Terminal window
asinfo -v 'histogram:type=object-size;namespace=test'
units=bytes:[64-128)=2964:[64K-128K)=1234

Linear ‘Object Size’ histogram for namespace ‘test’

Terminal window
asinfo -v 'histogram:type=object-size-linear;namespace=test'
units=bytes:hist-width=8388608:bucket-width=8192:buckets=0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,505,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0

Linear ‘Time to Live’ histogram for namespace ‘test’

Terminal window
asinfo -v 'histogram:namespace=test;type=ttl'
units=seconds:hist-width=2588700:bucket-width=25887:buckets=0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,517

Linear ‘Time to Live’ histogram for set ‘testset’ of namespace ‘test’

Terminal window
asinfo -v 'histogram:namespace=test;set=testset;type=ttl'
units=seconds:hist-width=2588700:bucket-width=25887:buckets=0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,500
index-pressure
command
Terminal window
index-pressure
description

Display index dirty pages. The two numbers shown in the output give the total amount of memory and the amount of memory in dirty pages (not flushed to disk). The command is most useful when the primary index is on disk. The command gives an idea of how far behind the write back process, where pages in RAM are written back to disk, is running. If the write back process runs too far behind, dirty pages accumulate in RAM and eventually the system runs out of memory. This command provides a means of tracking that.

introduced
4.8
removed
-
permission
-
examples

Display index pressure

Terminal window
$ asinfo -l -v index-pressure
test:1630212096:69632
jem-stats
command
Terminal window
jem-stats:file=path_to_file;sites=path_to_file
description

Dump information about jemalloc, the subsystem used by Aerospike to manage memory allocations, into flat files.

introduced
3.0
removed
-
permission
-
output

Dumps information about memory allocation to file and locations in which asd is allocating memory to sites. This information may be requested by Aerospike Support to help troubleshoot unexpected memory usage.

examples

Dump detailed allocation information to /tmp/jem.txt and /tmp/sites.txt.

Terminal window
asinfo -v 'jem-stats:file=/tmp/jem.txt;sites=/tmp/sites.txt'
jobs
command
Terminal window
jobs:
jobs:module=MODULE
jobs:module=MODULE;cmd=COMMAND;trid=TRANSACTIONID
jobs:module=MODULE;cmd=COMMAND;trid=TRANSACTIONID;value=VALUE
description

Command and Control for queries and scans.The equivalent command in asadm is show jobs. Note: this command is deprecated as of Database 5.7. For scan and query management with Database 5.7 or later, the recommended commands are scan-show, scan-abort, query-show, and query-abort.

introduced
4.9.0
removed
6.3.0
permission
data-admin
parameters

cmd

Action to execute against a particular transaction. Requires data-admin or sys-admin privileges for security enabled clusters.

Options:

  • get-job
  • kill-job
  • set-priority

module

Name of the module to query statistics or execute a command on.

Options:

  • scan
  • query
  • sindex-builder - Removed in Database 5.7

trid

Unique Identification number for a scan or query transaction. Use either “jobs:” or “jobs:module=MODULE” forms to find Transaction IDs.

value

Value to provide to the command.

output

Module Scan

Command Executions

Commands do not acknowledge success, but will acknowledge failure.

Job Status Responses

  • active(ok) – In Progress
  • done(ok) – Completed with no error
  • done(user-aborted) – Scan aborted by user
  • done(abandoned-unknown) – Scan aborted with unknown failure
  • done(abandoned-cluster-key) – Scan aborted due to cluster key change
  • done(abandoned-response-error) – Scan aborted due to response error
  • done(abandoned-response-timeout) – Scan aborted due to timeout
examples

Query All Job Stats

Terminal window
asinfo -v "jobs:" -l
module=scan:trid=1225169085971291877:job-type=basic:namespace=test:priority=1:n-pids-requested=1:status=done(abandoned-\
response-error):job-progress=12.38:run-time=1003:time-since-done=120794:recs-read=73362:net-i\
o-bytes=11864041:socket-timeout=30000:from=98.76.543.21+2005
module=scan:trid=6741947622470254455:job-type=basic:namespace=test:set=MySetName1:priority=1:n-pids-requested=1:status=\
done(ok):job-progress=100.00:run-time=192:time-since-done=154105:recs-read=17251:net-io-bytes\
=2253844:socket-timeout=30000:from=98.76.543.21+2005
module=scan:trid=6106310598564268407:job-type=basic:namespace=test:set=MySetName1:priority=1:n-pids-requested=1:status=\
done(ok):job-progress=100.00:run-time=149:time-since-done=302042:recs-read=3431:net-io-bytes=\
456324:socket-timeout=10000:from=98.76.543.21+2005
module=sindex-builder:trid=3:job-type=sindex-build:namespace=test:set=MySetName1:priority=2:status=d\
one(ok):job-progress=100.00:run-time=185:time-since-done=463265:recs-read=6555:net-io-bytes=0\
:socket-timeout=0:sindex-name=IdxName3
module=sindex-builder:trid=2:job-type=sindex-build:namespace=test:set=MySetName1:priority=2:status=d\
one(ok):job-progress=100.00:run-time=153:time-since-done=502038:recs-read=6555:net-io-bytes=0\
:socket-timeout=0:sindex-name=IdxName2
module=sindex-builder:trid=1:job-type=sindex-build:namespace=test:set=MySetName1:priority=2:status=d\
one(ok):job-progress=100.00:run-time=213:time-since-done=530942:recs-read=6555:net-io-bytes=0\
:socket-timeout=0:sindex-name=IdxName1

Request All Scan Stats

Terminal window
asinfo -v 'jobs:module=scan' -l
module=scan:trid=15685911422701175574:job-type=basic:\
namespace=test:set=scan1_e1:priority=0:n-pids-requested=1:\
rps=0:active-threads=0:status=done(ok):job-progress=100.00:\
run-time=0:time-since-done=12611917:recs-throttled=0:\
recs-filtered-meta=0:recs-filtered-binamespace=0:recs-succeeded=0:\
recs-failed=0:net-io-bytes=68:socket-timeout=10000:\
from=192.168.200.227+35660
Related
latencies
command
Terminal window
latencies:[hist=histogramName;]
description

Returns latency data for all enabled histograms, or a single histogram if one is specified. Only the most recent time slice (as governed by the ticker interval) is tracked. These histograms contain 17 latency buckets (ranging from 0 to 216 time units) and all are displayed, following the scale tag (for example, msec) and the transactions-per-second value. The equivalent command in asadm is show latencies. All enabled benchmarks can be tracked in Database 5.1 and later. Prior to Database 5.1 track only the auto-enabled benchmarks through the info protocol.

For information about benchmark histograms, see Histograms from Aerospike Logs.

If latency data is unavailable (if no transaction of that type has taken place), only the histogram name is printed. Example:

asinfo -v 'latencies:hist={test}-read'
{test}-read:
introduced
5.1
removed
-
permission
-
parameters

hist

Histogram name - if none is provided, command applies to the auto-enabled benchmarks.

[Default: all auto-enabled benchmarks]

Options:

  • {NAMESPACE}-batch-sub-read
  • {NAMESPACE}-batch-sub-write
  • {NAMESPACE}-batch-sub-udf
  • {NAMESPACE}-re-repl
  • {NAMESPACE}-read
  • {NAMESPACE}-udf
  • {NAMESPACE}-write
  • {NAMESPACE}-pi-query
  • {NAMESPACE}-si-query

output

Return value is in the following format: histogramName_0:timeUnit,ops/sec,threshOld_0,threshOld_1,...;histogramName_1:...

examples

Show all default histograms

Terminal window
asinfo -v 'latencies:' -l
batch-index:
{test}-read:msec,1.5,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00
{test}-write:msec,5.6,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00
{test}-udf:msec,1.7,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00
{test}-batch-sub-read:msec,1.2,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00
{test}-batch-sub-write:
{test}-batch-sub-udf:msec,1.4,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00
{test}-pi-query:
{test}-si-query:

Show read latency histogram

Terminal window
asinfo -v 'latencies:hist={test}-read'
{test}-read:msec,10.0,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00

Show write histograms with write benchmarks enabled

Terminal window
asinfo -v 'latencies:hist={test}-benchmarks-write' -l
{test}-write-start:msec,341.9,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00
{test}-write-restart:msec,0.0,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00
{test}-write-dup-res:msec,0.0,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00
{test}-write-master:msec,341.9,58.53,1.35,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00
{test}-write-repl-write:msec,0.0,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00
{test}-write-response:msec,342.0,0.03,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00,0.00
latency
command
Terminal window
latency:[hist=HISTOGRAM;][back=BACK;][duration=DURATION;][slice=SLICE]
description

The latency command was replaced by latencies in Database 5.1 and removed in Database 5.2. <br /

Returns latency and throughput information. Prints error-no-data-yet-or-back-too-small (prior to Database 5.1) or simply the histogram name (in Database 5.1) if latency data is unavailable.

introduced
3.9
removed
5.2
permission
-
parameters

hist

Histogram name - if none is provided, command applies to all namespace tracked histograms, which are the read, write, UDF and query histograms’.

[Default: all namespace tracked histograms]

Options (ns being the namespace name):

  • {ns}-query
  • {ns}-query-rec-count
  • {ns}-re-repl
  • {ns}-read
  • {ns}-udf
  • {ns}-write
  • batch-index

To know more about histograms, see Monitoring latencies.

back

Removed in Aerospike Database 5.1.

Start search this many seconds before now.

[Default: Minimum to get last slice.]

Note: Using back=0 queries starting from oldest cache.

duration

Removed in Aerospike Database 5.1.

Seconds (forward) from start to search.

[Default: 0, everything to present]

slice

Removed in Aerospike Database 5.1.

Intervals (in seconds) to analyze.

[Default: 0, everything as one slice]

output

Return value is in the following format: HISTOGRAM_0:TIME_START,ops/sec,THRESHOLD_0,THRESHOLD_1,...;HISTOGRAM_1:...

examples

Show All Latency Histograms

Terminal window
asinfo -v latency: -l
{ns}-read:23:53:38-GMT,ops/sec,>1ms,>8ms,>64ms
23:53:48,5234.4,0.54,0.02,0.00
{ns}-write:23:53:38-GMT,ops/sec,>1ms,>8ms,>64ms
23:53:48,354.7,2.34,0.77,0.00
error-no-data-yet-or-back-too-small
error-no-data-yet-or-back-too-small

Show Read Latency Histogram

Terminal window
asinfo -v 'latency:hist={ns}-read;slice=30;back=300;duration:120'
{ns}-read:23:50:28-GMT,ops/sec,>1ms,>8ms,>64ms;23:50:58,0.0,0.00,0.00,0.00;
23:51:28,0.0,0.00,0.00,0.00;23:51:58,0.0,0.00,0.00,0.00;23:52:28,0.0,0.00,0.00,0.00;
23:52:58,0.0,0.00,0.00,0.00;23:53:28,0.0,0.00,0.00,0.00;23:53:58,0.0,0.00,0.00,0.00;
23:54:28,0.0,0.00,0.00,0.00;23:54:58,0.0,0.00,0.00,0.00
log-set
command
Terminal window
log-set:id=SINK_ID;CONTEXT=VERBOSITY
description

Sets verbosity for logging contexts. set-log is a synonym. The equivalent command in asadm is manage config logging.

introduced
3.3.0
removed
-
permission
sys-admin
parameters

SINK_ID

The log identifier to make a verbosity change on. See logs for a list of SINK_IDs.

CONTEXT

The logging context to make a verbosity change on. See log for a list of CONTEXTs.

VERBOSITY

The verbosity level to make the selected context.

Options:

  • critical
  • warning
  • info
  • debug
  • detail
output

Returns ‘ok’ on success. To config change see log.

examples

Set verbosity of fabric context to debug

Terminal window
asinfo -v 'log-set:id=0;fabric=debug'
ok
Related
log
command
Terminal window
log/<LOG>
log/<LOG>/CONTEXT
description

Returns a list of logging contexts and their associated verbosity levels.

introduced
3.3.0
removed
-
permission
-
parameters

LOG

Identifier for the logged component.

CONTEXT

(Optional) Which logging context to query the verbosity.

output

If a CONTEXT is not provided

Returns Semicolon ’;’ delimited list of CONTEXT:VERBOSITY

If a CONTEXT is provided

Returns requested CONTEXT:VERBOSITY

examples

Query Verbosity Level of Fabric

Terminal window
asinfo -v 'log/0/fabric'
fabric:INFO
Related
logs
command
Terminal window
logs
description

Returns a list of log file locations in use by this server.

introduced
3.3.0
removed
-
permission
-
output

List of log “Sink IDs” and their associated output location

examples

Execute Command

Terminal window
asinfo -v 'logs'
0:/var/log/aerospike/aerospike.log
Related
mcast
command
Terminal window
mcast
description

Returns the multicast heartbeat address and port used by this server. Only available in multicast heartbeat mode.

introduced
3.3.0
removed
-
permission
-
output

MULTICAST_IP:MULTICAST_PORT for the target Aerospike server.

examples

Execute Command

Terminal window
asinfo -v 'mcast'
239.1.98.29:9918
Related
mesh
command
Terminal window
mesh
description

Returns the heartbeat address and port used by this server. Only available in mesh heartbeat mode.

introduced
3.3.0
removed
-
permission
-
output

HOST_IP:MESH_PORT for the target Aerospike server.

examples

Execute Command

Terminal window
asinfo -v 'mesh'
172.16.121.138:3002
namespace
command
Terminal window
namespace/NAMESPACE
description

Returns health and usage stats for a particular namespace.

introduced
3.3.0
removed
-
permission
-
parameters

NAMESPACE

The namespace name to query for associated configuration parameters and statistics. Some direct links for a couple of such entries: replication-factor, memory-size, objectsevicted_objects.

examples

Database 6.0 and later

Terminal window
asinfo -v 'namespace/test'-ll
s_cluster_size=1
effective_replication_factor=1
objects=500
tombstones=0
xdr_tombstones=0
xdr_bin_cemeteries=0
master_objects=500
master_tombstones=0
prole_objects=0
prole_tombstones=0
non_replica_objects=0
non_replica_tombstones=0
unreplicated_records=0
dead_partitionamespace=0
unavailable_partitionamespace=0
clock_skew_stop_writes=false
stop_writes=false
hwm_breached=false
truncating=false
current_time=382320584
non_expirable_objects=0
expired_objects=0
evicted_objects=0
evict_ttl=0
evict_void_time=0
smd_evict_void_time=0
nsup_cycle_duration=0
truncate_lut=382320545369
truncated_records=2216
sindex_gc_cleaned=0
memory_used_bytes=2342144
memory_used_data_bytes=0
memory_used_index_bytes=32000
memory_used_set_index_bytes=0
memory_used_sindex_bytes=2310144
memory_free_pct=99
xmem_namespace=1
available_bin_names=65471
device_total_bytes=2147483648
device_used_bytes=64800
device_free_pct=99
device_available_pct=98
cache_read_pct=0
storage-engine.file[0].used_bytes=64800
storage-engine.file[0].free_wblocks=253
storage-engine.file[0].write_q=0
storage-engine.file[0].writes=1
storage-engine.file[0].defrag_q=0
storage-engine.file[0].defrag_reads=0
storage-engine.file[0].defrag_writes=0
storage-engine.file[0].shadow_write_q=0
storage-engine.file[0].age=-1
record_proto_uncompressed_pct=0.000
record_proto_compression_ratio=1.000
query_proto_uncompressed_pct=0.000
query_proto_compression_ratio=1.000
pending_quiesce=false
effective_is_quiesced=false
nodes_quiesced=0
effective_prefer_uniform_balance=true
migrate_tx_partitions_imbalance=0
migrate_tx_instances=0
migrate_rx_instances=0
migrate_tx_partitions_active=0
migrate_rx_partitions_active=0
migrate_tx_partitions_initial=0
migrate_tx_partitions_remaining=0
migrate_tx_partitions_lead_remaining=0
migrate_rx_partitions_initial=0
migrate_rx_partitions_remaining=0
migrate_records_skipped=0
migrate_records_transmitted=0
migrate_record_retransmits=0
migrate_record_receives=0
migrate_signals_active=0
migrate_signals_remaining=0
appeals_tx_active=0
appeals_rx_active=0
appeals_tx_remaining=0
appeals_records_exonerated=0
client_tsvc_error=0
client_tsvc_timeout=0
client_proxy_complete=0
client_proxy_error=0
client_proxy_timeout=0
client_read_success=2476
client_read_error=1
client_read_timeout=0
client_read_not_found=5
client_read_filtered_out=79
client_write_success=8412
client_write_error=18
client_write_timeout=0
client_write_filtered_out=1
xdr_client_write_success=0
xdr_client_write_error=0
xdr_client_write_timeout=0
client_delete_success=2684
client_delete_error=1
client_delete_timeout=0
client_delete_not_found=103
client_delete_filtered_out=1
xdr_client_delete_success=0
xdr_client_delete_error=0
xdr_client_delete_timeout=0
xdr_client_delete_not_found=0
client_udf_complete=36
client_udf_error=3
client_udf_timeout=0
client_udf_filtered_out=1
client_lang_read_success=27
client_lang_write_success=9
client_lang_delete_success=0
client_lang_error=3
from_proxy_tsvc_error=0
from_proxy_tsvc_timeout=0
from_proxy_read_success=0
from_proxy_read_error=0
from_proxy_read_timeout=0
from_proxy_read_not_found=0
from_proxy_read_filtered_out=0
from_proxy_write_success=0
from_proxy_write_error=0
from_proxy_write_timeout=0
from_proxy_write_filtered_out=0
xdr_from_proxy_write_success=0
xdr_from_proxy_write_error=0
xdr_from_proxy_write_timeout=0
from_proxy_delete_success=0
from_proxy_delete_error=0
from_proxy_delete_timeout=0
from_proxy_delete_not_found=0
from_proxy_delete_filtered_out=0
xdr_from_proxy_delete_success=0
xdr_from_proxy_delete_error=0
xdr_from_proxy_delete_timeout=0
xdr_from_proxy_delete_not_found=0
from_proxy_udf_complete=0
from_proxy_udf_error=0
from_proxy_udf_timeout=0
from_proxy_udf_filtered_out=0
from_proxy_lang_read_success=0
from_proxy_lang_write_success=0
from_proxy_lang_delete_success=0
from_proxy_lang_error=0
batch_sub_tsvc_error=0
batch_sub_tsvc_timeout=0
batch_sub_proxy_complete=0
batch_sub_proxy_error=0
batch_sub_proxy_timeout=0
batch_sub_read_success=959
batch_sub_read_error=0
batch_sub_read_timeout=0
batch_sub_read_not_found=51
batch_sub_read_filtered_out=1
batch_sub_write_success=0
batch_sub_write_error=0
batch_sub_write_timeout=0
batch_sub_write_filtered_out=0
batch_sub_delete_success=0
batch_sub_delete_error=0
batch_sub_delete_timeout=0
batch_sub_delete_not_found=0
batch_sub_delete_filtered_out=0
batch_sub_udf_complete=0
batch_sub_udf_error=0
batch_sub_udf_timeout=0
batch_sub_udf_filtered_out=0
batch_sub_lang_read_success=0
batch_sub_lang_write_success=0
batch_sub_lang_delete_success=0
batch_sub_lang_error=0
from_proxy_batch_sub_tsvc_error=0
from_proxy_batch_sub_tsvc_timeout=0
from_proxy_batch_sub_read_success=0
from_proxy_batch_sub_read_error=0
from_proxy_batch_sub_read_timeout=0
from_proxy_batch_sub_read_not_found=0
from_proxy_batch_sub_read_filtered_out=0
from_proxy_batch_sub_write_success=0
from_proxy_batch_sub_write_error=0
from_proxy_batch_sub_write_timeout=0
from_proxy_batch_sub_write_filtered_out=0
from_proxy_batch_sub_delete_success=0
from_proxy_batch_sub_delete_error=0
from_proxy_batch_sub_delete_timeout=0
from_proxy_batch_sub_delete_not_found=0
from_proxy_batch_sub_delete_filtered_out=0
from_proxy_batch_sub_udf_complete=0
from_proxy_batch_sub_udf_error=0
from_proxy_batch_sub_udf_timeout=0
from_proxy_batch_sub_udf_filtered_out=0
from_proxy_batch_sub_lang_read_success=0
from_proxy_batch_sub_lang_write_success=0
from_proxy_batch_sub_lang_delete_success=0
from_proxy_batch_sub_lang_error=0
udf_sub_tsvc_error=0
udf_sub_tsvc_timeout=0
udf_sub_udf_complete=497
udf_sub_udf_error=0
udf_sub_udf_timeout=0
udf_sub_udf_filtered_out=160
udf_sub_lang_read_success=52
udf_sub_lang_write_success=304
udf_sub_lang_delete_success=141
udf_sub_lang_error=0
ops_sub_tsvc_error=0
ops_sub_tsvc_timeout=0
ops_sub_write_success=114
ops_sub_write_error=0
ops_sub_write_timeout=0
ops_sub_write_filtered_out=0
dup_res_ask=0
dup_res_respond_read=0
dup_res_respond_no_read=0
retransmit_all_read_dup_res=0
retransmit_all_write_dup_res=0
retransmit_all_write_repl_write=0
retransmit_all_delete_dup_res=0
retransmit_all_delete_repl_write=0
retransmit_all_udf_dup_res=0
retransmit_all_udf_repl_write=0
retransmit_all_batch_sub_dup_res=0
retransmit_udf_sub_dup_res=0
retransmit_udf_sub_repl_write=0
retransmit_ops_sub_dup_res=0
retransmit_ops_sub_repl_write=0
pi_query_short_basic_complete=0
pi_query_short_basic_error=0
pi_query_short_basic_timeout=0
pi_query_long_basic_complete=36
pi_query_long_basic_error=0
pi_query_long_basic_abort=0
pi_query_aggr_complete=0
pi_query_aggr_error=0
pi_query_aggr_abort=0
pi_query_udf_bg_complete=7
pi_query_udf_bg_error=0
pi_query_udf_bg_abort=0
pi_query_ops_bg_complete=2
pi_query_ops_bg_error=0
pi_query_ops_bg_abort=0
si_query_short_basic_complete=0
si_query_short_basic_error=0
si_query_short_basic_timeout=0
si_query_long_basic_complete=24
si_query_long_basic_error=1
si_query_long_basic_abort=0
si_query_aggr_complete=6
si_query_aggr_error=0
si_query_aggr_abort=0
si_query_udf_bg_complete=1
si_query_udf_bg_error=0
si_query_udf_bg_abort=0
si_query_ops_bg_complete=2
si_query_ops_bg_error=0
si_query_ops_bg_abort=0
geo_region_query_reqs=2
geo_region_query_cells=24
geo_region_query_points=0
geo_region_query_falsepos=0
re_repl_success=0
re_repl_error=0
re_repl_timeout=0
fail_xdr_forbidden=0
fail_key_busy=0
fail_generation=3
fail_record_too_big=0
fail_client_lost_conflict=0
fail_xdr_lost_conflict=0
deleted_last_bin=2
allow-ttl-without-nsup=false
background-query-max-rps=10000
conflict-resolution-policy=generation
conflict-resolve-writes=false
data-in-index=false
default-ttl=0
disable-cold-start-eviction=false
disable-write-dup-res=false
disallow-null-setname=false
enable-benchmarks-batch-sub=false
enable-benchmarks-ops-sub=false
enable-benchmarks-read=false
enable-benchmarks-udf=false
enable-benchmarks-udf-sub=false
enable-benchmarks-write=false
enable-hist-proxy=false
evict-hist-buckets=10000
evict-tenths-pct=5
high-water-disk-pct=0
high-water-memory-pct=0
ignore-migrate-fill-delay=false
index-stage-size=1073741824
index-type=shmem
max-record-size=0
memory-size=2147483648
migrate-order=5
migrate-retransmit-ms=5000
migrate-sleep=1
nsup-hist-period=3600
nsup-period=120
nsup-threads=1
partition-tree-sprigs=256
prefer-uniform-balance=true
rack-id=0
read-consistency-level-override=off
reject-non-xdr-writes=false
reject-xdr-writes=false
replication-factor=1
single-bin=false
single-query-threads=4
stop-writes-pct=90
strong-consistency=false
strong-consistency-allow-expunge=false
tomb-raider-eligible-age=86400
tomb-raider-period=86400
transaction-pending-limit=20
truncate-threads=4
write-commit-level-override=off
xdr-bin-tombstone-ttl=86400
xdr-tomb-raider-period=120
xdr-tomb-raider-threads=1
storage-engine=device
storage-engine.file[0]=/etc/aerospike/test.dat
storage-engine.cache-replica-writes=false
storage-engine.cold-start-empty=false
storage-engine.commit-to-device=false
storage-engine.commit-min-size=0
storage-engine.compression=none
storage-engine.compression-level=0
storage-engine.data-in-memory=false
storage-engine.defrag-lwm-pct=50
storage-engine.defrag-queue-min=0
storage-engine.defrag-sleep=1000
storage-engine.defrag-startup-minimum=0
storage-engine.direct-files=false
storage-engine.disable-odsync=false
storage-engine.enable-benchmarks-storage=false
storage-engine.encryption-key-file=null
storage-engine.encryption-old-key-file=null
storage-engine.filesize=2147483648
storage-engine.flush-max-ms=1000
storage-engine.max-write-cache=67108864
storage-engine.min-avail-pct=5
storage-engine.post-write-queue=256
storage-engine.read-page-cache=false
storage-engine.scheduler-mode=null
storage-engine.serialize-tomb-raider=false
storage-engine.sindex-startup-device-scan=false
storage-engine.tomb-raider-sleep=1000
storage-engine.write-block-size=8388608
sindex.num-partitionamespace=32
geo2dsphere-within.strict=true
geo2dsphere-within.min-level=1
geo2dsphere-within.max-level=20
geo2dsphere-within.max-cells=12
geo2dsphere-within.level-mod=1
geo2dsphere-within.earth-radius-meters=6371000
namespaces
command
Terminal window
namespaces
description

Returns a list namespaces defined on this server.

introduced
3.3.0
removed
-
permission
-
output

Semicolon ’;’ delimited list of namespace names defined on this server

examples

Execute Command

Terminal window
asinfo -v 'namespaces'
test;bar
node
command
Terminal window
node
description

Node ID. Unique 15 character hex string for each node based on the mac address and port.

introduced
3.3.0
removed
-
permission
-
output

Returns the Node ID for this server.

examples

Execute Command

Terminal window
asinfo -v 'node'
BB9C5014A290C00
peers-clear-alt
command
Terminal window
peers-clear-alt
description

Supersedes “services-alternate” for non-TLS, alternate addresses. List of alternate service addresses of peer nodes.

introduced
3.11
removed
-
permission
-
output

Returns peers-generation, port, list of [ NodeIDs/Names, TLSName(if defined), [ List of endpoints/IPaddresses ]]

examples

Execute Command

Terminal window
asinfo -v "peers-clear-alt"
9,3000,[[BB9060011AC4202,,[74.125.239.53]],[BB9070011AC4202,,[74.125.239.54]]]
peers-clear-std
command
Terminal window
peers-clear-std
description

Supersedes “services” for non-TLS, standard addresses. List of addresses of neighbor cluster nodes to advertise for Application to connect.

introduced
3.11
removed
-
permission
-
output

Returns peers-generation, port, list of [ NodeIDs/Names, TLSName(if defined), [ List of endpoints/IPaddresses ]]

examples

Execute Command

Terminal window
asinfo -v "peers-clear-std"
9,3000,[[BB9040011AC4202,,[172.17.0.4]],[BB9050011AC4202,,[172.17.0.5]]]
peers-generation
command
Terminal window
peers-generation
description

Returns the generation count of the services lists (peers-clear-std, peers-tls-std). Each node in the cluster maintains a generation count of its services list. This value is incremented for every change in its services list, such as node addition/removal.

introduced
3.11
removed
-
permission
-
examples

Execute Command

Terminal window
asinfo -v "peers-generation"
10
peers-tls-alt
command
Terminal window
peers-tls-alt
description

Supersedes “services-alternate” for TLS, alternate addresses. List of alternate service addresses of peer nodes.

introduced
3.11
removed
-
permission
-
output

Returns peers-generation, port, list of [ NodeIDs/Names, TLSName(if defined), [ List of endpoints/IPaddresses ]]

examples

Execute Command

Terminal window
asinfo -v "peers-tls-alt"
9,4333,[[BB9060011AC4202,clusternode,[74.125.239.53]],[BB9070011AC4202,clusternode,[74.125.239.54]]]
peers-tls-std
command
Terminal window
peers-tls-std
description

Supersedes “services” for TLS, standard addresses. List of addresses of neighbor cluster nodes to advertise for Application to connect.

introduced
3.11
removed
-
permission
-
output

Returns peers-generation, port, list of [ NodeIDs/Names, TLSName(if defined), [ List of endpoints/IPaddresses ]]

examples

Execute Command

Terminal window
asinfo -v "peers-tls-std"
9,4333,[[BB9040011AC4202,clusternode,[172.17.0.4]],[BB9050011AC4202,clusternode,[172.17.0.5]]]
query-abort-all
command
Terminal window
query-abort-all:
description

Abort all queries running on the server node. This command kills all queries running across all the namespaces.

introduced
5.7
removed
-
permission
data-admin
output

Returns “OK - number of queries killed: x” where x is the number of aborted queries.

examples

Abort all queries

Terminal window
asinfo -v 'query-abort-all:'
OK - number of queries killed: 7
query-abort
command
Terminal window
query-abort:trid=TRANSACTIONID
description

Abort a query running on the server node.

introduced
5.7
removed
-
permission
data-admin
parameters

trid

Transaction ID to identify the query to abort. This parameter is required.

output

Returns “Ok” if the query was aborted, otherwise “Transaction Not Found”.

examples

Abort a query

Terminal window
asinfo -v 'query-abort:trid=1225169085971291877'
Ok
Related
query-show
command
Terminal window
query-show
query-show:trid=TRANSACTIONID
description

Returns information about current/recent queries on the server node. The equivalent command in asadm is show jobs queries.

introduced
5.7
removed
-
permission
-
parameters

trid

Transaction ID to identify a particular query. If this parameter is omitted, information is returned about every running monitored query, as well as all completed monitored queries, up to the limit specified by query-max-done.

output

Query Information

Query information includes:

  • trid - transaction ID of the query
  • job-type - type of query, one of:
    • basic
    • aggregation
    • background-udf
    • background-ops
  • ns - name of queried namespace
  • set - name of queried set, (only appears if the query specifies a set)
  • sindex-name - name of the secondary index for the query (only appears with Database 6.1+)
  • n-pids-requested - number of partitions requested for the query (only appears if non-zero)
  • rps - query rate (records per second) requested for the query
  • active-threads - number of threads currently processing the query
  • status - query status, one of:
    • active (ok) - in progress
    • done (ok) - completed successfully
    • done (user-aborted) - aborted by user
    • done (abandoned-unknown) - abandoned with unknown failure
    • done (abandoned-response-error) - aborted due to error responding to a client
    • done (abandoned-response-timeout) - aborted due to timeout responding to client
  • job-progress - estimated query completion percentage
  • run-time - how long the query has taken (or how long it took), in milliseconds
  • time-since-done - how long ago the query finished, in milliseconds
  • recs-throttled - number of records examined by the query for throttling purposes
  • recs-filtered-meta - number of records filtered out by an expression at the metadata level
  • recs-filtered-bins - number of records filtered out by an expression at the bin level
  • recs-succeeded - number of records successfully processed by the query
  • recs-failed - number of query records that failed processing (for example, unreadable)
  • net-io-bytes - amount of response data sent, in bytes
  • net-io-time - time taken to send response data, in milliseconds
  • socket-timeout - socket timeout for the query, in milliseconds
  • from - origin of the query request (ip-address and port)
  • udf-filename - name of the UDF source file (background-udf queries only)
  • udf-function - name of the UDF function (background-udf queries only)
  • udf-active - number of active UDF transactions (background-udf queries only)
  • ops-active - number of active background ops transactions (background-ops queries only)
examples

Get information about a query

Terminal window
asinfo -v 'query-show:trid=17933252198779880811' -l
trid=17933252198779880811
job-type=basic
ns=test
set=eg-set
sindex-name=test-bin-index
n-pids-requested=4096
rps=0
active-threads=0
status=done(ok)
job-progress=100.00
run-time=3
time-since-done=1317562
recs-throttled=0
recs-filtered-meta=0
recs-filtered-bins=0
recs-succeeded=1
recs-failed=0
net-io-bytes=150
net-io-time=0
socket-timeout=30000:from=127.0.0.1+37994
quiesce-undo
command
Terminal window
quiesce-undo
description

Revert the effects of the quiesce on the next recluster event.

The command is ignored if stay-quiesced is true for the node.

introduced
4.3.1
removed
-
permission
sys-admin
output

On success returns OK.

examples

Execute Command

Terminal window
Admin+> asinfo -v 'quiesce-undo:' with 192.168.100.233
192.168.100.233:3000 (192.168.100.233) returned:
ok
quiesce
command
Terminal window
quiesce
description

Cause a node to avoid participating as a replica after the next recluster event. Quiescing and reclustering before removing a node from the cluster prevents client timeouts that may otherwise happen when a node drops from the cluster. Quiescing can also help when decommissioning one or more nodes and it is desirable to maintain full replication during the decommissioning process. Refer to the Quiesce Node page for further details.

The command fails if stay-quiesced is true for the node. The equivalent command in asadm is manage quiesce.

introduced
4.3.1
removed
-
permission
sys-admin
output

On success returns OK.

examples

Execute Command

Terminal window
Admin+> asinfo -v 'quiesce:' with 192.168.100.233
192.168.100.233:3000 (192.168.100.233) returned:
ok
racks
command
Terminal window
racks:
description

Enterprise only feature as of Database 4.0.

Returns the rack grouping of nodes for each namespace.

introduced
3.13.0
removed
-
permission
-
parameters

namespace

Name of the namespace to query rack grouping for.

output

For each namespace, list the number of unique racks, each followed by the node_ids in the rack.

examples

Execute Command

Terminal window
asinfo -v 'racks:'
namespace=test:rack_1=BCD10DFA9290C00,BB910DFA9290C00:rack_2=BD710DFA9290C00,BC310DFA9290C00
recluster
command
Terminal window
recluster:
description

Force the cluster to advance the cluster key and rebalance. Processed by the acting principal node and ignored by other nodes. It is safe and recommended to issue the command to all the nodes in the cluster through asadm.

By using this command, certain configurations can now take effect without a node restart.

For example, no restart is necessary when used when setting roster in strong consistency mode or applying rack awareness changes.

  • When issued to a cluster with no pending migrations and no configuration changes, this command should not generate new migrations.

  • When issued to a cluster with no pending migrations, but has its rack-id dynamically changed, this command generates new migrations.

  • When issued to a cluster with ongoing migrations:

    • Cancels active migrations - this can be used to lower migrate threads-related configuration (migrate-threads / migrate-max-num-incoming) with immediate effect. The downside is you must re-process any partitions that were partially completed.
    • New initial migrations should not exceed the last observed pending migrations.
introduced
3.14.1.1
removed
-
permission
sys-admin
output

On success returns OK.

examples

Execute Command

Terminal window
Admin+> asinfo -v 'recluster:'
192.168.100.233:3000 (192.168.100.233) returned:
ok
192.168.100.215:3000 (192.168.100.215) returned:
ignored-by-non-principal
replicas-all
command
Terminal window
replicas-all
description

Displays a bitmap of the all partitions. Use asadm’s show pmap instead, which gives the human-readable equivalent.

introduced
removed
-
permission
sys-admin
output
examples

The replicas-all info command, using asadm

Terminal window
Admin+> asinfo -v replicas-all
1.0.0.127.in-addr.arpa:3100 (127.0.0.1) returned:
test:2,CQbAhIEKABVYgAWMS4gDxCkCBsEbIM8VLYwA3BLoULtgIBURK1NFKgUkLwMQKAkKgRmhVCUhgUFBqzAP4EKQEANAyMgcqBzAWtCpEOkIQMXRGACfyglogTCCpEslmRYwyYIB4TFTYSAQskRhIQA4ShE4UoeAPCMB3RUgOCkhMUTKCEhgBwBTAUhTtlwMUDEx66KmgooDo1AComhokkqasQIBHiOCPrA9zxg7AKkkQrIGCYSNc6CRwA8CAAtFyiTQCN4GIQivIwiKkfgRDAAChjgqwEgDCjEmACIQgQUzQpQMioSFUSDAJYBWVTsMSIaJHYCABDkAAdzZQ4lOYKrUC6TcwFhtyYywKMEIAKkZnAxDgFBE0DjiEBCJxkIeCIGCAEBjGFCQTSoGgAgCLkIQCwpYAwBMEEAJAyovCGGGhaCyPQQAITGSwma4EDVACQECdiGVClFUMoDRCIjiIB7hLdQTA0oRCTCyBBObwDASICVZQpwVFp5SYwAsBgRYCERw5iSUIEJBxoBUIYYAHtwI1IPVwgAIS8TMCsFhOUQA+EJOg2LQIQDCFyIBoYFCICUuAQVGSDoKvAIMTEpVJ4vM5GZQiIRBJ6ECMDEiTAsQBiBYsJI0ARgYXBLh+QDlzkFgMIwIkbKE60DkZAgIx9a//SKSJJRKJRJSJRRSSRJJRSI=dIASaQREXYqkBxACsGN8OAQo6CzgxTDo0BJOAc0AiwSRzGLIlAgYUNICEDCDxMIkJiRAAdqUfKgABIkQBx1A5jQ7BATjFSM6gSlEAxSCLgIOp5kgMNITGAF0C7DSYKmHNFTeGsakDBCpRLuUgGNBBagEJCheAcgiAkBWRVSKyLoUVAWVCF2s9pSASCMRAIrGEAUYPCB0DI3NAYYWQJBBAN3IABgEAQKAAGWAeABTGQQoVjFyBFAGP2DhjDCaAQgIcSARBjcAiMU0IAQMQcB8WIeVMqQ8NYRQtFWObKLMmEISVTtoKAAekBMJAoQBJUhioGEvo8BbTAIiBBIxGxUJNAkDE4cQFCECxBaxtEZmQDMQcAmpDYMZA0ACAImgkmpBN6iEpysLshCgTwX8wIiFdKCHGBsCqrOkCAHAN5opAlBIwhIM2MJtIYADzIA4IHbRAMAC4AYBDGomsAQI38AcAiogSCXEUoFNOSAgO81EhlimoUDAiECgiEUC+Himx6kJGUgIGBAuKRwqGCnKIQFlI0wqNazVJCogpBaUwotjAbiheIUBwo4QaNyiEgKdDkiBYIIpFsFkQuAwsaQoUCABEwApIzsAWAZ1C0YEEqAueBigRWnLWsfCoKAaAr8aMLgHxzI2CA0jEAAAAAAAGAFAABBBAyKFGImJSIopJIkyKJQ=
1.0.0.127.in-addr.arpa:3102 (127.0.0.1) returned:
test:2,MjAOaR7g8GiHCEpxlHW4EUbdGQaAVxCCwCEKAKgWDQSWhYqoUCyyBWAL0JjAgPKELKYAi8iYTB6mQICQE71AK0CBJCTjV0IfhAdS5BSmKDguJscgMDKCFMQxAoDQAoAIEiE4HIaAABqPCBuYmJwGkYYBIVhvwgxCIECNhhZSwqExtyWagO8EIgOgCQCjjAxIFERREUGwCIFcFRaEACFkBvxCoUxAwU8CAGGAwBaaqAnhkhhQDBNOJFBdfBSqAUEMpyCIBLYA2KMQIgMi8eiJeMJEPDPUYUTR7lFuGFDADSkiYGhiqp8JiDoAKkAiBjgCgAds6AZ8rAEAmHIgH0UJcAAjGISCEgEIxCAixQJGQBIcJqyQIwQZxKM0EISBhCZcnr6MJqJgEMRhDeT1wIlptMQmUOKyB7h2OMUA8phoehNJgGorWoRhMAlDbUIEZkqQAFooMKCjyEAmZEYJCyAUggOAzAUqlsRFgYBgE4oAR9IChWPKQWAtGK3CsfADY5KBGNIAGgA2IGACyiltQAGXCQgAOB0VBAgTECqQgrNkBxkQUBwpEgg9oFFARGwhFACAViKBB8W0QG1RMZCgyBQRERCvZCq+mFQFwggBIYDJOMEgBkyApkNgoOwMAm0YECaFTECEAgQ6BIEbEfaFAAAAAkkkkkkkkkkkkkkkkkkkkkk=,gUnhlmEbAgBY8KGAAYgAxpkAAlEXKI8AI8CxbgIJMMIoEhEHK8NEgAnQBkYsMwxT0UGfZARigkAYE1ZjaEAvAIpEExMMiJyAINCJGENZkUUQUCDODw1EYzoKcAwtBFZwQAgAQRlI8sVAIUQCRwCgYkDS2AcAEBKc0aogEIAENQAKCNpAdwACCShfMphMY2AxQBqiwp4IcXIi6GEpvU4KyQA1XKI7CpB9uJJ1B0kEBGAQKMaB8aywQIcCA8kEfLLzAMFk2Ej4JRBBzWjBAhcCBxgiQUADggoMAagRgggDIITJgoSUVGBgQsT2wBHYkAEdXpiQEBCAE7xcYA3AgKrmgVKEJGghaVrVO8lECpmQu8DjCRJG0HgkOBzBaTBYYZEgQEFxWASETQEYsBoCGzQCChNQpARBUEQIxzAZAGSUgQw2OIXQBQmSjFQ8AgnDkIEsmQRBDxlYMRWICzn2AA3jUdBdMZoAIQoiQk+cxBC7GAAIGpg0NpNCZRIxAAcAGERmZgFjxe+AUoPVBFQQjqoAgDLVQEIi21HEScALNQSYSAYMBSKWLXGAFAAdKZEA4bdYiVxQqCIJPRCGCgETJssiaM8AkEQAJgmKNKD4wFYQhSZfuBAwADgVTxOh/QCAhUFYEAlBdWJAyz5AigFyICgAAIQISJRSRSRSJSSSSSSJRSI=
1.0.0.127.in-addr.arpa:3101 (127.0.0.1) returned:
test:2,xMkxEmAVD4Igd7ACIAJEKpAg4DhkiCBoElL1I0UBokAJWmBGhIAI0JrQAGQvVwRxUkBeIBJGMqAYFE9gDAAvxLw+ExMAAKEgISgECwJRlwIAwThABcQVagtMWTQKZGnHJFzGAkgsnsVgRaAGRmPBJGjGjCAQAdC8AqpSQcCMDBoEQJIFeBCo3LQMQKNQI8KGABkIbDRMVC6hSIETbZQBSAG8QJA9AADAMIZEP0BBFUQYZGMigEwgG6Cgg+AQNJojUAFx2kFQBFRlTATMAhd0AQWRA4QolIoIEYyBZqoMsELRFRMYBEA2UkWpgITRsUF0YngTE8CDUiImJASRgBAihFsAJyMQJHJHEx7VOlSgI+GgWQMrDMMEK0xCKTlgc1ghYQEQwQ0PohGYchMIETSGQDGBrB0B6AeAxBDQBQYRAEwEQpHUhEoMDZAEgoi7kLRtiYRCxQ4IBT8IkzEU1MEKUChsMLDEYAsIemwELEXtmAikOAAgqAGAhFIRSAuklCkOAQlrxb2IGR+pFFCSoSJgInQqBeLisDMg5RQORAibAKShLIEGzPcASIy+GhKcy9pRqNg4sABBA5CigiUKEGAiCokAE1EAQAr4DcbcknQmwR6HSSFLWKSHAwESBJICIZgagzNzbElBED4AigFyOClAAJRJSSKRSKSJSKKJJKSSKJQ=,CjYMAJqgoHUDCE59ThSDAWLXFYIIEkAXDC0AkDD2RDlGIYwwQDSjLyQt6YlQCDGICJogmiEJARfn6CCMkKKQGUGA6OgQYkBFXgYy5KgkQLjhCEYRwCCohMSBhEMAmwAIi6MhpCATASoWmgBpOJwemBcpA9Ch7iVBLBWJqitxAkXhoyAqgKJRAEMghUSinBUIr+BFAUGDggAQFhjAAiG0NiICo0XA9G0CRwgKgLao4pvHgQgMCgNJgBgccAZhgkUEjh6KIYAHUiqKEpMyvCiBoGBIjBvASHGjSgJgEVUwRzkkKEADg5+BLSgAPWomSraAAQZATC8koEGBm+AOZEAQSqR4yBDOgoQoACAKQSAJBAwMhuQQIgTCxKM8lkYHDASeiBYKANBwAO5HAOABJEN4gUwoQ+C8BQhTMM4myAFCfKOBBWgjIjQAUivAMXYETwgCZju8EOCmwoBRRMIBIDIArAWChkA7jHSQhJBDACIAYadRRCcLQSwdEqjMB4BZIBKQgLaUIgBRhGAA44IlUFSaXIEAihEIAIQbEilgCHAEtkFSglhoEABvgyNAxGxiEAAmFiGGQRySgA9JRFrEiRTchDDWTID/gfAAwBkDLQnBAsEAAoYEpQAoEExEAEBlSgagKMSIgpCcJMG/df6Nx9a//2u2tEkoolIkklFEklJEkkk=

The output of show pmap in asadm

Terminal window
Admin+> show pmap
~~~~~~~~~~~~~~~~~~~Partition Map Analysis (2024-11-26 22:16:09 UTC)~~~~~~~~~~~~~~~~~~
Namespace| Node| Cluster Key|~~~~~~~~~~~~Partitions~~~~~~~~~~~~
| | |Primary|Secondary|Unavailable|Dead
test |1.0.0.127.in-addr.arpa:3100|5EA0F7252139| 1365| 1365| 0| 0
test |1.0.0.127.in-addr.arpa:3101|5EA0F7252139| 1365| 1366| 0| 0
test |1.0.0.127.in-addr.arpa:3102|5EA0F7252139| 1366| 1365| 0| 0
test | | | 4096| 4096| 0| 0
Number of rows: 3
replicas-master
command
Terminal window
replicas-master
description

Displays a bitmap of the master partitions. Use asadm’s show pmap instead, which gives the human-readable equivalent.

introduced
removed
-
permission
sys-admin
output
examples

The replicas-master info command, using asadm

Terminal window
Admin+> asinfo -v replicas-master
1.0.0.127.in-addr.arpa:3100 (127.0.0.1) returned:
test:CQbAhIEKABVYgAWMS4gDxCkCBsEbIM8VLYwA3BLoULtgIBURK1NFKgUkLwMQKAkKgRmhVCUhgUFBqzAP4EKQEANAyMgcqBzAWtCpEOkIQMXRGACfyglogTCCpEslmRYwyYIB4TFTYSAQskRhIQA4ShE4UoeAPCMB3RUgOCkhMUTKCEhgBwBTAUhTtlwMUDEx66KmgooDo1AComhokkqasQIBHiOCPrA9zxg7AKkkQrIGCYSNc6CRwA8CAAtFyiTQCN4GIQivIwiKkfgRDAAChjgqwEgDCjEmACIQgQUzQpQMioSFUSDAJYBWVTsMSIaJHYCABDkAAdzZQ4lOYKrUC6TcwFhtyYywKMEIAKkZnAxDgFBE0DjiEBCJxkIeCIGCAEBjGFCQTSoGgAgCLkIQCwpYAwBMEEAJAyovCGGGhaCyPQQAITGSwma4EDVACQECdiGVClFUMoDRCIjiIB7hLdQTA0oRCTCyBBObwDASICVZQpwVFp5SYwAsBgRYCERw5iSUIEJBxoBUIYYAHtwI1IPVwgAIS8TMCsFhOUQA+EJOg2LQIQDCFyIBoYFCICUuAQVGSDoKvAIMTEpVJ4vM5GZQiIRBJ6ECMDEiTAsQBiBYsJI0ARgYXBLh+QDlzkFgMIwIkbKE60DkZAgIx9a//SKSJJRKJRJSJRRSSRJJRSI
1.0.0.127.in-addr.arpa:3102 (127.0.0.1) returned:
test:MjAOaR7g8GiHCEpxlHW4EUbdGQaAVxCCwCEKAKgWDQSWhYqoUCyyBWAL0JjAgPKELKYAi8iYTB6mQICQE71AK0CBJCTjV0IfhAdS5BSmKDguJscgMDKCFMQxAoDQAoAIEiE4HIaAABqPCBuYmJwGkYYBIVhvwgxCIECNhhZSwqExtyWagO8EIgOgCQCjjAxIFERREUGwCIFcFRaEACFkBvxCoUxAwU8CAGGAwBaaqAnhkhhQDBNOJFBdfBSqAUEMpyCIBLYA2KMQIgMi8eiJeMJEPDPUYUTR7lFuGFDADSkiYGhiqp8JiDoAKkAiBjgCgAds6AZ8rAEAmHIgH0UJcAAjGISCEgEIxCAixQJGQBIcJqyQIwQZxKM0EISBhCZcnr6MJqJgEMRhDeT1wIlptMQmUOKyB7h2OMUA8phoehNJgGorWoRhMAlDbUIEZkqQAFooMKCjyEAmZEYJCyAUggOAzAUqlsRFgYBgE4oAR9IChWPKQWAtGK3CsfADY5KBGNIAGgA2IGACyiltQAGXCQgAOB0VBAgTECqQgrNkBxkQUBwpEgg9oFFARGwhFACAViKBB8W0QG1RMZCgyBQRERCvZCq+mFQFwggBIYDJOMEgBkyApkNgoOwMAm0YECaFTECEAgQ6BIEbEfaFAAAAAkkkkkkkkkkkkkkkkkkkkkk=
1.0.0.127.in-addr.arpa:3101 (127.0.0.1) returned:
test:xMkxEmAVD4Igd7ACIAJEKpAg4DhkiCBoElL1I0UBokAJWmBGhIAI0JrQAGQvVwRxUkBeIBJGMqAYFE9gDAAvxLw+ExMAAKEgISgECwJRlwIAwThABcQVagtMWTQKZGnHJFzGAkgsnsVgRaAGRmPBJGjGjCAQAdC8AqpSQcCMDBoEQJIFeBCo3LQMQKNQI8KGABkIbDRMVC6hSIETbZQBSAG8QJA9AADAMIZEP0BBFUQYZGMigEwgG6Cgg+AQNJojUAFx2kFQBFRlTATMAhd0AQWRA4QolIoIEYyBZqoMsELRFRMYBEA2UkWpgITRsUF0YngTE8CDUiImJASRgBAihFsAJyMQJHJHEx7VOlSgI+GgWQMrDMMEK0xCKTlgc1ghYQEQwQ0PohGYchMIETSGQDGBrB0B6AeAxBDQBQYRAEwEQpHUhEoMDZAEgoi7kLRtiYRCxQ4IBT8IkzEU1MEKUChsMLDEYAsIemwELEXtmAikOAAgqAGAhFIRSAuklCkOAQlrxb2IGR+pFFCSoSJgInQqBeLisDMg5RQORAibAKShLIEGzPcASIy+GhKcy9pRqNg4sABBA5CigiUKEGAiCokAE1EAQAr4DcbcknQmwR6HSSFLWKSHAwESBJICIZgagzNzbElBED4AigFyOClAAJRJSSKRSKSJSKKJJKSSKJQ=

The output of show pmap in asadm

Terminal window
Admin+> show pmap
~~~~~~~~~~~~~~~~~~~Partition Map Analysis (2024-11-26 22:16:09 UTC)~~~~~~~~~~~~~~~~~~
Namespace| Node| Cluster Key|~~~~~~~~~~~~Partitions~~~~~~~~~~~~
| | |Primary|Secondary|Unavailable|Dead
test |1.0.0.127.in-addr.arpa:3100|5EA0F7252139| 1365| 1365| 0| 0
test |1.0.0.127.in-addr.arpa:3101|5EA0F7252139| 1365| 1366| 0| 0
test |1.0.0.127.in-addr.arpa:3102|5EA0F7252139| 1366| 1365| 0| 0
test | | | 4096| 4096| 0| 0
Number of rows: 3
replicas
command
Terminal window
replicas
description

Displays a bitmap of the replica partitions. Use asadm’s show pmap instead, which gives the human-readable equivalent.

introduced
removed
-
permission
sys-admin
output
examples

The replicas info command, using asadm

Terminal window
Admin+> asinfo -v replicas
1.0.0.127.in-addr.arpa:3100 (127.0.0.1) returned:
test:0,2,CQbAhIEKABVYgAWMS4gDxCkCBsEbIM8VLYwA3BLoULtgIBURK1NFKgUkLwMQKAkKgRmhVCUhgUFBqzAP4EKQEANAyMgcqBzAWtCpEOkIQMXRGACfyglogTCCpEslmRYwyYIB4TFTYSAQskRhIQA4ShE4UoeAPCMB3RUgOCkhMUTKCEhgBwBTAUhTtlwMUDEx66KmgooDo1AComhokkqasQIBHiOCPrA9zxg7AKkkQrIGCYSNc6CRwA8CAAtFyiTQCN4GIQivIwiKkfgRDAAChjgqwEgDCjEmACIQgQUzQpQMioSFUSDAJYBWVTsMSIaJHYCABDkAAdzZQ4lOYKrUC6TcwFhtyYywKMEIAKkZnAxDgFBE0DjiEBCJxkIeCIGCAEBjGFCQTSoGgAgCLkIQCwpYAwBMEEAJAyovCGGGhaCyPQQAITGSwma4EDVACQECdiGVClFUMoDRCIjiIB7hLdQTA0oRCTCyBBObwDASICVZQpwVFp5SYwAsBgRYCERw5iSUIEJBxoBUIYYAHtwI1IPVwgAIS8TMCsFhOUQA+EJOg2LQIQDCFyIBoYFCICUuAQVGSDoKvAIMTEpVJ4vM5GZQiIRBJ6ECMDEiTAsQBiBYsJI0ARgYXBLh+QDlzkFgMIwIkbKE60DkZAgIx9a//SKSJJRKJRJSJRRSSRJJRSI=,dIASaQREXYqkBxACsGN8OAQo6CzgxTDo0BJOAc0AiwSRzGLIlAgYUNICEDCDxMIkJiRAAdqUfKgABIkQBx1A5jQ7BATjFSM6gSlEAxSCLgIOp5kgMNITGAF0C7DSYKmHNFTeGsakDBCpRLuUgGNBBagEJCheAcgiAkBWRVSKyLoUVAWVCF2s9pSASCMRAIrGEAUYPCB0DI3NAYYWQJBBAN3IABgEAQKAAGWAeABTGQQoVjFyBFAGP2DhjDCaAQgIcSARBjcAiMU0IAQMQcB8WIeVMqQ8NYRQtFWObKLMmEISVTtoKAAekBMJAoQBJUhioGEvo8BbTAIiBBIxGxUJNAkDE4cQFCECxBaxtEZmQDMQcAmpDYMZA0ACAImgkmpBN6iEpysLshCgTwX8wIiFdKCHGBsCqrOkCAHAN5opAlBIwhIM2MJtIYADzIA4IHbRAMAC4AYBDGomsAQI38AcAiogSCXEUoFNOSAgO81EhlimoUDAiECgiEUC+Himx6kJGUgIGBAuKRwqGCnKIQFlI0wqNazVJCogpBaUwotjAbiheIUBwo4QaNyiEgKdDkiBYIIpFsFkQuAwsaQoUCABEwApIzsAWAZ1C0YEEqAueBigRWnLWsfCoKAaAr8aMLgHxzI2CA0jEAAAAAAAGAFAABBBAyKFGImJSIopJIkyKJQ=
1.0.0.127.in-addr.arpa:3102 (127.0.0.1) returned:
test:0,2,MjAOaR7g8GiHCEpxlHW4EUbdGQaAVxCCwCEKAKgWDQSWhYqoUCyyBWAL0JjAgPKELKYAi8iYTB6mQICQE71AK0CBJCTjV0IfhAdS5BSmKDguJscgMDKCFMQxAoDQAoAIEiE4HIaAABqPCBuYmJwGkYYBIVhvwgxCIECNhhZSwqExtyWagO8EIgOgCQCjjAxIFERREUGwCIFcFRaEACFkBvxCoUxAwU8CAGGAwBaaqAnhkhhQDBNOJFBdfBSqAUEMpyCIBLYA2KMQIgMi8eiJeMJEPDPUYUTR7lFuGFDADSkiYGhiqp8JiDoAKkAiBjgCgAds6AZ8rAEAmHIgH0UJcAAjGISCEgEIxCAixQJGQBIcJqyQIwQZxKM0EISBhCZcnr6MJqJgEMRhDeT1wIlptMQmUOKyB7h2OMUA8phoehNJgGorWoRhMAlDbUIEZkqQAFooMKCjyEAmZEYJCyAUggOAzAUqlsRFgYBgE4oAR9IChWPKQWAtGK3CsfADY5KBGNIAGgA2IGACyiltQAGXCQgAOB0VBAgTECqQgrNkBxkQUBwpEgg9oFFARGwhFACAViKBB8W0QG1RMZCgyBQRERCvZCq+mFQFwggBIYDJOMEgBkyApkNgoOwMAm0YECaFTECEAgQ6BIEbEfaFAAAAAkkkkkkkkkkkkkkkkkkkkkk=,gUnhlmEbAgBY8KGAAYgAxpkAAlEXKI8AI8CxbgIJMMIoEhEHK8NEgAnQBkYsMwxT0UGfZARigkAYE1ZjaEAvAIpEExMMiJyAINCJGENZkUUQUCDODw1EYzoKcAwtBFZwQAgAQRlI8sVAIUQCRwCgYkDS2AcAEBKc0aogEIAENQAKCNpAdwACCShfMphMY2AxQBqiwp4IcXIi6GEpvU4KyQA1XKI7CpB9uJJ1B0kEBGAQKMaB8aywQIcCA8kEfLLzAMFk2Ej4JRBBzWjBAhcCBxgiQUADggoMAagRgggDIITJgoSUVGBgQsT2wBHYkAEdXpiQEBCAE7xcYA3AgKrmgVKEJGghaVrVO8lECpmQu8DjCRJG0HgkOBzBaTBYYZEgQEFxWASETQEYsBoCGzQCChNQpARBUEQIxzAZAGSUgQw2OIXQBQmSjFQ8AgnDkIEsmQRBDxlYMRWICzn2AA3jUdBdMZoAIQoiQk+cxBC7GAAIGpg0NpNCZRIxAAcAGERmZgFjxe+AUoPVBFQQjqoAgDLVQEIi21HEScALNQSYSAYMBSKWLXGAFAAdKZEA4bdYiVxQqCIJPRCGCgETJssiaM8AkEQAJgmKNKD4wFYQhSZfuBAwADgVTxOh/QCAhUFYEAlBdWJAyz5AigFyICgAAIQISJRSRSRSJSSSSSSJRSI=
1.0.0.127.in-addr.arpa:3101 (127.0.0.1) returned:
test:0,2,xMkxEmAVD4Igd7ACIAJEKpAg4DhkiCBoElL1I0UBokAJWmBGhIAI0JrQAGQvVwRxUkBeIBJGMqAYFE9gDAAvxLw+ExMAAKEgISgECwJRlwIAwThABcQVagtMWTQKZGnHJFzGAkgsnsVgRaAGRmPBJGjGjCAQAdC8AqpSQcCMDBoEQJIFeBCo3LQMQKNQI8KGABkIbDRMVC6hSIETbZQBSAG8QJA9AADAMIZEP0BBFUQYZGMigEwgG6Cgg+AQNJojUAFx2kFQBFRlTATMAhd0AQWRA4QolIoIEYyBZqoMsELRFRMYBEA2UkWpgITRsUF0YngTE8CDUiImJASRgBAihFsAJyMQJHJHEx7VOlSgI+GgWQMrDMMEK0xCKTlgc1ghYQEQwQ0PohGYchMIETSGQDGBrB0B6AeAxBDQBQYRAEwEQpHUhEoMDZAEgoi7kLRtiYRCxQ4IBT8IkzEU1MEKUChsMLDEYAsIemwELEXtmAikOAAgqAGAhFIRSAuklCkOAQlrxb2IGR+pFFCSoSJgInQqBeLisDMg5RQORAibAKShLIEGzPcASIy+GhKcy9pRqNg4sABBA5CigiUKEGAiCokAE1EAQAr4DcbcknQmwR6HSSFLWKSHAwESBJICIZgagzNzbElBED4AigFyOClAAJRJSSKRSKSJSKKJJKSSKJQ=,CjYMAJqgoHUDCE59ThSDAWLXFYIIEkAXDC0AkDD2RDlGIYwwQDSjLyQt6YlQCDGICJogmiEJARfn6CCMkKKQGUGA6OgQYkBFXgYy5KgkQLjhCEYRwCCohMSBhEMAmwAIi6MhpCATASoWmgBpOJwemBcpA9Ch7iVBLBWJqitxAkXhoyAqgKJRAEMghUSinBUIr+BFAUGDggAQFhjAAiG0NiICo0XA9G0CRwgKgLao4pvHgQgMCgNJgBgccAZhgkUEjh6KIYAHUiqKEpMyvCiBoGBIjBvASHGjSgJgEVUwRzkkKEADg5+BLSgAPWomSraAAQZATC8koEGBm+AOZEAQSqR4yBDOgoQoACAKQSAJBAwMhuQQIgTCxKM8lkYHDASeiBYKANBwAO5HAOABJEN4gUwoQ+C8BQhTMM4myAFCfKOBBWgjIjQAUivAMXYETwgCZju8EOCmwoBRRMIBIDIArAWChkA7jHSQhJBDACIAYadRRCcLQSwdEqjMB4BZIBKQgLaUIgBRhGAA44IlUFSaXIEAihEIAIQbEilgCHAEtkFSglhoEABvgyNAxGxiEAAmFiGGQRySgA9JRFrEiRTchDDWTID/gfAAwBkDLQnBAsEAAoYEpQAoEExEAEBlSgagKMSIgpCcJMG/df6Nx9a//2u2tEkoolIkklFEklJEkkk=

The output of show pmap in asadm

Terminal window
Admin+> show pmap
~~~~~~~~~~~~~~~~~~~Partition Map Analysis (2024-11-26 22:16:09 UTC)~~~~~~~~~~~~~~~~~~
Namespace| Node| Cluster Key|~~~~~~~~~~~~Partitions~~~~~~~~~~~~
| | |Primary|Secondary|Unavailable|Dead
test |1.0.0.127.in-addr.arpa:3100|5EA0F7252139| 1365| 1365| 0| 0
test |1.0.0.127.in-addr.arpa:3101|5EA0F7252139| 1365| 1366| 0| 0
test |1.0.0.127.in-addr.arpa:3102|5EA0F7252139| 1366| 1365| 0| 0
test | | | 4096| 4096| 0| 0
Number of rows: 3
revive
command
Terminal window
revive:namespace=NAMESPACE_NAME
description

Used to revive dead partitions in a namespace running in strong consistency mode. Should be followed by the recluster command in order to take effect. Revived nodes restore availability only when all nodes are trusted.

introduced
4.0
removed
-
permission
sys-admin
output

On success returns OK.

examples

Execute Command

Terminal window
Admin+> asinfo -v 'revive:namespace=test'
192.168.100.233:3000 (192.168.100.233) returned:
ok
192.168.100.215:3000 (192.168.100.215) returned:
ok
Related
roster-set
command
Terminal window
roster-set:namespace=NAMESPACE_NAME;nodes=OBSERVED_NODES_LIST
description

Set the roster (for namespaces running in strong consistency mode). Requires ‘recluster’ to take effect.

For removing a node from the roster, follow the Removing Nodes paragraph of the Manage Consistency documentation page. The equivalent command in asadm is manage roster.You can also use manage roster stage observed.

introduced
4.0
removed
-
permission
sys-admin
output

Set the roster for the namespace. It is safe to issue this command multiple times, once for each observed node, or create a list, but issuing it for against one node is enough (command is propagated through SMD). The roster is not active until the recluster command is issued. Validate the roster prior to issuing the recluster command by running the roster command and verifying all desired roster nodes are in the pending_roster list.

examples

Execute Command

Terminal window
Admin+> asinfo -v "roster-set:namespace=test;nodes=BB9070016AE4202,BB9060016AE4202,BB9050016AE4202,
BB9040016AE4202,BB9020016AE4202" with BB9020016AE4202
node1.aerospike.com:3000 (192.168.10.10) returned:
ok
Related
roster
command
Terminal window
roster:namespace=NAMESPACE_NAME
description

Show roster information (for namespaces running in strong consistency mode). The equivalent command in asadm is show roster.

introduced
4.0
removed
-
permission
-
output

Returns the list of node currently in the roster.

examples

Execute Command

Terminal window
Admin+> asinfo -v "roster:namespace=test"
node1.aerospike.com:3000 (192.168.10.10) returned:
roster=null:pending_roster=null:observed_nodes=BB9070016AE4202,BB9060016AE4202,BB9050016AE4202,BB9040016AE4202,BB9020016AE4202
node2.aerospike.com:3000 (192.168.10.11) returned:
roster=null:pending_roster=null:observed_nodes=BB9070016AE4202,BB9060016AE4202,BB9050016AE4202,BB9040016AE4202,BB9020016AE4202
node3.aerospike.com:3000 (192.168.10.12) returned:
roster=null:pending_roster=null:observed_nodes=BB9070016AE4202,BB9060016AE4202,BB9050016AE4202,BB9040016AE4202,BB9020016AE4202
node4.aerospike.com:3000 (192.168.10.13) returned:
roster=null:pending_roster=null:observed_nodes=BB9070016AE4202,BB9060016AE4202,BB9050016AE4202,BB9040016AE4202,BB9020016AE4202
node5.aerospike.com:3000 (192.168.10.14) returned:
roster=null:pending_roster=null:observed_nodes=BB9070016AE4202,BB9060016AE4202,BB9050016AE4202,BB9040016AE4202,BB9020016AE4202
node6.aerospike.com:3000 (192.168.10.15) returned:
roster=null:pending_roster=null:observed_nodes=BB9070016AE4202,BB9060016AE4202,BB9050016AE4202,BB9040016AE4202,BB9020016AE4202
Related
scan-abort-all
command
Terminal window
scan-abort-all:
description

Abort all scans running on the server node, across all namespaces. This info command was deprecated in Database 6.0, and removed in Database 6.4. Use query-abort-all instead.

introduced
3.5.12
removed
6.4
permission
data-admin
output

Returns “OK - number of scans killed: x” where x is the number of aborted scans.

examples

Abort all scans

Terminal window
asinfo -v 'scan-abort-all:'
OK - number of scans killed: 7
scan-abort
command
Terminal window
scan-abort:id=TRANSACTIONID
description

Abort a scan running on the server node. This info command was deprecated in Database 6.0, and removed in Database 6.4. Use query-abort instead.

introduced
3.3
removed
6.4
permission
data-admin
parameters

id

Transaction ID to identify the scan to abort. This parameter is required.

output

Returns “OK” if the scan was aborted, otherwise a “Transaction Not Found” error.

examples

Abort a scan

Terminal window
asinfo -v 'scan-abort:trid=1225169085971291877'
OK
scan-show
command
Terminal window
scan-show
scan-show:trid=TRANSACTIONID
description

Returns information about current/recent scans on the server node. This info command was deprecated in Database 6.0, and removed in Database 6.4. Use query-show instead. The equivalent command in asadm is show jobs scans.

introduced
5.7
removed
6.4
permission
-
parameters

trid

Transaction ID to specify a particular scan. If this parameter is omitted, information is returned about every running scan, as well as all completed scans, up to the limit specified by query-max-done

output

Scan Information

Scan information includes:

  • trid - transaction ID of the scan
  • job-type - type of scan, one of:
    • basic
    • aggregation
    • background-udf
    • background-ops
  • ns - name of scanned namespace
  • set - name of scanned set (only appears if scan specifies a set)
  • n-pids-requested - number of partitions requested for the scan (only appears if nonzero)
  • rps - scan rate (records per second) requested for the scan
  • active-threads - number of threads currently processing the scan
  • status - scan status, one of:
    • active(ok) - in progress
    • done(ok) - completed successfully
    • done(user-aborted) - aborted by user
    • done(abandoned-unknown) - abandoned with unknown failure
    • done(abandoned-response-error) - aborted due to error responding to client
    • done(abandoned-response-timeout) - aborted due to timeout responding to client
  • job-progress - estimated scan completion percentage
  • run-time - how long the scan has taken (or how long it took), in milliseconds
  • time-since-done - how long ago the scan finished, in milliseconds
  • recs-throttled - number of records examined by the scan for throttling purposes
  • recs-filtered-meta - number of records filtered out by an expression at the metadata level
  • recs-filtered-bins - number of records filtered out by an expression at the bin level
  • recs-succeeded - number of records successfully processed by the scan
  • recs-failed - number of records that failed processing (e.g. unreadable)
  • net-io-bytes - amount of response data sent, in bytes
  • net-io-time - time taken to send response data, in milliseconds
  • socket-timeout - socket timeout for the scan, in milliseconds
  • from - source of the scan request, in ip-address+port format
  • udf-filename - name of the UDF source file (background-udf scans only)
  • udf-function - name of the UDF function (background-udf scans only)
  • udf-active - number of active UDF transactions (background-udf scans only)
  • ops-active - number of active background ops transactions (background-ops scans only)
examples

Get information about all scans

Terminal window
asinfo -v 'scan-show' -l
module=query:trid=7283069042041732041:job-type=basic:ns=test:set=query_foreach:n-pids-requested=4096:\
rps=0:active-threads=0:status=done(ok):job-progress=100.00:run-time=1:time-since-done=17023:recs-throttled=0:\
recs-filtered-meta=0:recs-filtered-bins=1:recs-succeeded=5:recs-failed=0:net-io-bytes=90726:net-io-time=0:\
socket-timeout=30000:from=127.0.0.1+57202

Get information about one scan

Terminal window
asinfo -v 'scan-show:trid=2389620674112568291' -l
trid=2389620674112568291
job-type=basic
ns=test
set=sb_test5
priority=0
n-pids-requested=4096
rps=0
active-threads=0
status=done(ok)
job-progress=100.00
run-time=48
time-since-done=23231
recs-throttled=50
recs-filtered-meta=0
recs-filtered-bins=40
recs-succeeded=10
recs-failed=0
net-io-bytes=157488
socket-timeout=30000
from=127.0.0.1+50458
service-clear-alt
command
Terminal window
service-clear-alt
description

Supersedes “service” info command. The alternate address and port for this node’s non-TLS client service.

introduced
3.11
removed
-
permission
-
examples

Execute Command

Terminal window
asinfo -v "service-clear-alt"
74.125.239.52:3000
service-clear-std
command
Terminal window
service-clear-std
description

Supersedes “service” info command. The address and port for this node’s non-TLS client service.

introduced
3.11
removed
-
permission
-
examples

Execute Command

Terminal window
asinfo -v 'service-clear-std'
172.17.0.3:3000
service-tls-alt
command
Terminal window
service-tls-alt
description

Supersedes “service” info command. The alternate address and port for this node’s TLS client service.

introduced
3.11
removed
-
permission
-
examples

Execute Command

Terminal window
asinfo -v "service-tls-alt"
74.125.239.52:4333
service-tls-std
command
Terminal window
service-tls-std
description

Supersedes “service” info command. The address and port for this node’s TLS client service.

introduced
3.11
removed
-
permission
-
examples

Execute Command

Terminal window
asinfo -v "service-tls-std"
172.17.0.3:4333
service
command
Terminal window
service
description

IP address and server port for this node, expected to be a single address/port per node, may be multiple address if this node is configured to listen on multiple interfaces (typically not advised).

introduced
3.3.0
removed
-
permission
-
output

Returns a list of IP:SERVICE_PORT to be advertised to other cluster nodes. Typically considered a configuration issue if the list contains more than one IP.

examples

Execute Command

Terminal window
asinfo -v 'service'
172.16.121.138:3000
services-alternate
command
Terminal window
services-alternate
description

List of alternate service addresses of peer nodes.

introduced
3.7.1
removed
-
permission
-
output

Returns a list of alternate neighboring IP:SERVICE_PORT that are considered alive by this server and configured as alternate-access-address in the service stanza.

examples

Execute Command

Terminal window
asinfo -v 'services-alternate'
192.168.120.145:3000;192.168.120.144:3000;192.168.120.143:3000;192.168.120.142:3000
services-alumni-reset
command
Terminal window
services-alumni-reset
description

Resets the neighbor addresses (services) the server should know about. Some diagnostic tools, eg. asadm, use alumni to enable full cluster view even during cluster disruptions. This command is useful if the alumni’s list includes servers which have been decommissioned.

introduced
3.6.2
removed
-
permission
-
output

Returns OK after the refresh is completed.

examples

Execute Command

Terminal window
asinfo -v 'services-alumni-reset'
Ok
services-alumni
command
Terminal window
services-alumni
description

All neighbor addresses (services) this server has ever known about. Some diagnostic tools, eg. asadm, use alumni to enable full cluster view even during cluster disruptions.

introduced
3.3.0
removed
-
permission
-
output

Returns a list of all neighboring IP:SERVICE_PORT this node has ever known, including neighbor nodes this server believes to be Dead.

examples

Execute Command

Terminal window
asinfo -v 'services-alumni'
192.168.120.145:3000;192.168.120.144:3000;192.168.120.143:3000;192.168.120.142:3000
services
command
Terminal window
services
description

List of addresses of neighbor cluster nodes to advertise for Application to connect.

introduced
3.3.0
removed
-
permission
-
output

Returns a list of neighboring IP:SERVICE_PORT that are considered Alive by this server.

examples

Execute Command

Terminal window
asinfo -v 'services'
192.168.120.145:3000;192.168.120.144:3000;192.168.120.143:3000
set-config
command
Terminal window
set-config:context=CONTEXT;PARAM=VALUE
set-config:context=namespace;namespace=NAMESPACE_NAME;PARAM=VALUE
description

Set a configuration parameter at run time. The configuration parameter must be dynamic. The equivalent command in asadm is manage config.

introduced
3.3.0
removed
-
permission
sys-admin
parameters

context

Configuration context of where the parameter resides in the configuration file.

Options:

  • namespace
  • network
  • service
  • xdr

id

Used for namespace contexts only. Name of the namespace where the configuration parameter resides.

output

Upon success command returns “ok”

examples

For Aerospike Database 5.0+ XDR, define a remote datacenter.

Terminal window
asinfo -h localhost -v "set-config:context=xdr;dc=aerospike_b;\
action=create"

For Aerospike Database 5.0+ XDR, delete a remote datacenter.

Terminal window
asinfo -h localhost -v "set-config:context=xdr;dc=aerospike_b;\
action=delete"

For Aerospike Database 5.0+ XDR, add a namespace.

Terminal window
asinfo -h localhost -v "set-config:context=xdr;dc=aerospike_b;\
namespace=test;action=add"

For Aerospike Database 5.0+ XDR, remove a namespace.

Terminal window
asinfo -h localhost -v "set-config:context=xdr;dc=aerospike_b;\
namespace=test;action=remove"

For Aerospike Database 5.0+ XDR, add or remove a node IP address/port combination to a remote datacenter.

Terminal window
asinfo -h localhost -v "set-config:context=xdr;dc=aerospike_b;\
node-address-port=10.0.0.1:3000;action=add"

For Aerospike Database 5.0+ XDR, set configuration for a namespace.

Terminal window
asinfo -h localhost -v "set-config:context=xdr;dc=aerospike_b;\
namespace=test;ship-only-specified-sets=true;ship-set=set1"

For Aerospike Database 5.0+ XDR, rewind the shipment of records back a specific number of seconds with rewind=numberOfSeconds.

For small datasets, you can restart the shipment entirely from the beginning with rewind=all.

For large datasets, be careful with starting a complete rewind.

Terminal window
asinfo -h localhost -v "set-config:context=xdr;dc=aerospike_b;\
namespace=test;action=add;rewind=600"

For Aerospike Database 5.0+ XDR, set an auth-user who has read/write privileges on the remote datacenter. The auth-user parameter must be accompanied by the auth-password-file parameter and should be set only when the datacenter is not connected; otherwise, login at the remote datacenter will continually fail.

Terminal window
asinfo -h localhost -v "set-config:context=xdr;dc=aerospike_b;\
namespace=test;auth-user=someUser;auth-password-file=/private/security-credentials_DC1.txt"

Set heartbeat.timeout to 10 for network context

Terminal window
asinfo -v 'set-config:context=network;heartbeat.timeout=10'
ok
sets
command
Terminal window
sets
sets/NAMESPACE
sets/NAMESPACE/SET
description

Returns set statistics for all or a particular set. Includes in-memory size of a set (if data-in-memory). Returns data for individual node unless run using asadm.

introduced
3.3.0
removed
-
permission
-
parameters

NAMESPACE

Namespace name to query set statistics from.

SET

Set name to query set statistics from.

output

Stats

  • ns - namespace name
  • set - set name
  • objects - master, replica and non-replica (during migrations) objects count.
  • tombstones - master, replica and non-replica (during migrations) tombstones count.
  • memory_data_bytes - memory used by master, replica and non-replica data (during migrations), excluding primary index.
  • device_data_bytes - device storage used by master, replica and non-replica (during migrations) data, excluding primary index (Database 5.2+).
  • enable-index - true/false - reflects if this set is indexed by a set index. (Database 5.6+).
  • index_populating - true/false if the set is currently being indexed for its set index. (Database 5.6+).
  • sindexes - number of secondary indexes on this set.
  • truncating - true/false if this set is currently being truncated. (Database 6.3+).
  • truncate_lut - The LUT (last updated time) in milliseconds since the Citrusleaf epoch (00:00:00 UTC on 1 Jan 2010).
  • stop-writes-count - value configured in stop-writes-count.
  • stop-writes-size - value configured in stop-writes-size.
  • disable-eviction - value configured in disable-eviction.
examples

Query set stats from all namespaces

Terminal window
asinfo -v 'sets' -l
ns=test:set=demo:objects=12345:tombstones=0:memory_data_bytes=851805:device_data_bytes=852400:truncate_lut=0:stop-writes-count=0:set-enable-xdr=use-default:sindexes=0:enable-index=false:index_populating=false:truncating=false:disable-eviction=true;

Query set stats from namespace ‘test’

Terminal window
asinfo -v 'sets/test' -l
ns=test:set=demo:objects=1:tombstones=0:memory_data_bytes=0:device_data_bytes=40:truncate_lut=0:stop-writes-count=0:set-enable-xdr=use-default:sindexes=0:enable-index=false:index_populating=false:truncating=false:disable-eviction=true;

Query set stats from ‘demo’ set in namespace ‘test’

Terminal window
asinfo -v 'sets/test/demo' -l
objects=1:tombstones=0:memory_data_bytes=0:device_data_bytes=40:truncate_lut=0:stop-writes-count=0:set-enable-xdr=use-default::sindexes=0:enable-index=false:index_populating=false:truncating=false:disable-eviction=true;
sindex-create
command
Terminal window
sindex-create:namespace=NAMESPACE_NAME;set=SET;indexname=INDEX_NAME;indexdata=BIN_NAME,BIN_TYPE;indextype=INDEX_TYPE;context=<base64-encoded-CDT-context>
:::note
Starting with Database 7.2, the [`set-config`](/database/reference/info?search=set-config&version=all#set-config) info command takes an alternative argument pair to designate a configuration inside a namespace section, `namespace=NS` and `id=NS`. However, `id=NS` is deprecated in Database 7.2.:::
description

Create a secondary index.

introduced
3.3.0
removed
-
permission
data-admin
parameters

ns

The namespace to create a secondary index on.

set

(Optional) A set in the provided namespace to create a secondary index on. Starting with Database 6.1, omitting the set parameter means that the index applies to the entire namespace. In earlier versions, omitting the set parameter means that the index applies to all items in the namespace that are not a member of any set.

indexname

Canonical name for the newly-created secondary index. Name should be 20 characters or fewer. The colon : and semicolon ; characters are not allowed in index names.

indexdata

Tuple of the form BIN_NAME,BIN_TYPE. BIN_NAME is the name of the bin to create a secondary index on. BIN_TYPE is the bin type for the provided BIN_NAME. Options:
NUMERIC
STRING
GEO2DSPHERE

indextype

(Optional) Specifies how the secondary index is to collect keys. Options:
default: Treat the value of the bin as a key.
list: Use the elements of a list as keys.
mapkeys: Use the keys of a map as keys.
mapvalues: Use the values of a map as keys.

context

(Optional) Specifies a base64-encoded context for indexing a value nested in a List or Map Collection Data Type (CDT).

output

On success returns ok. On failure returns an error message.

examples

Create a secondary index

Terminal window
asinfo -v 'sindex-create:namespace=test;set=demo;indexname=demo-index;indexdata=bin,string'

Create a secondary index on a nested context

Terminal window
asinfo -v 'sindex-create:namespace=sandbox;set=ufodata;indexname=shape-idx;indexdata=report,string;indextype=list;context=kiKmA3NoYXBl'
sindex-delete
command
Terminal window
sindex-delete:namespace=NAMESPACE_NAME[;set=SET];indexname=INDEX_NAME
:::note
Starting with Database 7.2, the [`set-config`](/database/reference/info?search=set-config&version=7#set-config) info command takes an alternative argument pair to designate a configuration inside a namespace section, `namespace=NS` and `id=NS`. However, `id=NS` is deprecated in Database 7.2.
:::
description

Delete a secondary index.

introduced
3.3.0
removed
-
permission
data-admin
parameters

ns

Namespace name where the target secondary index resides.

set

(optional) Name of the Set where the target secondary index resides.

indexname

Name of the secondary index to delete.

output

On success returns “ok”, otherwise returns an error message.

examples

Delete a secondary index.

Terminal window
asinfo -v 'sindex-delete:namespace=test;indexname=demo-index'
ok
sindex-histogram
command
Terminal window
sindex-histogram:namespace=NAMESPACE_NAME;[set=SET];indexname=INDEX;enable=ENABLE
description

Enables query histograms to be printed in system logs of the target server

introduced
3.3.0
removed
6.0.0
permission
sys-admin
parameters

ns

Namespace name where the target secondary index resides.

set

(optional) Name of the Set where the target secondary index resides.

indexname

Name of the index to enable/disable histograms for.

enable

Can be either true or false.

If true histograms are enabled for the provided index name.

If false histograms are disabled for the provided index name.

output

On success returns “ok”, otherwise returns an error message.

examples

Enable Query Histograms to be Printed to the Logs

Terminal window
asinfo -v 'sindex-histogram:namespace=test;set=demo;indexname=demo-index;enable=true'
ok

Disable Query Histograms to be Printed to the Logs

Terminal window
asinfo -v 'sindex-histogram:namespace=test;set=demo;indexname=demo-index;enable=false'
ok
sindex-list
command
Terminal window
sindex-list:[namespace=NAMESPACE_NAME][;b64=true/false]
description

List secondary indexes. Starting with Database 6.1, you can specify whether to view the optional context in its base64-encoded representation. This command supplants the sindex[/NAMESPACE] command, which cannot accept non positional arguments.

introduced
3.3.0
removed
-
permission
data-admin
parameters

ns

Namespace name (optional) where the target secondary indexes reside. If not specified, list sindexes in all namespaces.

b64

(optional) false or true. Retrieve base64 encoding of the context of the secondary index. This can be used in other info commands, such as sindex-create.

output

On success returns “ok”, otherwise returns an error message.

examples

List secondary indexes in all namespaces:

Terminal window
asinfo -v 'sindex-list:'

List secondary indexes in a specific namespace:

Terminal window
asinfo -v 'sindex-list:namespace=test'

Nested CDT index example using base64 option; context given in human readable form:

Terminal window
asinfo -v 'sindex-list:namespace=test;b64=false'

Nested CDT index example using base64 option; retrieve base64 encoded context:

Terminal window
asinfo -v 'sindex-list:namespace=test;b64=true'
sindex-stat
command
Terminal window
sindex-stat:namespace=NAMESPACE_NAME;indexname=INDEXNAME
description

Display secondary index statistics. This command supplants the sindex[/NAMESPACE[/SINDEX]] command. These stats are HLL approximations that get refreshed hourly, and become more precise with higher cardinality. Both entries_per_bval and entries_per_record may register zero values until the number of entries gets large enough.

introduced
3.3.0
removed
-
permission
data-admin
parameters

ns

Namespace name where the target secondary indexes reside.

indexname

Name of the secondary index to query statistics from.

output

Secondary index cardinality and other statistics, otherwise returns an error message.

examples

Get statistics for a specific secondary index.

Terminal window
asinfo -v 'sindex-stat:namespace=test;indexname=test_idx'
sindex
command
Terminal window
sindex[/NAMESPACE[/SINDEX]]
description

Returns a list of secondary indexes defined on Aerospike and their state. To get the base64-encoded context of a secondary index, use sindex-list.

introduced
3.3.0
removed
-
permission
-
parameters

NAMESPACE

Name of the namespace to query for secondary indexes.

SINDEX

Name of the secondary index to query statistics from.

output

secondary index List

Semicolon ’;’ delimited list of colon ’:’ delimited general statistics for secondary indexes.

secondary index Statistics

Semicolon ’;’ delimited list of detailed statistics for a particular secondary index.

examples

Query All secondary indexes

Terminal window
asinfo -v 'sindex'
ns=test:set=demo:indexname=str_idx:bin=str_bin:type=STRING:indextype=DEFAULT:path=str_bin:state=RW \
ns=test:set=demo:indexname=str_uniq_idx:bin=str_uniq_bin:type=STRING:indextype=DEFAULT:path=str_uniq_bin:state=RW \
ns=test:set=demo:indexname=int_uniq_idx:bin=int_uniq_bin:type=NUMERIC:indextype=DEFAULT:path=int_uniq_bin:state=RW

Query All secondary indexes for a Namespace

Terminal window
asinfo -v 'sindex/test'
ns=test:set=demo:indexname=str_idx:bin=str_bin:type=STRING:indextype=DEFAULT:path=str_bin:state=RW \
ns=test:set=demo:indexname=str_uniq_idx:bin=str_uniq_bin:type=STRING:indextype=DEFAULT:path=str_uniq_bin:state=RW \
ns=test:set=demo:indexname=int_uniq_idx:bin=int_uniq_bin:type=NUMERIC:indextype=DEFAULT:path=int_uniq_bin:state=RW

Query Statistics for a Particular secondary index

Terminal window
asinfo -v 'sindex/test/str_idx'
keys=9;entries=9000;ibtr_memory_used=18688;nbtr_memory_used=162009; \
load_pct=100;loadtime=6;write_success=10000;write_error=0; \
delete_success=1000;delete_error=0;stat_gc_recs=0; \
query_basic_complete=170;query_basic_error=0;query_basic_abort=0;query_basic_avg_rec_count=1000;histogram=false
smd-show
command
Terminal window
smd-show:module=[module name]
description

Shows information about the specified SMD module. Available modules are “evict”, “roster”, “sindex”, “truncate”, “UDF”, and “XDR”. The “security” module is not available.

introduced
6.1
removed
-
permission
-
output

Returns persisted information about the specified module.

examples

Execute Command

Terminal window
asinfo -v "smd-show:module=truncate"
test=392594196771;test|eg-set=394219746122
statistics
command
Terminal window
statistics
statistics/xdr
description

Returns system health and usage stats for this server. Adding /xdr returns the XDR statistics subset. Use option -l for pretty print.

introduced
3.3.0
removed
-
permission
-
output

A semicolon ”;” delimited list of system health and usage statistics of form “METRIC:VALUE”. The -l option breaks up statistics on individual lines.

examples

Version 5.7.0 and later

Terminal window
asinfo -v 'statistics' -l
failed_best_practices=true
cluster_size=1
cluster_key=F6F7CE8A5621
cluster_generation=1
cluster_principal=BB937664A290C00
cluster_min_compatibility_id=10
cluster_max_compatibility_id=10
cluster_integrity=true
cluster_is_member=true
cluster_duplicate_nodes=null
cluster_clock_skew_stop_writes_sec=0
cluster_clock_skew_ms=0
cluster_clock_skew_outliers=null
uptime=2167
system_total_cpu_pct=8
system_user_cpu_pct=5
system_kernel_cpu_pct=3
system_free_mem_kbytes=5930052
system_free_mem_pct=48
system_thp_mem_kbytes=0
process_cpu_pct=1
threads_joinable=8
threads_detached=65
threads_pool_total=46
threads_pool_active=46
heap_allocated_kbytes=127219
heap_active_kbytes=129288
heap_mapped_kbytes=251904
heap_efficiency_pct=51
heap_site_count=0
objects=9009
tombstones=0
info_queue=0
rw_in_progress=0
proxy_in_progress=0
tree_gc_queue=0
client_connections=2
client_connections_opened=14398
client_connections_closed=14396
heartbeat_connections=0
heartbeat_connections_opened=0
heartbeat_connections_closed=0
fabric_connections=0
fabric_connections_opened=0
fabric_connections_closed=0
heartbeat_received_self=14375
heartbeat_received_foreign=0
reaped_fds=0
info_complete=3228
demarshal_error=0
early_tsvc_client_error=73
early_tsvc_from_proxy_error=0
early_tsvc_batch_sub_error=0
early_tsvc_from_proxy_batch_sub_error=0
early_tsvc_udf_sub_error=0
early_tsvc_ops_sub_error=0
batch_index_initiate=0
batch_index_queue=0:0,0:0,0:0,0:0
batch_index_complete=0
batch_index_error=0
batch_index_timeout=0
batch_index_delay=0
batch_index_unused_buffers=0
batch_index_huge_buffers=0
batch_index_created_buffers=0
batch_index_destroyed_buffers=0
batch_index_proto_uncompressed_pct=0.000
batch_index_proto_compression_ratio=1.000
scans_active=0
query_short_running=0
query_long_running=0
paxos_principal=BB937664A290C00
time_since_rebalance=2165
migrate_allowed=true
migrate_partitions_remaining=0
fabric_bulk_send_rate=0
fabric_bulk_recv_rate=0
fabric_ctrl_send_rate=0
fabric_ctrl_recv_rate=0
fabric_meta_send_rate=0
fabric_meta_recv_rate=0
fabric_rw_send_rate=0
fabric_rw_recv_rate=0
status
command
Terminal window
status
description

Always returns ok. Verifies service port is open. Useful when using telnet. In asinfo, leave off the value ‘-v’ argument.

introduced
3.3.0
removed
-
permission
-
output

If server is up, always returns ‘ok’

thread-traces
command
Terminal window
thread-traces
description

Returns the current call stack for all server threads.

introduced
4.5.3
removed
-
permission
-
output

For each server thread, returns its ID (the first number on the dashed line), the offset of its run function (in parentheses on the dashed line), and its current call stack.

Because there are typically over 100 server threads, this command can generate a large amount of output.

examples

Sample output (for one thread only)

Terminal window
asinfo -v 'thread-traces' -l
---------- 45387 (0x12914f) ----------
/usr/bin/asd(cf_thread_traces_action+0x4c) [0x67807c]
/lib64/libpthread.so.0() [0x384720f710]
/lib64/libc.so.6(nanosleep+0x2d) [0x3846eaca3d]
/lib64/libc.so.6(usleep+0x34) [0x3846ee1be4]
/usr/bin/asd(hb_adjacency_tender+0x275) [0x5293c4]
/usr/bin/asd() [0x678379]
/lib64/libpthread.so.0() [0x38472079d1]
/lib64/libc.so.6(clone+0x6d) [0x3846ee88fd]
throughput
command
Terminal window
throughput:[hist=HISTOGRAM;][back=BACK;][duration=DURATION;][slice=SLICE]
description

Returns throughput info.

introduced
3.9
removed
5.1
permission
-
parameters

hist

Histogram name - if none is provided, command applies to all namespace tracked histograms, which are the read, write, UDF and query histograms’.

[Default: all namespace tracked histograms]

Options (ns being the namespace name):

  • {ns}-read
  • {ns}-write
  • {ns}-udf
  • {ns}-query
  • batch-index

To know more about histograms, see Monitoring latencies.

back

Start search this many seconds before now.

[Default: Minimum to get last slice.]

Note: back=0 queries starting from oldest cache.

duration

seconds (forward) from start to search.

[Default: 0, everything to present]

slice

Intervals (in seconds) to analyze.

[Default: 0, everything as one slice]

output

Return value is in the following format: HISTOGRAM_0:TIME_START,ops/sec,THRESHHOLD_0,THRESHHOLD_1,...;HISTOGRAM_1:...

examples

Show All throughput Histograms

Terminal window
asinfo -v 'throughput:'
{ns}-read:23:56:38-GMT,ops/sec;23:56:48,0.0;{ns}-write:23:56:38-GMT,ops/sec;23:56:48,0.0;
error-no-data-yet-or-back-too-small;error-no-data-yet-or-back-too-small

Show Read throughput Histogram

Terminal window
asinfo -v 'throughput:hist={ns}-read;slice=30;back=300;duration:120'
{ns}-read:23:51:28-GMT,ops/sec;23:51:58,0.0;23:52:28,0.0;23:52:58,0.0;
23:53:28,0.0;23:53:58,0.0;23:54:28,0.0;23:54:58,0.0;23:55:28,0.0;23:55:58,0.0
tip-clear
command
Terminal window
tip-clear:host-port-list=Node1:3002,Node2:3002,...
description

Clear configured hostname(s) from seed list for mesh-mode heartbeats. Configured hostname(s) means the hostname(s) from config file or added using the tip command. Useful in the case of repurposing a node from a live cluster.

introduced
3.3.0
removed
-
permission
sys-admin
parameters

host-port-list

Configured hostname(s) and port(s) of Aerospike seeds that need to be removed from the seed list. Clears the dynamic list of hostnames loaded from mesh-seed-address-port or using the tip command.

  • Starting with Database 5.3, supports only configured hostname(s).
  • Starting with Database 5.3, does not support the value ‘all’.
  • Starting with Database 3.9.X to 5.2.X, it also honors IP addresses of active nodes (seed or non-seed).
  • Starting with Database 3.10, when specifying ‘all’, both seed nodes and discovered nodes are cleared.
  • Starting with Database 3.9.1, the parameter host-port-list is always required (even for specifying ‘all’).
output

Generates descriptive messages on success as well as a failure.

examples

Clear configured hostname(s) from seed list

Terminal window
asinfo -v 'tip-clear:host-port-list=172.17.0.15:3002'
asinfo -v 'tip-clear:host-port-list=prod_aerospike_2:3002'
Related
tip
command
Terminal window
tip:host=HOST;port=MESH-PORT
description

Add hostname to seed list for mesh-mode heartbeats.

introduced
3.3.0
removed
-
permission
sys-admin
parameters

host

Hostname of an Aerospike server to join this cluster.

port

Mesh port of an Aerospike server to join this cluster.

output

Command generates descriptive messages on success as well as a failure.

examples

Adding a Host to the Cluster

Terminal window
asinfo -v 'tip:host=172.16.121.138;port=3002'
asinfo -h prod_aerospike_1 -v "tip:host=prod_aerospike_2;port=3002"
Related
truncate-namespace-undo
command
Terminal window
truncate-namespace-undo:namespace=NAMESPACE_NAME;
description

Undo a truncate-namespacecommand by removing the associated System Meta Data (SMD) files entry and allow (some) previously truncated records to be resurrected on the subsequent cold restart (only for records that have not had their persisted storage block overwritten by other records). Run this command from asadm instead of asinfo.

You need either the write permission (Database 5.1 - 5.7) or the truncate permission (Database 6.0+) or the data-admin permission:

  • For write or truncate privileges limited to running truncate-related commands only for namespaces (scoped for namespaces), the truncation to be undone requires that the namespace exist on the node where the command is issued. If the write privilege is global (not limited to namespaces), the command can be issued on any node in the cluster.
  • For the data-admin privilege, the truncation to be undone does not require that the namespace exist on the node where the command is issued.
  • The equivalent command in asadm is manage truncate undo ns NAMESPACE_NAME {set SET_NAME}.
introduced
4.3.1.11, 4.4.0.11, 4.5.0.6, 4.5.1.5
removed
-
permission
data-admin (all versions); write (5.1-5.7); truncate (6.0+)
parameters

namespace

Required - Name of the namespace to run the undo truncate-namespace command against. Will remove namespace level truncate entry in SMD (which persists - tombstone like - the truncate time).

output

ok

examples

Remove truncate entry in SMD for a namespace

Terminal window
asinfo -v 'truncate-namespace-undo:namespace=test;'
truncate-namespace
command
Terminal window
truncate-namespace:namespace=NAMESPACE_NAME;lut=TIME
description

Deletes every record in the specified namespace where the last update time (LUT) is older than the given time. Run this command from asadm instead of asinfo. Do not mix the ‘truncate’ commmand with transactions.

  • Parameters: namespace is required, lut is optional.
  • This operation skips the special transaction set <ERO~MRT.
  • Deletes are durable and preserve record deletions in the Enterprise Edition only.
  • Role-based access control privileges are required:
    • write privileges are required for Database 5.1 - 5.7.
    • truncate privileges are required for Database 6.1 and later.
  • Command is issued on one node in a cluster and then is distributed to other nodes using system metadata (SMD); see During cluster change.
  • The presence of sindexes can slow down truncation; see Manage sindexes.
  • To truncate a specific set, use truncate.
  • Upon receiving a successful response from the node the command is issued against and assuming all the nodes are in the cluster, the targeted namespace would appear as entirely deleted from any application’s perspective, regardless of how long it would take to actually delete all the records.
  • The equivalent command in asadm is manage truncate ns NAMESPACE {set SET} {before <iso-8601-or-unix-epoch> iso-8601|unix-epoch}.
introduced
4.3.1.11, 4.4.0.11, 4.5.0.6, 4.5.1.5
removed
-
permission
data-admin (all versions); write (5.1-5.7); truncate (6.0+)
parameters

namespace

Required - Name of the namespace to truncate.

lut

Optional - Last update time (LUT). If not specified, the current time is used. The LUT is expressed as Unix epoch (UTC) nanoseconds, unlike record metadata LUT and truncate_lut, which are in Citrusleaf epoch (00:00:00 UTC on 1 Jan 2010) format. It can be given in hex (with a 0x prefix), decimal, or octal (with a 0 prefix). The LUT is not allowed to be older than the Citrusleaf epoch, and is not allowed to be beyond the current time (that is, in the future). “lut=now” to mean the current time, is no longer supported as of version 4.3.1.11 (and later 4.3.1.X), 4.4.0.11 (and later 4.4.0.X), 4.5.0.6 (and later 4.5.0.X) and 4.5.1.5 later.

output

ok

examples

Truncate a namespace

Terminal window
asinfo -v 'truncate-namespace:namespace=test;'
truncate-undo
command
Terminal window
truncate-undo:namespace=NAMESPACE_NAME;set=SET_NAME;
description

Undo a truncate command by removing the associated SMD (System Meta Data) files entry and allow (some) previously truncated records to be resurrected on the subsequent cold restart (only for records that have not had their persisted storage block overwritten by other records). Run this command from asadm instead of asinfo.

You need either the write permission or the data-admin permission:

  • For write privilege limited to running truncate-related commands only for namespaces (scoped for namespaces), the truncation to be undone requires that the namespace exist on the node where the command is issued. If the write privilege is global (not limited to namespaces), the command can be issued on any node in the cluster.
  • For the data-admin privilege, the truncation to be undone does not require that the namespace exist on the node where the command is issued. The equivalent command in asadm is manage truncate undo NAMESPACE_NAME {set SET_NAME}.
introduced
3.12
removed
-
permission
data-admin (all versions); write (5.1-5.7); truncate (6.0+)
parameters

namespace

Required - Name of the namespace to run the undo truncate command against. Will only remove namespace level truncate entry in SMD (which persists - tombstone like - the truncate time) if set is not specified.

set

Name of the set to run the undo truncate command against. The set parameter is required.

output

ok

examples

Remove truncate entry in SMD for a namespace or a set

Terminal window
asinfo -v 'truncate-undo:namespace=test;'
asinfo -v 'truncate-undo:namespace=test;set=set1;'
truncate
command
Terminal window
truncate:namespace=NAMESPACE_NAME;set=SET_NAME;lut=TIME
description

The truncate command deletes every record in the specified set where the last update time (LUT) is older than the given time. Run this command from asadm instead of asinfo. Do not mix the ‘truncate’ commmand with transactions.

  • Parameters: namespace and set are required; lut is optional.
  • Deletes are durable and preserve record deletions in the Enterprise Edition only.
  • Role-based access control privileges are required:
    • write privileges are required for Database 5.1 - 5.7.
    • truncate privileges are required for Database 6.1 and later.
  • Command is issued on one node in a cluster and then is distributed to other nodes using system metadata (SMD); see During cluster change.
  • The presence of secondary indexes can slow down truncation. See Manage sindexes.
  • To truncate an entire namespace, use truncate-namespace.
  • A successful response from the node the command is issued against, the targeted set would appear as entirely deleted from any application’s perspective, regardless of how long it would take to actually delete all the records assuming all the nodes are in the cluster.
  • The equivalent command in asadm is [manage truncate ns NAMESPACE {set SET} {before <iso-8601-or-unix-epoch> iso-8601|unix-epoch}](/database/tools/asadm/live-mode/#truncate).
introduced
3.12
removed
-
permission
data-admin (all versions); write (5.1-5.7); truncate (6.0+)
parameters

namespace

Required - Name of the namespace with the set to be truncated.

set

Required - Truncates only the set. Set name cannot be null. To truncate an entire namespace, use truncate-namespace.

lut

Optional - Last update time (LUT). If not specified, the current time is used. The LUT is expressed as Unix epoch (UTC) nanoseconds, unlike record metadata LUT and truncate_lut, which are in Citrusleaf epoch (00:00:00 UTC on 1 Jan 2010) format. It can be given in hex with a 0x prefix, decimal, or octal with a 0 prefix. The LUT cannot be older than the Citrusleaf epoch, and cannot be beyond the current time. “lut=now” to mean the current time, is not supported.

output

ok

examples

Truncate commands

  1. Truncate records in set1 in namespace ‘test’ with a LUT before the current time.

  2. Truncate records in set1 in namespace ‘test’ with a LUT before 2018-04-01 09:00:00 UTC.

Terminal window
1. asinfo -v 'truncate:namespace=test;set=set1;'
2. asinfo -v 'truncate:namespace=test;set=set1;lut=1522573200000000000;'
udf-get
command
Terminal window
udf-get
description

Get the content of a registered UDF from the node.

introduced
3.3.0
removed
-
permission
-
parameters

filename

The filename of the registered UDF to get.

output

Get the content of a registered UDF from the local node. Content is encoded in base 64.

examples
Terminal window
asinfo -v 'udf-get:filename=basic_udf.lua'type=LUA;content=LS0gQSB2ZXJ5IHNpbXBsZSBhcml0aG1ldGljIFVER\
iB3aXRoIG5vIGFyZ3VtZW50cyBvciByZXR1cm4gdmFsdWUuCi0tIEl0IGFkZHMgMTAwMCB0byB0aGUgdmFsdWUgaW4g\
YmluICd0ZXN0LWJpbi0xJyBhbmQgdXBkYXRlcyBpdC4KZnVuY3Rpb24gdGVzdF9iaW5fMV9hZGRfMTAwMChyZWMpCgl\
yZWNbJ3Rlc3QtYmluLTEnXSA9IHJlY1sndGVzdC1iaW4tMSddICsgMTAwMAoJYWVyb3NwaWtlOnVwZGF0ZShyZWMpCm\
VuZAoKLS0gQSBzaW1wbGUgYXJpdGhtZXRpYyBVREYgdGhhdCBoYXMgYXJndW1lbnRzIGFuZCBhIHJldHVybiB2YWx1Z\
S4KLS0gSXQgdXBkYXRlcyB0aGUgdmFsdWUgaW4gdGhlIHNwZWNpZmllZCBiaW4gYWZ0ZXIgcGVyZm9ybWluZyB0aGUg\
YXJpdGhtZXRpYwotLSBvcGVyYXRpb24sIGFuZCByZXR1cm5zIHRoZSByZXN1bHRpbmcgYmluIHZhbHVlLgpmdW5jdGl\
vbiBiaW5fdHJhbnNmb3JtKHJlYywgYmluX25hbWUsIHgsIHkpCglyZWNbYmluX25hbWVdID0gKHJlY1tiaW5fbmFtZV\
0gKiB4KSArIHkKCWFlcm9zcGlrZTp1cGRhdGUocmVjKQoJcmV0dXJuIHJlY1tiaW5fbmFtZV0KZW5kCgo=;
udf-list
command
Terminal window
udf-list
description

Lists the registered UDF/Lua modules on the node.

introduced
3.3.0
removed
-
permission
-
output

list of registered UDF modules.

examples
Terminal window
asinfo -v 'udf-list'
filename=basic_udf.lua,hash=706c57cb29e027221560a3cb4b693573ada98bf2,type=LUA;
udf-put
command
Terminal window
udf-put
description

Registered UDF/Lua modules on the node.

introduced
3.3.0
removed
-
permission
data-admin
parameters

filename

The filename to register the UDF as.

udf-type

Currently can only be the string “lua”.

content-len

Number of bytes to expect for the base64 encoded UDF content.

content

content-len number of bytes of base64 encoded UDF data.

output

Registers an UDF module on the server. Only need to be executed against one node, and is propagated to other nodes in the cluster.

examples
Terminal window
asinfo -v 'udf-put:filename=basic_udf.lua;udf-type=LUA;content-len=760;content=LS0gQSB2ZXJ5I\
HNpbXBsZSBhcml0aG1ldGljIFVERiB3aXRoIG5vIGFyZ3VtZW50cyBvciByZXR1cm4gdmFsdWUuCi0tIEl0IGFkZHMgM\
TAwMCB0byB0aGUgdmFsdWUgaW4gYmluICd0ZXN0LWJpbi0xJyBhbmQgdXBkYXRlcyBpdC4KZnVuY3Rpb24gdGVzdF9ia\
W5fMV9hZGRfMTAwMChyZWMpCglyZWNbJ3Rlc3QtYmluLTEnXSA9IHJlY1sndGVzdC1iaW4tMSddICsgMTAwMAoJYWVyb\
3NwaWtlOnVwZGF0ZShyZWMpCmVuZAoKLS0gQSBzaW1wbGUgYXJpdGhtZXRpYyBVREYgdGhhdCBoYXMgYXJndW1lbnRzI\
GFuZCBhIHJldHVybiB2YWx1ZS4KLS0gSXQgdXBkYXRlcyB0aGUgdmFsdWUgaW4gdGhlIHNwZWNpZmllZCBiaW4gYWZ0Z\
XIgcGVyZm9ybWluZyB0aGUgYXJpdGhtZXRpYwotLSBvcGVyYXRpb24sIGFuZCByZXR1cm5zIHRoZSByZXN1bHRpbmcgY\
mluIHZhbHVlLgpmdW5jdGlvbiBiaW5fdHJhbnNmb3JtKHJlYywgYmluX25hbWUsIHgsIHkpCglyZWNbYmluX25hbWVdI\
D0gKHJlY1tiaW5fbmFtZV0gKiB4KSArIHkKCWFlcm9zcGlrZTp1cGRhdGUocmVjKQoJcmV0dXJuIHJlY1tiaW5fbmFtZ\
V0KZW5kCgo=;
udf-remove
command
Terminal window
udf-remove
description

Unregisters a previously registered UDF module.

introduced
3.3.0
removed
-
permission
data-admin
parameters

filename

The filename of the UDF to remove.

examples
Terminal window
asinfo -v "udf-remove:filename=basic_udf.lua"
ok
xdr-command
command
Terminal window
xdr-command:<command>
description

Issues commands for XDR in server 3.8 and later.

introduced
3.8.3
removed
5.0.0
permission
sys-admin
parameters

skip-outstanding

This command instructs XDR to skip all outstanding records in the digest log. It only skips outstanding records for the main thread (does not impact potential link down and failed node threads).

handle-failednode=true|false

When set to false, it instructs XDR to skip all outstanding records for the failed node thread for the current and potential upcoming occurrences of failed node processing. This command should only be used for rolling restart situations where all the nodes are expected to join the cluster back (if handle-failednode is set to false and a node is permanently removed from the cluster, digestlog space would not be reclaimed). Consult Aerospike Support prior to using this command.

handle-linkdown=true|false

When set to false, it instructs XDR to skip all outstanding records for the linked down thread for the current and potential upcoming occurrences of linked down processing. We recommend that you consult with Aerospike Support prior to using this command.

force-linkdown=true|false;dc=DC_NAME

Available starting with Database 4.1. When set to true, forces a DC into CLUSTER_DOWN state regardless if the DC is reachable or not. Should be set back to false to get the cluster into CLUSTER_WINDOW_SHIP. The use of this command should be carefully considered. Putting a cluster in CLUSTER_DOWN state for an extended period of time causes the digest log to potentially overflow (and hit stop writes if configured as such) and forces an extra thread to handle shipping for the window the cluster was in the CLUSTER_DOWN state.

examples

Skip outstanding record in the digest log

Terminal window
asinfo -v 'xdr-command:skip-outstanding'
ok
asinfo -v 'xdr-command:handle-failednode=false'
ok
asinfo -v 'xdr-command:force-linkdown=true;dc=DC1'
ok
xdr-get-filter
command
Terminal window
xdr-get-filter:dc=DCNAME;namespace=NAMESPACE_NAME[;b64=TRUE|FALSE]
description

Checks which filter is set in XDR.

introduced
5.3.0
removed
-
permission
-
output

Shows the existing filter for a namespace in the DC. Expression appears as ‘null’ if there is no filter. (Starting with Database 7.2, use “NAMESPACE_NAME” instead of ns=NAME”.`)

examples

Get filter for ‘test’ namespace in ‘DC1’

Terminal window
asinfo -v "xdr-get-filter:dc=DC1;namespace=test"

Get filter for ‘test’ namespace in ‘DC1’ in base-64 format

Terminal window
asinfo -v "xdr-get-filter:dc=DC1;namespace=test;b64=true"
xdr-set-filter
command
Terminal window
xdr-set-filter:dc=DC_NAME;namespace=NAMESPACE_NAME;exp=<BASE64>
description

Specifies which records are shipped by XDR using base64 equivalent of the expressions syntax. Use ‘exp=null’ to remove an existing filter.

introduced
5.3.0
removed
-
permission
-
output

Upon success command returns “ok”

examples

Set filter for ‘test’ namespace in ‘DC1’

Terminal window
asinfo -v "xdr-set-filter:dc=DC1;namespace=test;exp=kxGRSJMEk1ECo2FnZRU="

Remove filter for ‘test’ namespace in ‘DC1’

Terminal window
asinfo -v "xdr-set-filter:dc=DC1;namespace=test;exp=null"
Feedback

Was this page helpful?

What type of feedback are you giving?

What would you like us to know?

+Capture screenshot

Can we reach out to you?