> For the complete documentation index, see [llms.txt](https://docs.bindplane.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.bindplane.com/integrations/sources/jboss.md).

# JBoss

The JBoss source collects logs from JBoss EAP / WildFly application servers by tailing the server log files written by the server's periodic file log handler.

### Supported Telemetry

| Platform | Metrics | Logs | Traces |
| -------- | ------- | ---- | ------ |
| Linux    |         | ✓    |        |
| Windows  |         | ✓    |        |
| macOS    |         | ✓    |        |

### Prerequisites

JBoss EAP / WildFly must be configured to write its log output to one or more files (by default the root logger uses a periodic file handler that writes to `server.log`). The Bindplane collector must run on a host that can read those log files directly, and the configured `File Path(s)` must match where the server writes them. The default path tailed by this source is `/usr/local/JBoss/EAP-*/*/log/server.log`; adjust it to match your installation.

For configuring logging and locating the log files on your server, see the official Red Hat documentation: [Logging with JBoss EAP](https://docs.redhat.com/en/documentation/red_hat_jboss_enterprise_application_platform/8.0/html/configuration_guide/logging-with-jboss-eap_default).

### Configuration

<figure><img src="/files/RWJlPefk1SJww0oRYOv9" alt="Bindplane docs - JBoss - image 1"><figcaption></figcaption></figure>

**Logs**

| Parameter    | Type    | Required | Default                                   | Description                  |
| ------------ | ------- | -------- | ----------------------------------------- | ---------------------------- |
| File Path(s) | Strings | No       | `/usr/local/JBoss/EAP-*/*/log/server.log` | File paths to tail for logs. |

**Advanced**

| Parameter | Type                   | Required | Default | Description                                   |
| --------- | ---------------------- | -------- | ------- | --------------------------------------------- |
| Timezone  | Timezone               | No       | `UTC`   | The timezone to use when parsing timestamps.  |
| Start At  | `Enum: beginning, end` | No       | `end`   | Start reading logs from 'beginning' or 'end'. |
| Parse     | Boolean                | No       | `true`  | Parses the log fields into structured data.   |

### Examples

#### Tail a non-default log path

This example tails a JBoss EAP standalone server's `server.log` from a custom install location and reads from the beginning of the file on first run.

```yaml
apiVersion: bindplane.observiq.com/v1
kind: Source
metadata:
  name: jboss
spec:
  type: jboss
  parameters:
    - name: file_path
      value:
        - /opt/jboss/standalone/log/server.log
    - name: start_at
      value: beginning
```

### Configuration Tips

* Set `Start At` to `beginning` when you want to backfill existing log content the first time the source runs; leave it at `end` to collect only new entries.
* Keep `Parse` enabled to extract structured fields from the standard JBoss log format. Disable it only if your server uses a custom log pattern that does not parse cleanly.
* Use the `Timezone` parameter to match the timezone the server writes timestamps in, so parsed timestamps are interpreted correctly.

### Troubleshooting

**Symptom:** No logs are collected. **Solution:** Confirm the `File Path(s)` glob matches the actual location of `server.log` on the host. The default path assumes an EAP install under `/usr/local/JBoss`; adjust it to your installation directory.

**Symptom:** The collector cannot read the log files. **Solution:** Ensure the collector process has read permission on the log directory and files. JBoss log files are often owned by the application server's service account, so the collector user may need to be added to that group.

**Symptom:** Timestamps appear shifted or log fields are not parsed. **Solution:** Set `Timezone` to match the server's timezone, and confirm `Parse` is enabled and the server uses the standard JBoss log pattern. A custom log format can prevent fields from parsing.

### Standalone Source

```yaml
apiVersion: bindplane.observiq.com/v1
kind: Source
metadata:
  name: jboss
spec:
  type: jboss
  parameters:
    - name: file_path
      value:
        - /usr/local/JBoss/EAP-*/*/log/server.log
    - name: start_at
      value: end
    - name: timezone
      value: UTC
    - name: parse
      value: true
```

### Related Resources

* [Logging with JBoss EAP (Red Hat documentation)](https://docs.redhat.com/en/documentation/red_hat_jboss_enterprise_application_platform/8.0/html/configuration_guide/logging-with-jboss-eap_default)
* [OpenTelemetry filelog receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/filelogreceiver)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.bindplane.com/integrations/sources/jboss.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.