Skip to main content

Write data to key=val pairs, for human and machine readability

Project description

kayvee-python

Kayvee translates an dictionary into a human and machine parseable string, with a "json" format.

Usage

The Kayvee formatter can be used directly or through the kayvee.logger

kayvee formatter

import kayvee as kv

print(kv.format(source="logger-test",
                level=kv.INFO,
                title="informational-log-title",
                dict(id=name_id, context=context_str))

kayvee.logger

import kayvee.logger as logger

log = logger.Logger("logger-test")
log.info("information-log-title", dict(id=name_id, context=context_str))

# Pass global variables:
log = logger.Logger("logger-test", default_fields=dict("query"=query))
log.info("msg-title")

Other functions supported for structured logging:

  • Logger.debug
  • Logger.info
  • Logger.warn
  • Logger.error
  • Logger.critical

Supported metrics:

  • Logger.counter
  • Logger.gauge

Releasing a new version

When you merge changes for a new version:

  • bump the VERSION
  • update CHANGELOG.md explaining the changes
  • after merging, run publish.sh
    • requires you to install twine and wheel via pip install <package>
    • creates a git tag associating the version with the commit
    • publishes the versioned package to pypi (Python package store)

If you have any issues, please work with #oncall-infra.

3.0.0 (2022-04-18)

  • Upgrade to python 3.9.12

2.0.2 (2016-05-20)

  • Fix broken Logger. Add default_fields support to logger.

2.0.1 (2016-01-21)

  • Allow pip installing for all Pip versions. Avoid parse_requirements error.

2.0.0 (2015-10-06)

  • add kayvee.logger support for direct logging; metrics support

1.0.1 (2014-01-05)

  • Support for Pip version >= 6, because using parse_requirements

1.0.0 (2014-01-05)

  • Change ouput of format to be JSON instead of key=val

0.0.2 (2014-10-21)

  • Fix imports to allow pip installation.

0.0.1 (2014-09-29)

  • Initial release.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release. See tutorial on generating distribution archives.

Built Distribution

kayvee-3.0.0-py3-none-any.whl (10.2 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page