Installation & Setup 🔰

Install the Python client

pip install iudex

Create a write-only API key 🔑

Click settings in the top left corner of the IUDEX dashboard and create a write-only API key.

Add IUDEX into your app 🚀

Add the following code to the very top of your entrypoint file (usually main.py, app.py, etc.).

from iudex import instrument
instrument(
    service_name="YOUR_SERVICE_NAME", # Highly encouraged
    iudex_api_key="WRITE_ONLY_IUDEX_KEY", # Only ever commit your WRITE ONLY key
    github_url="GITHUB_URL_TO_YOUR_REPO", # Optional, this sets up code linking
    env="prod", # Optional, dev, local, etc
)
# ^ Must run above all imports

Set up Slack alerts 📣

Click the Slack logo in the top right of the dashboard and follow the prompts.

Note: you must have admin permissions to add apps to your workspace.

Create a log 🪵

Add code to emit a log in your app.

# import logging
# logger = logging.getLogger(__name__)
logger.info("Hello IUDEX!", extra={"iudex.slack_channel_id": "YOUR_SLACK_CHANNEL_ID"})

Then run your app to emit the log.

Verify 🧐

You should see the log in Slack and in your IUDEX dashboard log view.

Go in-depth 👉

Check out more in-depth guides on how to get the most out of IUDEX for your stack.

Install the Node.js client

npm i iudex

pnpm add iudex

yarn add iudex

bun add iudex

Create a write-only API key 🔑

Click settings in the top left corner of the IUDEX dashboard and create a write-only API key.

Add IUDEX into your app 🚀

At the top of your app’s entry point file, add the following code snippet:

import { instrument } from 'iudex';
instrument({
  serviceName: 'YOUR_SERVICE_NAME', // Highly encouraged
  publicWriteOnlyIudexApiKey: 'YOUR_PUBLIC_WRITE_ONLY_KEY', // Only ever commit your WRITE ONLY key
  githubUrl: 'GITHUB_URL_TO_YOUR_REPO', // Optional, this sets up code linking
  env: 'production', // Optional, development, local, etc
});
//  ^ place this as high as possible in your code

If you are running to issues here with missing dependencies, you may need to switch to using the iudex-web package instead.

Set up Slack alerts 📣

Click the Slack logo in the top right of the dashboard and follow the prompts.

Note: you must have admin permissions to add apps to your workspace.

Create a log 🪵

Add code to emit a log in your app.

console.log('Hello IUDEX!', { ctx: { 'iudex.slack_channel_id': 'YOUR_SLACK_CHANNEL_ID' } });

Then run your app to emit the log.

Verify 🧐

You should see the log in Slack and in your IUDEX dashboard log view.

Go in-depth 👉

Check out more in-depth guides on how to get the most out of IUDEX for your stack.

Install the web JS client

npm i iudex-web

pnpm add iudex-web

yarn add iudex-web

bun add iudex-web

The difference between this client and iudex is that iudex-web is designed to be used in browser and web worker environments. It contains fewer automatic integrations and is generally more friendly to work with.

Create a write-only API key 🔑

Click settings in the top left corner of the IUDEX dashboard and create a write-only API key.

Add IUDEX into your app 🚀

At the top of your app’s entry point file, add the following code snippet:

import { instrument } from 'iudex-web';
instrument({
  serviceName: 'YOUR_SERVICE_NAME', // Highly encouraged
  publicWriteOnlyIudexApiKey: 'YOUR_PUBLIC_WRITE_ONLY_KEY', // Only ever commit your WRITE ONLY key
  githubUrl: 'GITHUB_URL_TO_YOUR_REPO', // Optional, this sets up code linking
  env: 'production', // Optional, development, local, etc
});
//  ^ place this as high as possible in your code

Set up Slack alerts 📣

Click the Slack logo in the top right of the dashboard and follow the prompts.

Note: you must have admin permissions to add apps to your workspace.

Create a log 🪵

Add code to emit a log in your app.

console.log('Hello IUDEX!', { ctx: { 'iudex.slack_channel_id': 'YOUR_SLACK_CHANNEL_ID' } });

Then run your app to emit the log.

Verify 🧐

You should see the log in Slack and in your IUDEX dashboard log view.

Go in-depth 👉

Check out more in-depth guides on how to get the most out of IUDEX for your stack.