OtterIO Logging Quickstart Guide

June 4, 2026 ยท View on GitHub

This document explains how to configure OtterIO server to log to different logging targets.

Log Targets

OtterIO supports currently two target types

  • console
  • http

Console Target

Console target is on always and cannot be disabled.

HTTP Target

HTTP target logs to a generic HTTP endpoint in JSON format and is not enabled by default. To enable HTTP target logging you would have to update your OtterIO server configuration using mc admin config set command.

Assuming mc is already configured

mc admin config get myotterio/ logger_webhook
logger_webhook:name1 auth_token="" endpoint=""

mc admin config set myotterio logger_webhook:name1 auth_token="" endpoint="http://endpoint:port/path"
mc admin service restart myotterio

NOTE: http://endpoint:port/path is a placeholder value to indicate the URL format, please change this accordingly as per your configuration.

OtterIO also honors environment variable for HTTP target logging as shown below, this setting will override the endpoint settings in the OtterIO server config.

export OTTERIO_LOGGER_WEBHOOK_ENABLE_target1="on"
export OTTERIO_LOGGER_WEBHOOK_AUTH_TOKEN_target1="token"
export OTTERIO_LOGGER_WEBHOOK_ENDPOINT_target1=http://localhost:8080/otterio/logs
otterio server /mnt/data

Audit Targets

Assuming mc is already configured

mc admin config get myotterio/ audit_webhook
audit_webhook:name1 enable=off endpoint= auth_token= client_cert= client_key=

mc admin config set myotterio audit_webhook:name1 auth_token="" endpoint="http://endpoint:port/path"
mc admin service restart myotterio

NOTE: http://endpoint:port/path is a placeholder value to indicate the URL format, please change this accordingly as per your configuration.

OtterIO also honors environment variable for HTTP target Audit logging as shown below, this setting will override the endpoint settings in the OtterIO server config.

export OTTERIO_AUDIT_WEBHOOK_ENABLE_target1="on"
export OTTERIO_AUDIT_WEBHOOK_AUTH_TOKEN_target1="token"
export OTTERIO_AUDIT_WEBHOOK_ENDPOINT_target1=http://localhost:8080/otterio/logs
export OTTERIO_AUDIT_WEBHOOK_CLIENT_CERT="/tmp/cert.pem"
export OTTERIO_AUDIT_WEBHOOK_CLIENT_KEY=="/tmp/key.pem"
otterio server /mnt/data

Setting this environment variable automatically enables audit logging to the HTTP target. The audit logging is in JSON format as described below.

NOTE:

  • timeToFirstByte and timeToResponse will be expressed in Nanoseconds.
  • Additionally in the case of the erasure coded setup tags.objectErasureMap provides per object details about
    • Pool number the object operation was performed on.
    • Set number the object operation was performed on.
    • The list of disks participating in this operation belong to the set.
{
  "version": "1",
  "deploymentid": "bc0e4d1e-bacc-42eb-91ad-2d7f3eacfa8d",
  "time": "2019-08-12T21:34:37.187817748Z",
  "api": {
    "name": "PutObject",
    "bucket": "testbucket",
    "object": "hosts",
    "status": "OK",
    "statusCode": 200,
    "timeToFirstByte": "366333ns",
    "timeToResponse": "16438202ns"
  },
  "remotehost": "127.0.0.1",
  "requestID": "15BA4A72C0C70AFC",
  "userAgent": "OtterIO (linux; amd64) otterio-go/v6.0.32 mc/2019-08-12T18:27:13Z",
  "requestHeader": {
    "Authorization": "AWS4-HMAC-SHA256 Credential=otterio/20190812/us-east-1/s3/aws4_request,SignedHeaders=host;x-amz-content-sha256;x-amz-date;x-amz-decoded-content-length,Signature=d3f02a6aeddeb29b06e1773b6a8422112890981269f2463a26f307b60423177c",
    "Content-Length": "686",
    "Content-Type": "application/octet-stream",
    "User-Agent": "OtterIO (linux; amd64) otterio-go/v6.0.32 mc/2019-08-12T18:27:13Z",
    "X-Amz-Content-Sha256": "STREAMING-AWS4-HMAC-SHA256-PAYLOAD",
    "X-Amz-Date": "20190812T213437Z",
    "X-Amz-Decoded-Content-Length": "512"
  },
  "responseHeader": {
    "Accept-Ranges": "bytes",
    "Content-Length": "0",
    "Content-Security-Policy": "block-all-mixed-content",
    "ETag": "a414c889dc276457bd7175f974332cb0-1",
    "Server": "OtterIO/DEVELOPMENT.2019-08-12T21-28-07Z",
    "Vary": "Origin",
    "X-Amz-Request-Id": "15BA4A72C0C70AFC",
    "X-Xss-Protection": "1; mode=block"
  },
  "tags": {
    "objectErasureMap": {
      "object": {
        "poolId": 1,
        "setId": 10,
        "disks": [
          "http://server01/mnt/pool1/disk01",
          "http://server02/mnt/pool1/disk02",
          "http://server03/mnt/pool1/disk03",
          "http://server04/mnt/pool1/disk04"
        ]
     }
  }
}

Explore Further