Skip to main content

Quickstart

By the end of this page you'll have an account, an API key, and your first traced event showing up in the dashboard.

Before you start

You'll need an API key scoped to telemetry. Any admin can create one under Organization settings → API Keys. Keep it secret and treat it like a password.

  1. 1
    Create your account
    Sign up with your work email, verify it, and create your organization. This takes about a minute. See the full walkthrough in Members & Invitations once you're ready to bring in your team.
  2. 2
    Create an API key
    In Organization settings → API Keys, create a key scoped to telemetry. You'll pass this to the SDK in the next step. See API Keys for details.
  3. 3
    Install the Python SDK
    Midil ships an official Python SDK, pymidil. Install it with the auth extra so it can talk to Observatory:
    pip install "pymidil[auth]"
    More language SDKs are on the way. See SDKs.
  4. 4
    Wrap your first consumer
    Wrap an existing consumer loop with ConsumerObserver, no rewrite required:
    from pymidil.event.observability import ConsumerObserver

    observe = ConsumerObserver(
      observatory_url="https://api.midil.io",
      api_key="mo_your_api_key",
      consumer="orders-worker",
      broker="kafka",  # any broker name works, it's just a label
    )

    async for record in your_existing_consumer:
      async with observe(record.key, "OrderPlaced", headers=record.headers):
          handle_order(record)
  5. 5
    Check the dashboard
    Open Overview. The first event your service reports should show up within moments. No extra setup needed.

What's next​