# kubernetes() source options

The `kubernetes()` source has the following options:

## base-dir()

|   
---|---  
Type: | path without filename  
Default: | `/var/log/containers`  
  
_Description:_ The path to the directory that contains the log files, for example, `base-dir("/var/log/pods")`.

## cluster-name()

|   
---|---  
Type: | string  
Default: | `k8s`  
  
_Description:_ The name of the Kubernetes cluster.

## key-delimiter()

|   
---|---  
Type: | character  
Default: | `.`  
  
_Description:_ The delimiter character to use when parsing flattened keys. Supports Only single characters.

## prefix()

|   
---|---  
Synopsis: | prefix()  
  
_Description:_ Insert a prefix before the name part of the parsed name-value pairs to help further processing. For example:

  * To insert the `my-parsed-data.` prefix, use the `prefix(my-parsed-data.)` option.
  * To refer to a particular data that has a prefix, use the prefix in the name of the macro, for example, `${my-parsed-data.name}`.
  * If you forward the parsed messages using the IETF-syslog protocol, you can insert all the parsed data into the SDATA part of the message using the `prefix(.SDATA.my-parsed-data.)` option.



Names starting with a dot (for example, `.example`) are reserved for use by AxoSyslog. If you use such a macro name as the name of a parsed value, it will attempt to replace the original value of the macro (note that only soft macros can be overwritten, see [Hard versus soft macros](../../../docs/axosyslog-core/chapter-manipulating-messages/customizing-message-format/macros-hard-vs-soft/index.md) for details). To avoid such problems, use a prefix when naming the parsed values, for example, `prefix(my-parsed-data.)`

The `prefix()` option is optional and its default value is `".k8s."`.

Last modified September 1, 2023: [[kubernetes] Minor updates and docs for the key-delimiter option (30c5dda)](<https://github.com/axoflow/axosyslog-core-docs/commit/30c5ddacf4861356f6e8cc6940858289ff6cd22e>)