Features¶

• Send logs and metrics to Zeus
• Query both logs and metrics

Create a Zeus client¶

To use Zeus Python Client in a project:

from zeus import client

Create a ZeusClient object:

z = client.ZeusClient(USER_TOKEN, 'api.ciscozeus.io')

Now you are ready to start sending and querying logs and metrics. :D

Logs¶

logs = [
    {"message": "My Test Log"},
    {"message": "My Second Test Log"}
]
z.sendLog("<LOG_NAME>",logs)

z.getLog('<LOG_NAME>',
          pattern='*',
          from_date=123456789,
          to_date=126235344235,
          offset=23,
          limit=10)

Metrics¶

metrics = [
    {"timestamp": 123541423,
     "point": {"column1": 1, "column2": 2}},
    {"timestamp": 123541424,
     "point": {"column1": 3, "column2": 4}},
    {"timestamp": 123541425,
     "point": {"column1": 5, "column2": 6}}
]
z.sendMetric("<METRIC_NAME>",metrics)

z.getMetricNames(metric_name="<METRIC_NAME>", limit=10)

z.getMetric(metric_name='ZeusTest',
            aggregator='sum',
            from_date=123456789,
            to_date=126235344235,
            group_interval='1m',
            filter_condition='value > 90',
            limit=10)

z.deleteMetric('ZeusTest')

Dates¶

All dates must be in the Unix timestamp format.

Types of Contributions¶

Get Started!¶

Ready to contribute? Here’s how to set up zeus for local development.

1. Fork the zeus repo on GitHub.

2. Clone your fork locally:

   $ git clone git@github.com:your_name_here/python-zeusclient.git
   

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

   $ mkvirtualenv zeus
   $ cd python-zeusclient/
   $ python setup.py develop
   

4. Create a branch for local development:

   $ git checkout -b name-of-your-bugfix-or-feature
   

   Now you can make your changes locally.

5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

   $ tox
   

   To get tox, just pip install it into your virtualenv.

6. Commit your changes and push your branch to GitHub:

   $ git add .
   $ git commit -m "Your detailed description of your changes."
   $ git push origin name-of-your-bugfix-or-feature
   

7. Submit a pull request through the GitHub website.

Pull Request Guidelines¶

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
3. The pull request should work for Python 2.6 and 2.7 and for the Docs. Check https://github.com/CiscoZeus/python-zeusclient/pull_requests and make sure that the tests pass for all supported Python versions.

Tips¶

To run a subset of tests:

$ python -m unittest tests.test_zeus_client

Development Lead¶

• Marc Solanas Tarre <msolanas@cisco.com>

Contributors¶

• Johnu George <johnugeo@cisco.com>
• Kai Zhang <kazhang2@cisco.com>