Skip to main content

Pseekoo diagnostics toolkit for ELK, Bugsink/Sentry, and issue handoff workflows.

Project description

ojiichan

Pseekoo diagnostics toolkit for projects that report to ELK and Bugsink/Sentry.

It provides both:

  • a Python library (ojiichan) for structured ELK events and Sentry/Bugsink setup;
  • a CLI (ojiichan) for health checks, recent logs, and test event emission.

It standardizes the same observability workflow across Python services.

Install

uv add ojiichan
# with Locke/Vaultwarden credential support:
uv add "ojiichan[vault]"
# or for development:
uv sync

Configuration and credentials

Ojiichan resolves explicit environment variables first, then Locke/Vaultwarden secrets when installed with the vault extra. The checked-in locke.json documents the expected Vaultwarden paths; no sample env file with secret-shaped values is needed.

Default vault folder: ojiichan. Override it with OJIICHAN_VAULT_FOLDER when needed.

Non-secret options can still be set as env vars, for example ELASTICSEARCH_PORT, ELASTICSEARCH_USE_SSL, ELASTICSEARCH_VERIFY_CERTS, ELASTICSEARCH_TIMEOUT, and BUGSINK_TIMEOUT.

CLI

ojiichan health --hours 6
ojiichan logs --hours 2 --topic matrix --failures-only
ojiichan emit matrix_exchange_failed --topic auth --level error --failure \
  --data '{"operation":"matrix_exchange","room_id":"!abc"}'

Library

from ojiichan import ElkClient, init_sentry

init_sentry(service="stoz3n-chat-agent", environment="development")

elk = ElkClient(service="stoz3n-chat-agent")
elk.log_event(
    "matrix_exchange_start",
    {"operation": "matrix_exchange", "user_id": "@user:example.org"},
    topic="auth",
)

For exception paths:

try:
    ...
except Exception as exc:
    elk.log_event(
        "matrix_exchange_failed",
        {"operation": "matrix_exchange", "error": str(exc)},
        level="error",
        topic="auth",
        failure=True,
    )
    raise

MCP server

Ojiichan also ships a local stdio MCP server so coding agents can query diagnostics and run repeatable test/build checks without hardcoding shell snippets.

Run it manually:

uv run ojiichan-mcp

Example MCP client config:

{
  "mcpServers": {
    "ojiichan": {
      "command": "uv",
      "args": [
        "run",
        "--with",
        "ojiichan[vault]",
        "ojiichan-mcp"
      ]
    }
  }
}

Exposed tools:

  • elk_health
  • elk_logs
  • emit_elk_event
  • bugsink_health
  • bugsink_issues
  • create_bead_from_issue
  • xcode_build
  • xcode_test

For Xcode projects, an agent can call xcode_test with a local project_path, scheme, and destination.

Release

Publishing is handled by GitLab CI in the public martin-wieser/ojiichan repository:

  • pushes to the default branch publish a PEP 440 dev build to the GitLab PyPI registry;
  • tags matching vX.Y.Z publish the release to the GitLab PyPI registry and to pypi.org;
  • tagged releases require PYPI_API_TOKEN in GitLab CI variables.

To release the current version:

VERSION=$(python -c "import tomllib; print(tomllib.load(open('pyproject.toml','rb'))['project']['version'])")
git tag "v${VERSION}"
git push origin main --tags

Notes

  • Bugsink ingestion uses the normal Sentry SDK via SENTRY_DSN.
  • Bugsink issue reads use the canonical read API at /api/canonical/0/issues/ and require BUGSINK_API_TOKEN.
  • Beads integration is intentionally optional; ojiichan.beads shells out only when bead/beads is installed.
  • The public distribution and import package are both ojiichan.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ojiichan-0.1.1.tar.gz (13.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ojiichan-0.1.1-py3-none-any.whl (16.6 kB view details)

Uploaded Python 3

File details

Details for the file ojiichan-0.1.1.tar.gz.

File metadata

  • Download URL: ojiichan-0.1.1.tar.gz
  • Upload date:
  • Size: 13.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.13

File hashes

Hashes for ojiichan-0.1.1.tar.gz
Algorithm Hash digest
SHA256 044e574ffc06ef5849d88fdf5b67e11846fbf77b264c4db6447b29031cb3f3c4
MD5 6ba40d18cb19f397bb79315f2057c837
BLAKE2b-256 bccdbbd94deed81efc3ccc5477dd1c4384132eab6cb4bbb89db2d57c12c7a01e

See more details on using hashes here.

File details

Details for the file ojiichan-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: ojiichan-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 16.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.13

File hashes

Hashes for ojiichan-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 051921403b6521385961d788e7bde31046fb7135812b275207853ae63591ca66
MD5 2d7376e29d2e2958511b099b1a9c7868
BLAKE2b-256 b07b56cbdf08a5098d2acc9057cb30cb12da93bd0e6d99893fc80c769b9573ca

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page