witchcraft-go-server icon indicating copy to clipboard operation
witchcraft-go-server copied to clipboard

Add support for audit.v3 logs

Open nmiyake opened this issue 7 months ago • 3 comments

Before this PR

After this PR

==COMMIT_MSG== Adds support for audit.3 logs.

Specifically, ensures that an audit3.Logger is set on all server contexts and that there is a middleware that properly populates required fields. Also defines an AuditConfig struct and adds it as an optional field to the base Runtime configuration. ==COMMIT_MSG==

Possible downsides?

nmiyake avatar Apr 30 '25 21:04 nmiyake

Generate changelog in changelog/@unreleased

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

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

Description Adds support for audit.3 logs.

Specifically, ensures that an audit3.Logger is set on all server contexts and that there is a middleware that properly populates required fields. Also defines an AuditConfig struct and adds it as an optional field to the base Runtime configuration.

Check the box to generate changelog(s)

  • [x] Generate changelog entry

changelog-app[bot] avatar Apr 30 '25 21:04 changelog-app[bot]

Requires https://github.com/palantir/witchcraft-go-logging/pull/400

nmiyake avatar Apr 30 '25 21:04 nmiyake

@bmoylan @IlanaRadinsky ready for review -- per the Slack conversation, I believe the plan is to move forward with keeping the Audit Configuration the same as Java for compatibility/consistency.

nmiyake avatar May 22 '25 16:05 nmiyake

Released v2.96.0

autorelease3[bot] avatar May 27 '25 16:05 autorelease3[bot]