Developer Documentation / Tutorials / Administration / Export logs with Python

Export logs with Python

💡 3 min read

Learn how to use Python to export logs as a JSON file

---

This article explains how to export the Onna platform activity logs as a JSON file using Python on Linux or macOS.

Info

You can run the script with your user account or as service account.
A service account is recommended, if you plan to run it recurrently or unattended.

Please contact support[at]onna.com for assistance with setting up a service account.

Requirements

• The same Python version used by Onna Enterprise. Currently 3.8 (opens new window)
• Python Virtual Environment (venv) (opens new window), included with Python 3.8
• Python Package Installer (pip) (opens new window)

Setup the virtual environment

1. Create a directory for your virtual environment, start the virtual environment, and then activate it.

mkdir ~/onna-export-logs
cd ~/onna-export-logs
python3 -m venv venv
source venv/bin/activate

2. Download the requirements file (opens new window).

curl -O https://raw.githubusercontent.com/onna/onna-tutorial-files/master/tutorials/admin/export-logs/requirements.txt

wget https://raw.githubusercontent.com/onna/onna-tutorial-files/master/tutorials/admin/export-logs/requirements.txt

3. Install the dependencies.

pip install -r requirements.txt

4. Download the sample script (opens new window).

curl -O https://raw.githubusercontent.com/onna/onna-tutorial-files/master/tutorials/admin/export-logs/auditlogs.py

wget https://raw.githubusercontent.com/onna/onna-tutorial-files/master/tutorials/admin/export-logs/auditlogs.py

5. To see the script's arguments, run ./venv/bin/python auditlogs.py --help.

./venv/bin/python auditlogs.py --help
usage: auditlogs.py [-h] --username USERNAME --password PASSWORD --account ACCOUNT --account_url ACCOUNT_URL --from_date FROM_DATE --to_date TO_DATE --fname FNAME [--container CONTAINER] --size SIZE
Download Onna audit logs
optional arguments:
  -h, --help            show this help message and exit
  --username USERNAME   Service Account username
  --password PASSWORD   password
  --account ACCOUNT     the Onna account name
  --account_url ACCOUNT_URL
                        the URL of your account, e.g https://company.onna.io or https://enterprise.onna.com
  --from_date FROM_DATE
                        start date. most date formats are accepted
  --to_date TO_DATE     end date. most date formats are accepted
  --fname FNAME         name of the file
  --container CONTAINER
                        name of the account container
  --size SIZE           result size

Where:

• USERNAME is your account email
• PASSWORD is your account password
• ACCOUNT is your account name
• ACCOUNT_URL is your account URL. For example, https://enterprise.onna.com/myaccount
• FROM_DATE is the start date of the logs to export. Use the format "MM/DD/YYYY"
• TO_DATE is the end date of the logs to export. Use the format "MM/DD/YYYY"
• FNAME is the name of the file. It will be saved as a JSON file in your /tmp folder
• CONTAINER is the name of your account. For more info, see the glossary.
• SIZE is the number of items downloaded for each batch

6. Run the script.

For example:

./venv/bin/python auditlogs.py --username example@example.td \
--password 1234 --account example \
--account_url https://enterprise.onna.com \
--from_date "01/01/2020" --to_date "01/20/2020" \
--fname example-audit --container example \
--size 100

Info

After running the script, remember to deactivate your virtual environment by typing deactivate in your shell.

The result will look similar to the output below:

Expand to see the example output

[
    {
        "_index": "user-activity-account-2019-07-11",
        "_type": "doc",
        "_id": "AWvhkN8cdgM3tma3FpC6",
        "_score": null,
        "_source": {
            "type": "log",
            "action": "nav-menu-opened",
            "payload": {
                "session-timestamp": 1562857496133,
                "route": "/dashboard/workspace/list",
                "element": "nav-menu-opened",
                "x": 42,
                "y": 42,
                "width": 1280,
                "height": 1024,
                "user_hash": "[sha256]30b52a374c4a20b643114e69dca3901283647233fe91916e1dcdd2e1d76784a9",
                "user": "robot.integration.test@gmail.com",
                "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_3) AppleWebKit/537.36 (KHTML, like Gecko) HeadlessChrome/76.0.3809.62 Safari/537.36",
                "origin": "https://enterprise.onna.com/account",
                "session-id": "78c2147335d64dc0b48e5667f684cd91",
                "account": "account"
            },
            "date": "2019-07-11",
            "@timestamp": "1562857496000"
        },
        "sort": [
            1562857496000
        ]
    },
    {
        "_index": "user-activity-account-2019-07-11",
        "_type": "doc",
        "_id": "AWvhkNsQdgM3tma3FpB8",
        "_score": null,
        "_source": {
            "type": "log",
            "action": "tracking-session",
            "payload": {
                "screen-width": 1440,
                "screen-height": 900,
                "os": "MacIntel",
                "browser": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_3) AppleWebKit/537.36 (KHTML, like Gecko) HeadlessChrome/76.0.3809.62 Safari/537.36",
                "user_hash": "[sha256]30b52a374c4a20b643114e69dca3901283647233fe91916e1dcd34re1d5b784a9",
                "user": "robot.integration.test@gmail.com",
                "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_3) AppleWebKit/537.36 (KHTML, like Gecko) HeadlessChrome/76.0.3809.62 Safari/537.36",
                "origin": "https://enterprise.onna.com/account",
                "session-id": "78c2147335d64dc0b48e5667f684cd91",
                "account": "account"
            },
            "date": "2019-07-11",
            "@timestamp": "1562857495000"
        },
        "sort": [
            1562857495000
        ]
    },
    {
        "_index": "user-activity-account-2019-07-11",
        "_type": "doc",
        "_id": "AWvhkMu-dgM3tma3Foru",
        "_score": null,
        "_source": {
            "type": "log",
            "action": "tracking-session",
            "payload": {
                "screen-width": 1440,
                "screen-height": 900,
                "os": "MacIntel",
                "browser": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_3) AppleWebKit/537.36 (KHTML, like Gecko) HeadlessChrome/76.0.3809.62 Safari/537.36",
                "user_hash": "[sha256]30b52a374c4a20b643114e69dca39012836474r3fe91916e1dcdd2e1d5b784a9",
                "user": "robot.integration.test@gmail.com",
                "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_3) AppleWebKit/537.36 (KHTML, like Gecko) HeadlessChrome/76.0.3809.62 Safari/537.36",
                "origin": ""https://enterprise.onna.com/account",
                "session-id": "37c8358bd3174e2da82f3341faa2bd60",
                "account": "account"
            },
            "date": "2019-07-11",
            "@timestamp": "1562857491000"
        },
        "sort": [
            1562857491000
        ]
    }
]

---