github.com/observiq/bindplane-agent@v1.51.0/docs/plugins/tomcat_logs.md (about)

     1  # Apache Tomcat Plugin
     2  
     3  Log parser for Apache Tomcat
     4  
     5  ## Configuration Parameters
     6  
     7  | Name | Description | Type | Default | Required | Values |
     8  |:-- |:-- |:-- |:-- |:-- |:-- |
     9  | enable_access_log | Enable to collect Apache Tomcat access logs | bool | `true` | false |  |
    10  | access_log_path | Path to access log file | []string | `[/usr/local/tomcat/logs/localhost_access_log.*.txt]` | false |  |
    11  | access_retain_raw_logs | When enabled will preserve the original log message in a `raw_log` key. This will either be in the `body` or `attributes` depending on how `parse_to` is configured. | bool | `false` | false |  |
    12  | enable_catalina_log | Enable to collect Apache Tomcat catalina logs | bool | `true` | false |  |
    13  | catalina_log_path | Path to catalina log file | []string | `[/usr/local/tomcat/logs/catalina.out]` | false |  |
    14  | catalina_retain_raw_logs | When enabled will preserve the original log message on the body in a `raw_log` key | bool | `false` | false |  |
    15  | start_at | At startup, where to start reading logs from the file (`beginning` or `end`) | string | `end` | false | `beginning`, `end` |
    16  | timezone | Timezone to use when parsing the timestamp. | timezone | `UTC` | false |  |
    17  | parse_to | Where to parse structured log parts | string | `body` | false | `body`, `attributes` |
    18  | offset_storage_dir | The directory that the offset storage file will be created | string | `$OIQ_OTEL_COLLECTOR_HOME/storage` | false |  |
    19  
    20  ## Example Config:
    21  
    22  Below is an example of a basic config
    23  
    24  ```yaml
    25  receivers:
    26    plugin:
    27      path: ./plugins/tomcat_logs.yaml
    28      parameters:
    29        enable_access_log: true
    30        access_log_path: [/usr/local/tomcat/logs/localhost_access_log.*.txt]
    31        access_retain_raw_logs: false
    32        enable_catalina_log: true
    33        catalina_log_path: [/usr/local/tomcat/logs/catalina.out]
    34        catalina_retain_raw_logs: false
    35        start_at: end
    36        timezone: UTC
    37        parse_to: body
    38        offset_storage_dir: $OIQ_OTEL_COLLECTOR_HOME/storage
    39  ```