Audit Extension Configuration

Table of Contents

Introduction
Configuration
- Environment Variables
- YAML Example

Introduction

The audit service allows for easy monitoring of your Infinite Scale server.

Extensions are under development because of the

stage of Infinite Scale. Their service, environment variables and configuration may change. Forgive us if there are mistakes or information is missing. Feel free to report issues and we’ll take care of them as soon as possible on github. You want to fix them yourself? We’d appreciate that even more.

Configuration

Environment Variables

The audit extension is configured via the following environment variables:

Environment variables for the audit extension
Name	Type	Default Value	Description
`OCIS_LOG_LEVEL` `AUDIT_LOG_LEVEL`	string
`OCIS_LOG_PRETTY` `AUDIT_LOG_PRETTY`	bool	false
`OCIS_LOG_COLOR` `AUDIT_LOG_COLOR`	bool	false
`OCIS_LOG_FILE` `AUDIT_LOG_FILE`	string
`AUDIT_DEBUG_ADDR`	string
`AUDIT_DEBUG_TOKEN`	string
`AUDIT_DEBUG_PPROF`	bool	false
`AUDIT_DEBUG_ZPAGES`	bool	false
`AUDIT_EVENTS_ENDPOINT`	string	127.0.0.1:9233	The address of the streaming service.
`AUDIT_EVENTS_CLUSTER`	string	ocis-cluster	The clusterID of the streaming service. Mandatory when using nats.
`AUDIT_EVENTS_GROUP`	string	audit	The consumergroup of the service. One group will only get one copy of an event.
`AUDIT_LOG_TO_CONSOLE`	bool	true	Logs to Stdout if true.
`AUDIT_LOG_TO_FILE`	bool	false	Logs to file if true.
`AUDIT_FILEPATH`	string		Filepath to the logfile. Mandatory if LogToFile is true.
`AUDIT_FORMAT`	string	json	Log format. using json is advised.

Since Version: + added, - deprecated

YAML Example

# Autogenerated
# Filename: audit-config-example.yaml

log:
  level: ""
  pretty: false
  color: false
  file: ""
debug:
  addr: ""
  token: ""
  pprof: false
  zpages: false
events:
  endpoint: 127.0.0.1:9233
  cluster: ocis-cluster
  group: audit
auditlog:
  log_to_console: true
  log_to_file: false
  filepath: ""
  format: json