8000 GitHub - tetranoir/iudex-python
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

tetranoir/iudex-python

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

51 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Iudex

Next generation observability.

Getting Started

Instrumenting your Python service to send logs to Iudex just takes a few steps.

  1. Pip install dependencies
pip install iudex
  1. Import instrument from iudex and invoke it in your entrypoint (usually main.py)
# Add this in your lambda function file (likely lambda_function.py)
from iudex.instrumentation import instrument
instrument(
  service_name=__name__, # or any string describing your service
  env="development", # or any string for your env
)
  1. Make sure the app has access to the environment variable IUDEX_API_KEY
  2. You should be all set! Go to https://app.iudex.ai/ and enter your API key
  3. Go to https://app.iudex.ai/logs and press Search to view your logs

FastAPI

If you use FastAPI, we highly recommend instrumenting your app for even more detailed logging and tracing.

Setup is the mostly the same as above, but you'll instead import instrument_fastapi where you define your FastAPI app (usually main.py).

# Add this
from iudex import instrument_fastapi

# Find this in your codebase
app = FastAPI()

# Add this
instrument_fastapi(
  app=app,
  service_name=__name__, # or any string describing your service
  env="development", # or any string for your env
)

Slack Alerts

You can easily configure Slack alerts on a per-log basis.

First visit https://app.iudex.ai/logs and click on the Add to Slack button in the top right.

Once installed to your workspace, tag your logs with the iudex.slack_channel_id attribute.

logger.info("Hello from Slack!", extra={"iudex.slack_channel_id": "YOUR_SLACK_CHANNEL_ID"})

Your channel ID can be found by clicking the name of the channel in the top left, then at the bottom of the dialog that pops up.

As long as the channel is public or you've invited the Iudex app, logs will be sent as messages to their tagged channel any time they are logged.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%
0