Path: csiph.com!v102.xanadu-bbs.net!xanadu-bbs.net!news.mixmin.net!rt.uk.eu.org!newsfeed.xs4all.nl!newsfeed3.news.xs4all.nl!xs4all!post.news.xs4all.nl!not-for-mail
Return-Path: <itamar@hybridcluster.com>
X-Original-To: python-announce-list@python.org
Delivered-To: python-announce-list@mail.python.org
X-Spam-Status: OK 0.000
X-Spam-Evidence: '*H*': 1.00; '*S*': 0.00; 'url:pypi': 0.03; 'cpython': 0.05; 'messages.': 0.05; 'tree': 0.05; 'element': 0.07; 'encoded': 0.07; 'json': 0.07; 'nested': 0.07; 'pypi': 0.07; 'output,': 0.09; 'typed': 0.09; 'url:github': 0.09; 'python': 0.11; '<>.': 0.14; 'apache': 0.15; 'attempted.': 0.16; 'blocking': 0.16; 'docs.': 0.16; 'format:': 0.16; 'license.': 0.16; 'optional': 0.16; 'path.': 0.16; 'pypi.': 0.16; 'pypy.': 0.16; 'subject:Logging': 0.16; 'to:addr:python-announce-list': 0.16; 'tracing': 0.16; 'twisted': 0.16; 'url:example': 0.16; 'usable': 0.16; 'code.': 0.18; 'install': 0.23; 'header:User-Agent:1': 0.23; '2.0': 0.26; 'logging': 0.26; 'skip:" 20': 0.27; 'testing': 0.29; 'feature': 0.29; 'thus': 0.29; 'errors': 0.30; 'code': 0.31; 'page.': 0.31; 'requests': 0.31; 'filed': 0.31; 'trace': 0.31; 'url:python': 0.33; 'bugs': 0.33; 'not.': 0.33; 'url:org': 0.36; 'should': 0.36; 'unit': 0.37; 'project': 0.37; 'skip:& 10': 0.38; 'actions': 0.38; 'ability': 0.39; 'bad': 0.39; 'to:addr:python.org': 0.39; 'read': 0.60; 'eventually': 0.60; 'logs': 0.60; 'tell': 0.60; "you'll": 0.62; 'url:index': 0.63; 'become': 0.64; 'caused': 0.69; 'information:': 0.72; 'received:109': 0.72; 'received:199': 0.74; 'actions,': 0.84; 'actions.': 0.84; 'execution.': 0.84; 'features:': 0.84; 'found!': 0.84; 'install:': 0.84; 'story:': 0.84
Date: Fri, 16 May 2014 10:44:46 -0400
From: Itamar Turner-Trauring <itamar@hybridcluster.com>
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:24.0) Gecko/20100101 Thunderbird/24.5.0
MIME-Version: 1.0
To: python-announce-list@python.org
Subject: Eliot: a framework for Logging as Storytelling
X-Enigmail-Version: 1.6
X-Spam-bar: -
X-Mailman-Approved-At: Mon, 19 May 2014 10:06:06 +0200
Content-Type: text/plain; charset=ISO-8859-1
Content-Transfer-Encoding: 7bit
X-Content-Filtered-By: Mailman/MimeDel 2.1.15
X-BeenThere: python-announce-list@python.org
X-Mailman-Version: 2.1.15
Precedence: list
Reply-To: python-list@python.org
List-Id: Announcement-only list for the Python programming language <python-announce-list.python.org>
List-Unsubscribe: <https://mail.python.org/mailman/options/python-announce-list>, <mailto:python-announce-list-request@python.org?subject=unsubscribe>
List-Archive: <http://mail.python.org/pipermail/python-announce-list/>
List-Post: <mailto:python-announce-list@python.org>
List-Help: <mailto:python-announce-list-request@python.org?subject=help>
List-Subscribe: <https://mail.python.org/mailman/listinfo/python-announce-list>, <mailto:python-announce-list-request@python.org?subject=subscribe>
Approved: python-announce-list@python.org
Newsgroups: comp.lang.python.announce
Message-ID: <mailman.10128.1400486767.18130.python-announce-list@python.org>
Lines: 57
NNTP-Posting-Host: 2001:888:2000:d::a6
X-Trace: 1400486767 news.xs4all.nl 2912 [2001:888:2000:d::a6]:52792
X-Complaints-To: abuse@xs4all.nl
Xref: csiph.com comp.lang.python.announce:1281

Eliot provides a structured logging and tracing system for Python that
generates log messages describing a forest of nested actions. Actions
start and eventually finish, successfully or not. Log messages thus tell
a story: what happened and what caused it.

Here's what your logs might look like before using Eliot:

Going to validate http://example.com/index.html.
Started download attempted.
Download succeeded!
Missing <title> element in "/html/body".
Bad HTML entity in "/html/body/p[2]".
2 validation errors found!

After switching to Eliot you'll get a tree of messages with both message
contents and causal relationships encoded in a structured format:

  * {"action_type": "validate_page", "action_status": "started", "url":
    "http://example.com/index.html"}
      o {"action_type": "download", "action_status": "started"}
      o {"action_type": "download", "action_status": "succeeded"}
      o {"action_type": "validate_html", "action_status": "started"}
          + {"message_type": "validation_error", "error_type":
            "missing_title", "xpath": "/html/head"}
          + {"message_type": "validation_error", "error_type":
            "bad_entity", "xpath": "/html/body/p[2]"}
      o {"action_type": "validate_html", "action_status": "failed",
        "exception": "validator.ValidationFailed"}
  * {"action_type": "validate_page", "action_status": "failed",
    "exception": "validator.ValidationFailed"}

Features:

  * Structured, typed log messages.
  * Ability to log actions, not just point-in-time information: log
    messages become a trace of program execution.
  * Excellent support for unit testing your logging code.
  * Emphasis on performance, including no blocking I/O in logging code path.
  * Optional Twisted support.
  * Designed for JSON output, usable by Logstash/Elasticsearch.
  * Supports CPython 2.7, 3.3 and PyPy.

Eliot is released by HybridCluster <https://hybridcluster.github.io>
under the Apache 2.0 License.

To install:

$ pip install eliot

Downloads are available on PyPI <https://pypi.python.org/pypi/eliot>.

Documentation can be found on Read The Docs
<https://eliot.readthedocs.org/>.

Bugs and feature requests should be filed at the project Github page
<https://github.com/hybridcluster/eliot>.