Skip to main content

Base Context

You can specify items to add to every Klogging log event in your application. Examples might be application name or a build identifier.

Using the Context object​

You can specify base context items using the Context object, for example:

const val APP_NAME_KEY = "appName"
const val APP_NAME = "analysis-service"
const val BUILD_NUMBER_KEY = "buildNumber"
const val BUILD_NUMBER_ENV = "BUILD_NUMBER"

Context.addBaseContext(
    APP_NAME_KEY to APP_NAME,
    BUILD_NUMBER_KEY to System.getenv(BUILD_NUMBER_ENV),
)

Log events include those values, for example:

{
  "@t": "2022-06-16T08:52:12.064882Z",
  "@l": "INFO",
  "@mt": "Execution time {elapsedMs} ms",
  "host": "09b4396db8ae",
  "appName": "analysis-service",
  "buildNumber": "2.4.0-d22d0dd",
  "logger": "com.wodgeworks.analysis.RunTimer",
  "elapsedMs": 73,
  "run": "a6f72c37-7e2f-4d69-a73f-7f493cb04d1d",
  "context": "DefaultDispatcher-worker-3"
}

From file-based configuration​

You can specify base context items in JSON or HOCON configuration files, for example:

{
  "baseContext": {
    "appName": "analysis-service",
    "buildNumber": "${BUILD_NUMBER}"
  }
}

that reads the value of BUILD_NUMBER from the runtime environment.