Installation

The elsai ARMS SDK is a single Python package — elsai-arms — published to our private package index. The same package name is used for both SaaS and on-prem; the difference is which index URL you install from and which version is current for your deployment.

Prerequisites

SaaS

• Python 3.10, 3.11, or 3.12
• pip package manager
• elsai_ARMS_API_KEY from the cloud dashboard

On-Prem

• Python >= 3.9
• pip package manager
• Database backend configured (MongoDB, DynamoDB, or ClickHouse)

Install the SDK

SaaS

pip install \
  --extra-index-url https://arms-packages.elsaifoundry.ai/root/elsai-arms-sass/ \
  elsai-arms==1.3.4

On-Prem

pip install \
  --index-url https://arms-packages.elsaifoundry.ai/root/elsai-arms/ \
  --extra-index-url https://pypi.org/simple \
  elsai-arms==2.2.0

TIP

SaaS: Set elsai_ARMS_API_KEY and start monitoring — no database setup required. See SaaS configuration.

On-Prem: Configure API_BASE_URL, database connection, and elsai_ARMS_API_KEY. See on-prem configuration.

TIP

Pin a specific version (==1.3.4 for SaaS, ==2.2.0 for on-prem) in production. Upgrade deliberately after reviewing release notes.

elsai Agents monitoring (on-prem only)

To monitor applications built with the elsai Agents SDK, install the optional extra from the on-prem index:

pip install \
  --index-url https://arms-packages.elsaifoundry.ai/root/elsai-arms/ \
  --extra-index-url https://pypi.org/simple \
  'elsai-arms[elsai-agents]'

This adds elsai-agents>=0.2.1 as a dependency. See elsai Agents monitoring for setup and usage.

Verify installation

pip show elsai-arms

python -c "from elsai_arms.elsai_arms import elsaiARMS; print('SDK installed:', elsaiARMS.__module__)"

Upgrade to latest version

SaaS

pip install \
  --extra-index-url https://arms-packages.elsaifoundry.ai/root/elsai-arms-sass/ \
  elsai-arms --upgrade

On-Prem

pip install \
  --index-url https://arms-packages.elsaifoundry.ai/root/elsai-arms/ \
  --extra-index-url https://pypi.org/simple \
  elsai-arms --upgrade

Next steps

• SaaS configuration — API key and dashboard setup
• On-prem configuration — database and environment variables
• User guide — integrate monitoring into your application

INFO

Need help? Contact dev@elsaifoundry.ai.