Commands¶
ralph¶
Ralph is a stream-based tool to play with your logs.
Usage:
ralph [OPTIONS] COMMAND [ARGS]...
Options:
-v, --verbosity LVL Either CRITICAL, ERROR,
WARNING, INFO (default) or
DEBUG
--help Show this message and exit.
ralph convert¶
Converts input events to a given format.
Usage:
ralph convert [OPTIONS]
Options:
From edX to xAPI converter options:
-u, --uuid-namespace TEXT The UUID
namespace to use
for the `ID`
field generation
-p, --platform-url TEXT The `actor.accou
nt.homePage` to
use in the xAPI
statements
[required]
-f, --from [edx] Input events
format to
convert
[required]
-t, --to [xapi] Output events
format
[required]
-I, --ignore-errors Continue writing
regardless of
raised errors
-F, --fail-on-unknown Stop converting
at first unknown
event
--help Show this
message and
exit.
ralph extract¶
Extracts input events from a container format using a dedicated parser.
Usage:
ralph extract [OPTIONS]
Options:
-p, --parser [gelf|es] Container format parser
used to extract events
[required]
--help Show this message and
exit.
ralph fetch¶
Fetch an archive or records from a configured backend.
Usage:
ralph fetch [OPTIONS] [ARCHIVE]
Options:
ws backend:
--ws-uri TEXT
swift backend:
--swift-os-identity-api-version TEXT
--swift-os-auth-url TEXT
--swift-os-project-domain-name TEXT
--swift-os-user-domain-name TEXT
--swift-os-storage-url TEXT
--swift-os-region-name TEXT
--swift-os-password TEXT
--swift-os-username TEXT
--swift-os-tenant-name TEXT
--swift-os-tenant-id TEXT
fs backend:
--fs-path TEXT
ldp backend:
--ldp-stream-id TEXT
--ldp-service-name TEXT
--ldp-consumer-key TEXT
--ldp-application-secret TEXT
--ldp-application-key TEXT
--ldp-endpoint TEXT
es backend:
--es-op-type TEXT
--es-client-options KEY=VALUE,KEY=VALUE
--es-index TEXT
--es-hosts TEXT
-b, --backend [es|ldp|fs|swift|ws]
Backend
[required]
-c, --chunk-size INTEGER Get events by
chunks of size #
--help Show this
message and
exit.
ralph list¶
List available archives from a configured storage backend.
Usage:
ralph list [OPTIONS]
Options:
swift backend:
--swift-os-identity-api-version TEXT
--swift-os-auth-url TEXT
--swift-os-project-domain-name TEXT
--swift-os-user-domain-name TEXT
--swift-os-storage-url TEXT
--swift-os-region-name TEXT
--swift-os-password TEXT
--swift-os-username TEXT
--swift-os-tenant-name TEXT
--swift-os-tenant-id TEXT
fs backend:
--fs-path TEXT
ldp backend:
--ldp-stream-id TEXT
--ldp-service-name TEXT
--ldp-consumer-key TEXT
--ldp-application-secret TEXT
--ldp-application-key TEXT
--ldp-endpoint TEXT
-b, --backend [ldp|fs|swift] Backend
[required]
-n, --new / -a, --all List not fetched
(or all)
archives
-D, --details / -I, --ids Get archives
detailed output
(JSON)
--help Show this
message and
exit.
ralph push¶
Push an archive to a configured backend.
Usage:
ralph push [OPTIONS] [ARCHIVE]
Options:
swift backend:
--swift-os-identity-api-version TEXT
--swift-os-auth-url TEXT
--swift-os-project-domain-name TEXT
--swift-os-user-domain-name TEXT
--swift-os-storage-url TEXT
--swift-os-region-name TEXT
--swift-os-password TEXT
--swift-os-username TEXT
--swift-os-tenant-name TEXT
--swift-os-tenant-id TEXT
fs backend:
--fs-path TEXT
ldp backend:
--ldp-stream-id TEXT
--ldp-service-name TEXT
--ldp-consumer-key TEXT
--ldp-application-secret TEXT
--ldp-application-key TEXT
--ldp-endpoint TEXT
es backend:
--es-op-type TEXT
--es-client-options KEY=VALUE,KEY=VALUE
--es-index TEXT
--es-hosts TEXT
-b, --backend [es|ldp|fs|swift]
Backend
[required]
-c, --chunk-size INTEGER Get events by
chunks of size #
-f, --force Overwrite
existing
archives or
records
-I, --ignore-errors Continue writing
regardless of
raised errors
--help Show this
message and
exit.
ralph runserver¶
Run the API server for the development environment. Starting uvicorn programmatically for convenience and documentation.
Usage:
ralph runserver [OPTIONS]
Options:
--help Show this message and exit.
ralph validate¶
Validates input events of given format.
Usage:
ralph validate [OPTIONS]
Options:
-f, --format [edx|xapi] Input events format to
validate [required]
-I, --ignore-errors Continue validating
regardless of raised
errors
-F, --fail-on-unknown Stop validating at
first unknown event
--help Show this message and
exit.