Kqlmagic: Microsoft Azure Monitor magic extension to Jupyter notebook.

PyPI link: https://pypi.org/project/kqlmagic/, PePy download information:

Kqlmagic magic extension enables notebook experience, exploring Microsoft Azure Monitor data: Azure Data Explorer (Kusto), ApplicationInsights, and LogAnalytics data, from Jupyter notebook (Python3 kernel), using kql (Kusto Query language).

Install

Option 1: Via PyPi

To install via the Python Package Index (PyPI), type:

pip install Kqlmagic

Option 2: Source Via Git

To get the source code of the SDK via git just type:

git clone git://github.com/Microsoft/jupyter-Kqlmagic.git
cd ./jupyter-Kqlmagic
python setup.py install

Option 3: Source Zip

Download a zip of the code via GitHub or PyPI. Then follow the same instructions as in option 2.

Dependencies control

You can control which Kqlmagic dependencies will be installed, by settimg installing KqlmagicCustom instead of Kqlmagic with extras_require. Features that require a missing dependency will be disabled. Following is the List of the Extras:

'default',
    'jupyter-all',
    'ipython-all',
    'python-all',

        'plotly',
        'pandas',
        'widgets',

        'extended',
            'jupyter-extended',
            'ipython-extended',
            'python-extended',

            'sso',
                'azcli_sso',
                'msi_sso',
                'vscode_sso',
                'msal_sso',
                'kqlmagic_sso',
                'kqlmagic_msal_sso',
                'kqlmagic_fernet_sso',

            'utils',
                'base_utils',
                'text_utils',
                'json_color',
                'auth_code_clipboard',
                'matplotlib_palettes',

            'basic',
                'jupyter-basic',
                'ipython-basic',
                'python-basic',

                    'naked',

Some packages are mandatory, and Kqlmagic won't start without them. Most packages are optional, and Kqlmagic will disable the functionality that is based on the missing dependencies.

for example: will install extended packages + pandas:

pip install KqlmagicCustom[extended, pandas]

will install extended basic packages that work with Jupyter, azcli single sign on and plotly:

pip install KqlmagicCustom[jupyter-basic,azcli_sso,plotly]

Versions

This library follows Semantic Versioning.

You can find the changes for each version under Releases.

Minimum Requirements

• Python 3.6+
• See setup.py for dependencies

Load

To load the Kqlmagic extension, run in notebook cell:

In [ ]: %reload_ext Kqlmagic

Authentication methods

• AAD Username/password - Provide your AAD username and password.
• AAD application - Provide your AAD tenant ID, AAD app ID and app secret.
• AAD code - Provide only your AAD username, and authenticate yourself using a code, generated by ADAL.
• certificate - Provide your AAD tenant ID, AAD app ID, certificate and certificate-thumbprint (supported only with Azure Data Explorer)
• appid/appkey - Provide you application insight appid, and appkey (supported only with Application Insights)

Get Started Notebooks

• Get Started with Kqlmagic for Kusto

• Get Started with Kqlmagic for Application Insights

• Get Started with Kqlmagic for Log Analytics

• Parametrize your Kqlmagic query with Python

• Choose colors palette for your Kqlmagic query chart result

Need Support?

• Have a feature request for Kqlmagic? Please post it on User Voice to help us prioritize
• Have a technical question? Ask on Stack Overflow with tag "Kqlmagic"
• Need Support? Every customer with an active Azure subscription has access to support with guaranteed response time. Consider submitting a ticket and get assistance from Microsoft support team
• Found a bug? Please help us fix it by thoroughly documenting it and filing an issue.

Contribute

We gladly accept community contributions.

• Issues: Please report bugs using the Issues section of GitHub
• Forums: Interact with the development teams on StackOverflow or the Microsoft Azure Forums
• Source Code Contributions: If you would like to become an active contributor to this project please follow the instructions provided in Contributing.md.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

For general suggestions about Microsoft Azure please use our UserVoice forum.