Package Manager Journaling
This page explains how to use the kxi pm journal command in kdb Insights Enterprise using the Command Line Interface (CLI) for observability purposes.
The kxi pm journal command provides administrators with a server-wide view of all successful events executed in the kdb Insights Enterprise Package Manager.
Usage
Unlike package-specific commands, the kxi pm journal command is designed as a server observability feature, enabling you to:
- View historical records of executed actions in the Package Manager
- Audit actions across all users and packages.
- Support auditing, troubleshooting, and operational oversight
Warning
The kxi pm journal command requires the Package Admin role.
Run the command as follows:
kxi pm journal
Running the --help command displays all available options that you can use with the kxi pm journal command:
kxi pm journal --help
Usage: kxi pm journal [OPTIONS]
Get the current journal history of the kdb+ Insights Enterprise Package
Manager service.
╭─ Authentication option overrides ────────────────────────────────────────────╮
│ --hostname,--url TEXT Insights URL │
│ --realm TEXT Realm │
│ --client-id TEXT Client id │
│ --client-secret TEXT Client secret │
│ --auth-enabled/--auth-disabled Retrieve Bearer Token │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --server-timeout INTEGER Timeout for Insights │
│ server calls │
│ --yes,--assume-yes -y Automatic yes to prompts; │
│ assume "yes" as answer to │
│ all prompts and run │
│ non-interactively. │
│ --output-format -o [json|table] Output format for the │
│ command. default: 'table'. │
│ --fields TEXT [default: timestamp, │
│ action, username, package, │
│ component_type, component, │
│ message, params] │
│ --action -a TEXT │
│ --package -p TEXT │
│ --username -u TEXT │
│ --component -c TEXT │
│ --limit -l INTEGER [default: 1000] │
│ --offset INTEGER │
│ --from [%Y-%m-%d|%Y-%m-%dT%H:%M │
│ :%S|%Y-%m-%d %H:%M:%S] │
│ --to [%Y-%m-%d|%Y-%m-%dT%H:%M │
│ :%S|%Y-%m-%d %H:%M:%S] │
│ --sort TEXT Comma-separated list of │
│ fields to sort by. Prefix │
│ a field with '-' for │
│ descending order. Example: │
│ 'username,-timestamp' │
│ [default: -timestamp] │
│ --help Show this message and │
│ exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Example commands
-
Retrieve journal entries for a specific user:
kxi pm journal --username alice -
Limit results to the last 10 entries in JSON format:
kxi pm journal --limit 10 --output-format json -
Filter by time range:
kxi pm journal --from 2025-01-01 --to 2025-01-31 -
Filter by action type (for example, install):
kxi pm journal --action install