Skip to main content

Nexarch SDK for runtime architecture intelligence and observability

Project description

Nexarch SDK - Python

Runtime architecture intelligence SDK for FastAPI applications.

Installation

pip install nexarch-sdk

Quick Start

from fastapi import FastAPI
from nexarch import NexarchSDK

app = FastAPI(title="My API")

sdk = NexarchSDK(
    api_key="your_api_key_here",
    environment="production",
    service_name="orders-api",
    project_name="checkout-platform",
    http_endpoint="https://api.modelix.world",
)
sdk.init(app)

What Gets Captured

  • Incoming HTTP spans with latency and status code
  • Unhandled errors with trace context
  • Downstream dependency hints (HTTP/database)
  • Architecture discovery snapshots (service endpoints, dependencies)

Data Export Model

  • Telemetry is exported remotely to Nexarch ingest APIs.
  • Internal /__nexarch/* telemetry endpoints are no longer injected.
  • Local JSON telemetry logging is no longer part of the SDK runtime path.

Configuration

sdk = NexarchSDK(
    api_key="your_api_key",               # required
    environment="production",             # optional
    service_name="payments-api",          # optional
    project_name="checkout-platform",     # optional, defaults to service_name
    http_endpoint="https://api.modelix.world",  # optional (or NEXARCH_HTTP_ENDPOINT)
    sampling_rate=1.0,                     # optional: 0.0 - 1.0
    enable_auto_discovery=True,            # optional
    enable_db_instrumentation=True,        # optional
)

Notes

  • project_name is sent with spans and discovery payloads for project-level analytics.
  • Heartbeats are sent to /api/v1/sdk/heartbeat.
  • Spans are sent to /api/v1/ingest/spans or /api/v1/ingest/batch.

Security & Privacy

  • No source code upload.
  • Request/response bodies are not captured by default.
  • Sensitive headers are sanitized.

Development

pip install -e .
pytest

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

nexarch_sdk-0.2.1.tar.gz (20.9 kB view details)

Uploaded Source

Built Distribution

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

nexarch_sdk-0.2.1-py3-none-any.whl (24.6 kB view details)

Uploaded Python 3

File details

Details for the file nexarch_sdk-0.2.1.tar.gz.

File metadata

  • Download URL: nexarch_sdk-0.2.1.tar.gz
  • Upload date:
  • Size: 20.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.19

File hashes

Hashes for nexarch_sdk-0.2.1.tar.gz
Algorithm Hash digest
SHA256 be888c5c8c87348617900a0064c2fe4e57c717d361fcd0240d21dd6ed0105415
MD5 f046104cc77e4a87c3979706015f749a
BLAKE2b-256 47196ba0a92c23def10f9731ace5197b1da257f8c5386985c221ee51d807f16a

See more details on using hashes here.

File details

Details for the file nexarch_sdk-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: nexarch_sdk-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 24.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.19

File hashes

Hashes for nexarch_sdk-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0ab65fa6e4632ddd6463988aca4d8f191491c5c26e63e8563603c98029080eac
MD5 15fcf56bcdabcb95fbc04d0f0bc7bddc
BLAKE2b-256 c323b5d2d2ec7325a37b83e960caae7a0506fdaa8a079d602cd1f026d546836c

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