Skip to main content

Balanced event logging schema and library

Project description

balog

Balanced event logging schema and library

Log schema design goals

  • Schema version annotated

  • Provide sufficient information about the event

  • Open and close (be flexible, avoid unnecessary change to schema)

Design rationals

OSI Network Model Structure

Data in the log can be divided into two major groups, one is the meta data, which is the data about the event. The another group is the log for application itself. In most cases, applications should only be interested in the application log itself. And the logging facility should only be interested in how to handle the whole event rather than to consume the content of application log. Also, since schema of application can variant, we don’t want change the whole schema everytime when application log is change. Consider these issues, one idea come to my mind is Internet OSI model is actually dealing with the same issue. It’s like TCP/IP protocol doesn’t need to know the content of application layer. Similarly, logging facility doesn’t have to know the content of application log. With this idea in mind, I define two layers for our logging system.

  • Facility layer

  • Application layer

Facility layer is all about the event, when it is generated, who emited this event, what’s its routing tag and etc. Application layer is all about application data, like a dispute is processed, a debit is created and etc.

Facility layer

Payload

TODO

Open content

TODO

Project details


Download files

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

Source Distribution

balog-0.0.3.tar.gz (9.3 kB view details)

Uploaded Source

File details

Details for the file balog-0.0.3.tar.gz.

File metadata

  • Download URL: balog-0.0.3.tar.gz
  • Upload date:
  • Size: 9.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for balog-0.0.3.tar.gz
Algorithm Hash digest
SHA256 ac55e0cc193c4ff175cca95f57b8c0adf3404fcf6af5d4c0064e95e4390ca5eb
MD5 1005947c0754fc0040315a2095aabdfd
BLAKE2b-256 26078639aa9db7a051224dbebc1aaf350a1e9b6582e3883a0dbf18d5d0cb4f7a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page