search

palantir / witchcraft-rust-server

A highly opinionated Rust embedded application server for RESTy APIs
Apache License 2.0
4 stars 7 forks source link

Support emitting event logs #186

Closed kunalrkak closed 5 months ago

kunalrkak commented 5 months ago

Before this PR

There's no supported way to emit event logs.

After this PR

==COMMIT_MSG== Adds global functions to the logging module to allow writing event logs manually. ==COMMIT_MSG==

Possible downsides?

changelog-app[bot] commented 5 months ago

Generate changelog in changelog-dir>`changelog/@unreleased`</changelog-dir

What do the change types mean? - `feature`: A new feature of the service. - `improvement`: An incremental improvement in the functionality or operation of the service. - `fix`: Remedies the incorrect behaviour of a component of the service in a backwards-compatible way. - `break`: Has the potential to break consumers of this service's API, inclusive of both Palantir services and external consumers of the service's API (e.g. customer-written software or integrations). - `deprecation`: Advertises the intention to remove service functionality without any change to the operation of the service itself. - `manualTask`: Requires the possibility of manual intervention (running a script, eyeballing configuration, performing database surgery, ...) at the time of upgrade for it to succeed. - `migration`: A fully automatic upgrade migration task with no engineer input required. _Note: only one type should be chosen._
How are new versions calculated? - ❗The `break` and `manual task` changelog types will result in a major release! - 🐛 The `fix` changelog type will result in a minor release in most cases, and a patch release version for patch branches. This behaviour is configurable in autorelease. - ✨ All others will result in a minor version release.

Type

- [x] Feature - [ ] Improvement - [ ] Fix - [ ] Break - [ ] Deprecation - [ ] Manual task - [ ] Migration

Description

Adds global functions to the logging module to allow writing event logs manually. **Check the box to generate changelog(s)** - [x] Generate changelog entry
kunalrkak commented 5 months ago

Updated based on comments, seems much simpler now!

sfackler commented 5 months ago

Looks good to me. The build should fix itself if you merge/rebase with develop.