Enum DebugCommand 

pub(crate) enum DebugCommand {
    Echo {
        message: Vec<String>,
    },
    GetAuthChain {
        event_id: OwnedEventId,
    },
    ParsePdu,
    GetPdu {
        event_id: OwnedEventId,
    },
    GetShortPdu {
        shortroomid: ShortRoomId,
        count: i64,
    },
    GetRemotePdu {
        event_id: OwnedEventId,
        server: OwnedServerName,
    },
    GetRemotePduList {
        server: OwnedServerName,
        force: bool,
    },
    GetRoomState {
        room_id: OwnedRoomOrAliasId,
        kind: Option<String>,
        state_key: Option<String>,
    },
    GetSigningKeys {
        server_name: Option<OwnedServerName>,
        notary: Option<OwnedServerName>,
        query: bool,
    },
    GetVerifyKeys {
        server_name: Option<OwnedServerName>,
    },
    Ping {
        server: OwnedServerName,
    },
    ForceDeviceListUpdates,
    ChangeLogLevel {
        filter: Option<String>,
        reset: bool,
    },
    SignJson,
    VerifyJson,
    VerifyPdu {
        event_id: OwnedEventId,
    },
    FirstPduInRoom {
        room_id: OwnedRoomId,
    },
    LatestPduInRoom {
        room_id: OwnedRoomId,
    },
    ForceSetRoomStateFromServer {
        room_id: OwnedRoomId,
        server_name: OwnedServerName,
    },
    ResolveTrueDestination {
        server_name: OwnedServerName,
        no_cache: bool,
    },
    MemoryStats {
        opts: Option<String>,
    },
    RuntimeMetrics,
    RuntimeInterval,
    TaskMetrics,
    TaskInterval,
    Time,
    ListDependencies {
        names: bool,
    },
    DatabaseStats {
        property: Option<String>,
        map: Option<String>,
    },
    TrimMemory,
    DatabaseFiles {
        map: Option<String>,
        level: Option<i32>,
    },
    CreateJwt {
        user: String,
        exp_from_now: Option<u64>,
        nbf_from_now: Option<u64>,
        issuer: Option<String>,
        audience: Option<String>,
    },
    ResyncDatabase,
    GetRetainedPdu {
        event_id: OwnedEventId,
    },
    DumpPdus {
        dir: String,
    },
    Tester(TesterCommand),
}

Variants

Echo

• Echo input of admin command

Fields

message: Vec<String>

GetAuthChain

• Get the auth_chain of a PDU

Fields

event_id: OwnedEventId

An event ID (the $ character followed by the base64 reference hash)

ParsePdu

• Parse and print a PDU from a JSON

The PDU event is only checked for validity and is not added to the database.

This command needs a JSON blob provided in a Markdown code block below the command.

GetPdu

• Retrieve and print a PDU by EventID from the tuwunel database

Fields

event_id: OwnedEventId

An event ID (a $ followed by the base64 reference hash)

GetShortPdu

• Retrieve and print a PDU by PduId from the tuwunel database

Fields

shortroomid: ShortRoomId

Shortroomid integer

count: i64

PduCount integer

GetRemotePdu

• Attempts to retrieve a PDU from a remote server. Inserts it into our database/timeline if found and we do not have this PDU already (following normal event auth rules, handles it as an incoming PDU).

Fields

event_id: OwnedEventId

An event ID (a $ followed by the base64 reference hash)

server: OwnedServerName

Argument for us to attempt to fetch the event from the specified remote server.

GetRemotePduList

• Same as get-remote-pdu but accepts a codeblock newline delimited list of PDUs and a single server to fetch from

Fields

server: OwnedServerName

Argument for us to attempt to fetch all the events from the specified remote server.

force: bool

If set, ignores errors, else stops at the first error/failure.

GetRoomState

• Gets all the room state events for the specified room.

Fields

room_id: OwnedRoomOrAliasId

Room ID

kind: Option<String>

Event Type

