Aerospike provides many useful tools for managing your Aerospike Database. Most tools run on the server, others are run from other machines, 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
When you install the Aerospike server the Tools Package is also installed. However, it is often desired to have tools installed locally as well. For details on installation, see Aerospike Tools Installation.
Tools configuration file
Tools can be configured by using tools configuration files.
For more details, see Aerospike Tools Configuration File.
Aerospike Admin: asadm
asadm command-line tool gives an immediate view into the cluster: its size, and
its health. It also allows you 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.
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 via 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.
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 Data Browser: 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.
For more details see asconfig.
Back Up and Restore Data: asbackup and asrestore
Use a node outside the cluster and pull out 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. Source code is included.
For details on usage, see Backup and Restore (asbackup and asrestore).
Aerospike Benchmark: asbench
Benchmarks 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
Monitors your clusters' unique data usage as is relevant to your license agreement. Only a single agent is needed per cluster. It logs data usage once an hour, on the hour. The data is then available via asadm or through its REST API.
For details on usage, see Unique Data Agent (uda).
Log Latency Tool: asloglatency
Aerospike contains a number of settings that allow latency issues in a server to be diagnosed. This tool analyzes a logfile and displays the different components of a transaction.
For details on usage, see Log Latency Tool (asloglatency).
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.
- For more overview information, see Aerospike Certification Tool.
- For details on usage, Certifying Flash Devices (SSDs).
- For source code, see GitHub.
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 in Aerospike server.
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)
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.
AeroLab is intended for local development and testing environments. It is not recommended for production operations.