Skip to main content
Loading

Overview

Aerospike provides many useful tools for managing your Aerospike Database. Most tools run on the same machine running the Aerospike Database, and others run remotely for tasks such as taking backups.

The tools package​

The most frequently used Aerospike tools are conveniently contained in the Aerospike Tools Package.

Installing the tools​

The tools package is installed as part of the Aerospike Database installation. For details on local installation, see Aerospike tools installation.

Tools configuration file​

Configure the tools with tools configuration files.

For more details, see Aerospike Tools Configuration File.

Aerospike admin: asadm​

The asadm command-line tool gives an immediate view into the cluster with details about its size and health. Use it to administer and configure the cluster. This tool works in a variety of modes:

  • With a running cluster, or "live-cluster mode". In live-cluster mode, it provides functions to execute Aerospike commands across the entire cluster.
  • With collectinfo files, or collectinfo-analyzer mode.
  • With Aerospike log files, or log-analyzer mode. The log analysis feature of asadm is deprecated. Use show latencies in asadm to see live latencies. You can also use the Aerospike Grafana dashboards if you have Prometheus installed, or the AGI stack in AeroLab to further explore log files.

For details on usage, see Aerospike Admin (asadm).

Aerospike info protocol tool: asinfo​

The powerful, low-level asinfo tool can make requests to an individual server using Aerospike's info protocol. It is useful for gathering statistics and setting a variety of tuning parameters. It can be wrapped by higher level scripts for a variety of needs. These same asinfo commands can also be used within an asadm shell to issue commands to all nodes in a cluster.

For details on usage, see Aerospike Information Tool (asinfo).

Aerospike Quick Look: AQL​

This command-line interface is useful for browsing data and developing user-defined functions (UDFs).

For details on usage, see aql.

Aerospike configuration: asconfig​

asconfig is a command-line tool that assists with configuring the Aerospike Database. Features include configuring the Aerospike Database in YAML, as well as validating and diffing Aerospike configuration files

asconfig uses Aerospike configuration schema files for validation. The same files can be used to provide IDE integration for Aerospike configuration files.

For more details, see asconfig.

Back up and restore data​

Aerospike Backup Service (ABS)​

note

ABS is not included in the tools package.

ABS runs on a virtual machine or Docker container and provides a set of REST API endpoints to back up and restore an Aerospike Database cluster.

For details on usage, see Aerospike Backup Service.

asbackup and asrestore​

You can back up the Aerospike Database from a node outside the cluster, saving all the cluster's data into a directory of text files or a single text file. You can also restore the data from one of these files. The source code is included in the tools package.

For details on usage, see Backup and Restore (asbackup and asrestore).

Aerospike benchmark: asbench​

Use asbench to benchmark the performance of an Aerospike cluster. Benchmark jobs are highly configurable and allow for arbitrary data formats and access patterns.

For details on usage, see Aerospike Benchmark Tool (asbench).

Unique Data Agent: UDA​

UDA monitors unique data usage in your clusters as is relevant to your license agreement. Only a single agent is needed per cluster.
UDA logs data usage once an hour, on the hour, and data is available via asadm or through UDA's REST API.

For details on usage, see Unique Data Agent (uda).

Log latency tool: asloglatency​

Aerospike uses a number of settings that diagnose latency issues in a server. This tool analyzes a log file and displays the different components of a transaction.

For details on usage, see Log Latency Tool (asloglatency).

Data validation: asvalidation​

The asvalidation tool identifies and attempts to fix records with malformed collection data type (CDT) bin values (Map and List).

For details on usage, see Data Validation (asvalidation).

Other Tools (Not in the Tools Package)​

Other tools not available in the tools package are available to download independently.

Aerospike Certification Tool: ACT​

ACT is a pair of programs for testing and certifying Flash/SSD device performance for Aerospike Database data and index storage. ACT measures latency during a mixed load of read and write operations while modeling the Aerospike Database server's I/O pattern as closely as practical.

Aerospike Loader: asloader​

Removed from Tools Package: 6.2.0

This tool can help in migrating data from any other database to Aerospike. You can dump data from different databases in .DSV format and use this tool to parse and load them into an Aerospike database.

For details on usage, see Aerospike Loader (asloader).

Speeding up cold starts with asmt​

Aerospike Shared-Memory Tool (asmt) lets you perform faster restarts of nodes in an Aerospike Database Enterprise Edition cluster after rebooting their host servers.

For details, see Aerospike Shared-Memory Tool (asmt)

Community-supported: AeroLab​

AeroLab is a tool that creates Aerospike development and testing clusters in Docker or on AWS, streamlining efforts to test cluster configuration options, upgrade procedures, and client applications in a controlled development environment.

note

AeroLab is intended for local development and testing environments. It is not recommended for production operations.

Last updated on