Submodule box.info
The box.info submodule provides access to information about a running Tarantool instance.
Below is a list of all box.info functions and members.
| Name | Use |
|---|---|
| box.info() | Get all keys and values provided by the box.info submodule |
| box.info.cluster | Information about the cluster to which the current instance belongs |
| box.info.config | The instance’s state in regard to configuration |
| box.info.election | The current state of this replica set node in regard to leader election |
| box.info.gc() | Get information about the Tarantool garbage collector |
| box.info.hostname | The hostname that identifies a machine the current instance is running on |
| box.info.id | A numeric identifier of the current instance within the replica set |
| box.info.listen | A real address to which an instance is bound |
| box.info.lsn | A log sequence number (LSN) for the latest entry in the instance’s write-ahead log (WAL) |
| box.info.memory() | Get information about memory usage for the current instance |
| box.info.name | The name of the current instance |
| box.info.package | The package name |
| box.info.pid | Get a process ID of the current instance |
| box.info.replicaset | Information about the replica set to which the current instance belongs |
| box.info.replication | Statistics for all instances in the replica set |
| box.info.replication_anon() | List all the anonymous replicas following the instance |
| box.info.ro | The current mode of the instance (writable or read-only) |
| box.info.ro_reason | The reason why the current instance is read-only |
| box.info.schema_version | The database schema version |
| box.info.signature | The sum of all lsn values from each vector clock for all instances in the replica set |
| box.info.sql | Get information about the cache for all SQL prepared statements |
| box.info.status | The current state of the instance |
| box.info.synchro | The current state of synchronous replication |
| box.info.uptime | The number of seconds since the instance started |
| box.info.uuid | A globally unique identifier of the current instance |
| box.info.vclock | A table with the vclock values of all instances in a replica set which have made data changes |
| box.info.version | The Tarantool version |
| box.info.vinyl() | (Deprecated) Get runtime statistics for the vinyl storage engine |