Welcome to gadget-python’s documentation!

Contents:

Overview

What is Gadget?

Gadget is a mechanism intended to improve the speed of investigating bugs from post-mortem logs.

Gadget operates by embedding specifically-marked log lines which can later be parsed. Log lines indicate important events in your flow, which you may be interested in finding later.

There are several types of events:

  1. Operation: indicates that some action happened to or on some entity. It must contain the name of the entity and the name of the operation, and may contain other arbitrary parameters
  2. Update: Indicates that a certain entity has been updated. It must contain the update data (but not necessarily the new state)
  3. State: Indicates a new state for a given entity

What is gadget-python?

gadget-python is the Python library used to emit Gadget-targeted log lines and parse them.

Using Gadget

Logging Operations

>>> gadget.log_operation('setup', 'db1', {'use_transactions': True})

The code above will log that an operation called setup ran on an entity named db1, and as extra parameters would include {'use_transactions': True}.

Note

entities of operations can be either a single string id, a list of ids, or a dictionary mapping entitiy roles to entity ids:

>>> gadget.log_operation('copy', {'source': '/tmp/file1.txt', 'target': '/tmp/file2.txt'})

Note

entity ids are completely arbitrary, and it is the user’s responsibility to make sure they are indeed unique in the log.

Logging Updates

>>> gadget.log_update('db1', {'connection_string': '...'})

Logging States

>>> gadget.log_state('db1', {'connected': True, 'num_records': 1000})

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/getslash/gadget-python/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation

gadget-python could always use more documentation, whether as part of the official gadget-python docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/getslash/gadget-python/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up gadget-python for local development.

  1. Fork the gadget-python repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/gadget-python.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 gadget
$ cd gadget/
$ 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:

    $ flake8 gadget tests
$ python setup.py test or py.test
$ tox

    To get flake8 and tox, just pip install them 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, 2.7, 3.3, 3.4 and 3.5, and for PyPy. Check https://travis-ci.org/getslash/gadget-python/pull_requests and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

$ py.test tests.test_something

History

0.1.0 (2016-08-16)

  • First release on PyPI.

Indices and tables