External API logging

When a Chenile service talks to (or is called by) a third party, you usually want a durable record of what crossed the boundary. External API logging captures those requests and responses and publishes them — without you writing logging code at each call site.

The two directions

Enable it

Turn it on in chenile.properties (or the application config), choosing a publisher and topics:

chenile.external-api.logging.enabled=true
chenile.external-api.logging.publisher=pubsub
chenile.external-api.logging.inbound-topic=external.api.inbound
chenile.external-api.logging.outbound-topic=external.api.outbound
chenile.external-api.logging.max-payload-bytes=65536
chenile.external-api.logging.masked-headers=Authorization,x-Authorization

• publisher=none — core installs a NoopExternalApiPublisher that simply logs that publishing was skipped.
• publisher=pubsub — with chenile-pub-sub on the classpath, a PubSubExternalApiPublisher sends the serialized LogRecord to the inbound/outbound topic over your normal messaging transport.
• max-payload-bytes caps how much body is captured; masked-headers redacts sensitive headers (e.g. Authorization) from the record.

Mark the boundary

Annotate a controller (or a specific operation) that a third party calls:

@RestController
@ChenileController(value = "partnerService", serviceName = "_partnerService_")
@ExternalApi                       // every operation here is external-facing
public class PartnerController extends ControllerSupport { … }

For outbound calls, route them through ChenileExternalClient so the request and response are captured the same way.