Git

IUDEX can link every log or trace to a specific commit in your repo.

This way you can quickly identify the commit that caused an issue, or filter by commit to see logs for a newly deployed feature.

Each log will have a GitHub link to the exact line of code that caused it!

Setup

You should already have IUDEX instrumentation set up. If not, follow the Getting Started guide first.

Set the follwing environment variables in your runtime:

GITHUB_URL

The base URL of your repo, e.g. https://github.com/iudexai/iudex-python.

GIT_COMMIT

The current commit hash, e.g. 4d1b7b3.

We recommend detecting the commit and setting it in your CI/CD pipeline. For instance, you can use:

git rev-parse HEAD

within a git repo to fetch the most recent commit.

instrument(
    service_name="my-service",
    iudex_api_key="ixk_...",
    env="production",
    github_url="BASE_URL_OF_YOUR_REPO",
    git_commit="CURRENT_COMMIT_HASH",
)

instrument({
  serviceName: 'my-service',
  publicWriteOnlyIudexApiKey: 'ixk_...',
  env: 'production',
  githubUrl: 'BASE_URL_OF_YOUR_REPO',
  gitCommit: 'CURRENT_COMMIT_HASH',
});

Usage

You should be all set! Now any logs sent to IUDEX will be linked to their related commit (and line of code).