state_key: Option<String>

State Key

GetSigningKeys

• Get and display signing keys from local cache or remote server.

Fields

server_name: Option<OwnedServerName>

notary: Option<OwnedServerName>

query: bool

GetVerifyKeys

• Get and display signing keys from local cache or remote server.

Fields

server_name: Option<OwnedServerName>

Ping

• Sends a federation request to the remote server’s /_matrix/federation/v1/version endpoint and measures the latency it took for the server to respond

Fields

server: OwnedServerName

ForceDeviceListUpdates

• Forces device lists for all local and remote users to be updated (as having new keys available)

ChangeLogLevel

• Change tracing log level/filter on the fly

This accepts the same format as the log config option.

Fields

filter: Option<String>

Log level/filter

reset: bool

Resets the log level/filter to the one in your config

SignJson

• Sign JSON blob

This command needs a JSON blob provided in a Markdown code block below the command.

VerifyJson

• Verify JSON signatures

This command needs a JSON blob provided in a Markdown code block below the command.

VerifyPdu

• Verify PDU

This re-verifies a PDU existing in the database found by ID.

Fields

event_id: OwnedEventId

FirstPduInRoom

• Prints the very first PDU in the specified room (typically m.room.create)

Fields

room_id: OwnedRoomId

The room ID

LatestPduInRoom

• Prints the latest (“last”) PDU in the specified room (typically a message)

Fields

room_id: OwnedRoomId

The room ID

ForceSetRoomStateFromServer

• Forcefully replaces the room state of our local copy of the specified room, with the copy (auth chain and room state events) the specified remote server says.

A common desire for room deletion is to simply “reset” our copy of the room. While this admin command is not a replacement for that, if you know you have split/broken room state and you know another server in the room that has the best/working room state, this command can let you use their room state. Such example is your server saying users are in a room, but other servers are saying they’re not in the room in question.

This command will get the latest PDU in the room we know about, and request the room state at that point in time via /_matrix/federation/v1/state/{roomId}.

Fields

room_id: OwnedRoomId

The impacted room ID

server_name: OwnedServerName

The server we will use to query the room state for

ResolveTrueDestination

• Runs a server name through tuwunel’s true destination resolution process

Useful for debugging well-known issues

Fields

server_name: OwnedServerName

no_cache: bool

MemoryStats

• Print extended memory usage

Optional argument is a character mask (a sequence of characters in any order) which enable additional extended statistics. Known characters are “abdeglmx”. For convenience, a ‘*’ will enable everything.

Fields

opts: Option<String>

RuntimeMetrics

• Print general tokio runtime metric totals.

RuntimeInterval

• Print detailed tokio runtime metrics accumulated since last command invocation.

TaskMetrics

• Print detailed tokio task metrics accumulated in total.

TaskInterval

• Print detailed tokio task metrics accumulated since last command invocation.

Time

• Print the current time

ListDependencies

• List dependencies

Fields

names: bool

DatabaseStats

• Get database statistics

Fields

property: Option<String>

map: Option<String>

TrimMemory

• Trim memory usage

DatabaseFiles

• List database files

Fields

map: Option<String>

level: Option<i32>

CreateJwt

• Create a JWT token for login

Fields

user: String

Localpart of the user’s MXID

exp_from_now: Option<u64>

Set expiration time in seconds from now.

nbf_from_now: Option<u64>

Set not-before time in seconds from now.

issuer: Option<String>

Claim an issuer.

audience: Option<String>

Claim an audience.

ResyncDatabase

• Synchronize database with primary (secondary only)

GetRetainedPdu

• Retrieves the saved original PDU before it has been redacted

Fields

event_id: OwnedEventId

DumpPdus

• Dump all stored PDUs

Fields

dir: String

Tester(TesterCommand)

• Developer test stubs

Trait Implementations

impl Debug for DebugCommand

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromArgMatches for DebugCommand

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Subcommand for DebugCommand

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut]

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut]

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand