How to define a hanler for writing events into a text format

Ziti Overlay
1

Is there a handler supporting simple text format ?

https://openziti.io/docs/reference/configuration/controller/#events

Apr 30 15:08:29  ziti[26734]: {"file":"github.com/openziti/ziti/controller/events/dispatcher.go:217","func":"github.com/openziti/ziti/controller/events.(*Dispatcher).WireEventHandlers","level":"error","msg":"Unable to create event handler: invalid 'format' for event log output file: plain","time":"2025-04-30T15:08:29.351Z"}
Apr 30 15:08:29  ziti[26734]: panic: invalid 'format' for event log output file: plain
2

You could use the stdoutLogger handler to include events in the stdout and use the "text" format.

events:
  stdoutLogger:
    subscriptions:
      - type: entityChange
        include:
          - configTypes
          - services
          - authenticators
          - configs
          - revocations
          - serviceEdgeRouterPolicies
          - eventualEvents
          - cas
          - routers
          - postureChecks
          - apiSessions
          - apiSessionCertificates
          - postureCheckTypes
          - routers
          - externalJwtSigners
          - servicePolicies
          - terminators
          - authPolicies
          - edgeRouterPolicies
          - identityTypes
          - sessions
          - routers
          - mfas
          - services
          - controllers
          - identities
          - enrollments
    handler:
      type: stdout
      format: json

ziti controller run config.yml --log-formatter=text

If you're using the Linux service, edit the service unit to add the argument.

systemctl edit ziti-controller.service

### Editing /etc/systemd/system/ziti-controller.service.d/override.conf
### Anything between here and the comment below will become the new contents of the file

[Service]

ExecStart=
ExecStart=/opt/openziti/bin/ziti controller run config.yml --log-formatter=text --verbose

### Lines below this comment will be discarded
3

The plain format was removed a while back. I added an issue to update the doc: Remove reference to 'plain' event format · Issue #1123 · openziti/ziti-doc · GitHub

One option might be to pipe the json through jq to get something simpler and more human readable.

4

Exactly. We are not fluent in json.