access-py-telemetry

An IPython/Jupyter extension that instruments registered Python function calls and sends non-blocking usage telemetry to remote endpoints.

This documentation is organised for two audiences:

• End users — people using packages that already have telemetry integrated (e.g. intake, payu) who want to understand or control whether it runs.

• Developers — library authors who want to add usage tracking to their own packages.

Getting Started

• Installation

End Users

• For End Users
  • CLI Reference: access-py-telemetry
  • What data is collected?
• CLI Reference: access-py-telemetry
  • Quick reference
  • Options
  • How it works
  • System-wide installation

Developers

• For Developers
  • Integrating Telemetry into Your Package
  • Configuration Reference
  • Decorator Reference
  • API Reference
  • Overview
• Integrating Telemetry into Your Package
  • Step 1: Add the dependency
  • Step 2: Define your config.yaml
  • Step 3: Register functions using decorators
  • Step 4: Register functions dynamically (alternative to decorators)
  • Step 5: Add extra fields
  • Step 6: Request an endpoint
  • Step 7: Update config.yaml in this repo
  • Telemetry payload format
• Configuration Reference
  • config.yaml structure
  • Production vs staging
  • Session identifiers
  • Checking the registry
• Decorator Reference
  • @ipy_register_func
  • @register_func
  • Adding extra fields after decoration
  • Removing default fields
  • Checking what’s registered
  • Deregistering functions
• API Reference
  • access_py_telemetry.api
  • access_py_telemetry.registry
  • access_py_telemetry.decorators
  • access_py_telemetry.ast
  • access_py_telemetry.cli

Project

• Changelog
• Contributing