# Bitnami Secure Image for Logstash

> Logstash is an open source data processing engine. It ingests data from multiple sources, processes it, and sends the output to final destination in real-time. It is a core component of the ELK stack.

[Overview of Logstash](https://logstash.net)
Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.

## <a id="tl-dr"></a> TL;DR

```console
docker run --name logstash bitnami/logstash:latest
```

## <a id="why-use-bitnami-secure-images"></a> Why use Bitnami Secure Images?

Those are hardened, minimal CVE images built and maintained by Bitnami. Bitnami Secure Images are based on the cloud-optimized, security-hardened enterprise [OS Photon Linux](https://vmware.github.io/photon/). Why choose BSI images?

- Hardened secure images of popular open source software with Near-Zero Vulnerabilities
- Vulnerability Triage & Prioritization with VEX Statements, KEV and EPSS Scores
- Compliance focus with FIPS, STIG, and air-gap options, including secure bill of materials (SBOM)
- Software supply chain provenance attestation through in-toto
- First class support for the internet’s favorite Helm charts

Each image comes with valuable security metadata. You can view the metadata in [our public catalog here](https://app-catalog.vmware.com/bitnami/apps). Note: Some data is only available with [commercial subscriptions to BSI](https://bitnami.com/).

![Alt text](https://github.com/bitnami/containers/blob/main/BSI%20UI%201.png?raw=true "Application details")
![Alt text](https://github.com/bitnami/containers/blob/main/BSI%20UI%202.png?raw=true "Packaging report")

If you are looking for our previous generation of images based on Debian Linux, please see the [Bitnami Legacy registry](https://hub.docker.com/u/bitnamilegacy).

## <a id="how-to-deploy-logstash-in-kubernetes?"></a> How to deploy Logstash in Kubernetes?

Deploying Bitnami applications as Helm Charts is the easiest way to get started with our applications on Kubernetes. Read more about the installation in the [Bitnami Logstash Chart GitHub repository](https://github.com/bitnami/charts/tree/main/bitnami/logstash).

## <a id="why-non-root"></a> Why use a non-root container?

Non-root container images add an extra layer of security and are generally recommended for production environments. However, because they run as a non-root user, privileged tasks are typically off-limits. Learn more about non-root containers [in our docs](https://techdocs.broadcom.com/us/en/vmware-tanzu/application-catalog/tanzu-application-catalog/services/tac-doc/apps-tutorials-work-with-non-root-containers-index.html).

## <a id="supported-tags"></a> Supported tags and respective `Dockerfile` links

Learn more about the Bitnami tagging policy and the difference between rolling tags and immutable tags [in our documentation page](https://techdocs.broadcom.com/us/en/vmware-tanzu/application-catalog/tanzu-application-catalog/services/tac-doc/apps-tutorials-understand-rolling-tags-containers-index.html).

## <a id="get-this-image"></a> Get this image

The recommended way to get the Bitnami Logstash Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/logstash).

```console
docker pull bitnami/logstash:latest
```

To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/logstash/tags/) in the Docker Hub Registry.

```console
docker pull bitnami/logstash:[TAG]
```

If you wish, you can also build the image yourself by cloning the repository, changing to the directory containing the Dockerfile and executing the `docker build` command. Remember to replace the `APP`, `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.

```console
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
```

## <a id="using-`docker-compose.yaml`"></a> Using `docker-compose.yaml`

Please be aware this file has not undergone internal testing. Consequently, we advise its use exclusively for development or testing purposes. For production-ready deployments, we highly recommend utilizing its associated [Bitnami Helm chart](https://github.com/bitnami/charts/tree/main/bitnami/logstash).

## <a id="persisting-your-application"></a> Persisting your application

If you remove the container all your data will be lost, and the next time you run the image the database will be reinitialized. To avoid this loss of data, you should mount a volume that will persist even after the container is removed.

For persistence you should mount a directory at the `/bitnami` path. If the mounted directory is empty, it will be initialized on the first run.

> **NOTE** As this is a non-root container, the mounted files and directories must have the proper permissions for the UID `1001`.

## <a id="connecting-to-other-containers"></a> Connecting to other containers

Using [Docker container networking](https://docs.docker.com/engine/userguide/networking/), a different server running inside a container can easily be accessed by your application containers and vice-versa.

Containers attached to the same network can communicate with each other using the container name as the hostname.

### <a id="environment-variables"></a> Environment variables

The following tables list the main variables you can set.

#### Customizable environment variables

| Name                                     | Description                                             | Default Value   |
|------------------------------------------|---------------------------------------------------------|-----------------|
| `LOGSTASH_PIPELINE_CONF_FILENAME`        | Logstash pipeline file name                             | `logstash.conf` |
| `LOGSTASH_BIND_ADDRESS`                  | Logstash listen address                                 | `0.0.0.0`       |
| `LOGSTASH_EXPOSE_API`                    | Whether to expose the expose the Logstash API           | `no`            |
| `LOGSTASH_API_PORT_NUMBER`               | Logstash API port number                                | `9600`          |
| `LOGSTASH_PIPELINE_CONF_STRING`          | Logstash pipeline configuration in a string             | `nil`           |
| `LOGSTASH_PLUGINS`                       | List of Logstash plugins to install                     | `nil`           |
| `LOGSTASH_EXTRA_FLAGS`                   | Extra arguments for running the Logstash server         | `nil`           |
| `LOGSTASH_HEAP_SIZE`                     | Logstash heap size                                      | `1024m`         |
| `LOGSTASH_MAX_ALLOWED_MEMORY_PERCENTAGE` | Logstash maximum allowed memory percentage              | `100`           |
| `LOGSTASH_MAX_ALLOWED_MEMORY`            | Logstash maximum allowed memory amount (in megabytes)   | `nil`           |
| `LOGSTASH_ENABLE_MULTIPLE_PIPELINES`     | Whether to enable multiple pipelines support            | `no`            |
| `LOGSTASH_ENABLE_BEATS_INPUT`            | Whether to listen for incoming Beats connections        | `no`            |
| `LOGSTASH_BEATS_PORT_NUMBER`             | Port number for listening to incoming Beats connections | `5044`          |
| `LOGSTASH_ENABLE_GELF_INPUT`             | Whether to listen for incoming Gelf connections         | `no`            |
| `LOGSTASH_GELF_PORT_NUMBER`              | Port number for listening to incoming Beats connections | `12201`         |
| `LOGSTASH_ENABLE_HTTP_INPUT`             | Whether to listen for incoming HTTP connections         | `yes`           |
| `LOGSTASH_HTTP_PORT_NUMBER`              | Port number for listening to incoming Beats connections | `8080`          |
| `LOGSTASH_ENABLE_TCP_INPUT`              | Whether to listen for incoming TDP connections          | `no`            |
| `LOGSTASH_TCP_PORT_NUMBER`               | Port number for listening to incoming TCP connections   | `5010`          |
| `LOGSTASH_ENABLE_UDP_INPUT`              | Whether to listen for incoming UDP connections          | `no`            |
| `LOGSTASH_UDP_PORT_NUMBER`               | Port number for listening to incoming UDP connections   | `5000`          |
| `LOGSTASH_ENABLE_STDOUT_OUTPUT`          | Whether to output to an Elasticsearch server            | `yes`           |
| `LOGSTASH_ENABLE_ELASTICSEARCH_OUTPUT`   | Whether to output to an Elasticsearch server            | `no`            |
| `LOGSTASH_ELASTICSEARCH_HOST`            | Elasticsearch server hostname                           | `elasticsearch` |
| `LOGSTASH_ELASTICSEARCH_PORT_NUMBER`     | Elasticsearch server port                               | `9200`          |
| `LS_JAVA_HOME`                           | Logstash supported Java installation folder.            | `${JAVA_HOME}`  |

#### Read-only environment variables

| Name                                 | Description                                                            | Value                                                              |
|--------------------------------------|------------------------------------------------------------------------|--------------------------------------------------------------------|
| `LOGSTASH_BASE_DIR`                  | Logstash installation directory                                        | `/opt/bitnami/logstash`                                            |
| `LOGSTASH_CONF_DIR`                  | Logstash settings files directory                                      | `${LOGSTASH_BASE_DIR}/config`                                      |
| `LOGSTASH_DEFAULT_CONF_DIR`          | Logstash default settings files directory                              | `${LOGSTASH_BASE_DIR}/config.default`                              |
| `LOGSTASH_PIPELINE_CONF_DIR`         | Logstash pipeline configuration files directory                        | `${LOGSTASH_BASE_DIR}/pipeline`                                    |
| `LOGSTASH_DEFAULT_PIPELINE_CONF_DIR` | Logstash default pipeline configuration files directory                | `${LOGSTASH_BASE_DIR}/pipeline.default`                            |
| `LOGSTASH_BIN_DIR`                   | Logstash executables directory                                         | `${LOGSTASH_BASE_DIR}/bin`                                         |
| `LOGSTASH_CONF_FILE`                 | Path to Logstash settings file                                         | `${LOGSTASH_CONF_DIR}/logstash.yml`                                |
| `LOGSTASH_PIPELINE_CONF_FILE`        | Path to Logstash pipeline configuration file                           | `${LOGSTASH_PIPELINE_CONF_DIR}/${LOGSTASH_PIPELINE_CONF_FILENAME}` |
| `LOGSTASH_VOLUME_DIR`                | Persistence base directory                                             | `/bitnami/logstash`                                                |
| `LOGSTASH_DATA_DIR`                  | Logstash data directory                                                | `${LOGSTASH_VOLUME_DIR}/data`                                      |
| `LOGSTASH_MOUNTED_CONF_DIR`          | Directory where Logstash settings files will be mounted.               | `${LOGSTASH_VOLUME_DIR}/config`                                    |
| `LOGSTASH_MOUNTED_PIPELINE_CONF_DIR` | Directory where Logstash pipeline configuration files will be mounted. | `${LOGSTASH_VOLUME_DIR}/pipeline`                                  |
| `LOGSTASH_DAEMON_USER`               | Logstash system user                                                   | `logstash`                                                         |
| `LOGSTASH_DAEMON_GROUP`              | Logstash system group                                                  | `logstash`                                                         |
| `JAVA_HOME`                          | Java installation folder.                                              | `${BITNAMI_ROOT_DIR}/java`                                         |
| `LS_JAVA_OPTS`                       | Logstash supported Java options.                                       | `${LS_JAVA_OPTS:-} ${JAVA_TOOL_OPTIONS:-}`                         |

### <a id="using-a-configuration-string"></a> Using a configuration string

For simple configurations, you specify it using the `LOGSTASH_CONF_STRING` environment variable:

```console
docker run --env LOGSTASH_CONF_STRING="input {file {path => \"/tmp/logstash_input\"}} output {file {path => \"/tmp/logstash_output\"}}" bitnami/logstash:latest
```

### <a id="using-a-configuration-file"></a> Using a configuration file

You can override the default configuration for Logstash by mounting your own configuration files on directory `/bitnami/logstash/pipeline`. You will need to indicate the file holding the pipeline definition by setting the `LOGSTASH_PIPELINE_CONF_FILENAME` environment variable.

```console
docker run -d --env LOGSTASH_PIPELINE_CONF_FILENAME=my_config.conf -v /path/to/custom-conf-directory:/bitnami/logstash/pipeline bitnami/logstash:latest
```

### <a id="additional-command-line-options"></a> Additional command line options

In case you want to add extra flags to the Logstash command, use the `LOGSTASH_EXTRA_FLAGS` variable. Example:

```console
docker run -d --env LOGSTASH_EXTRA_FLAGS="-w 4 -b 4096" bitnami/logstash:latest
```

### <a id="using-multiple-pipelines"></a> Using multiple pipelines

You can use [multiple pipelines](https://www.elastic.co/guide/en/logstash/master/multiple-pipelines.html) by setting the `LOGSTASH_ENABLE_MULTIPLE_PIPELINES` environment variable to `true`.

In that case, you should place your `pipelines.yml` file in the mounted volume (together with the rest of the desired configuration files). If the `LOGSTASH_ENABLE_MULTIPLE_PIPELINES` environment variable is set to `true` but there is not any `pipelines.yml` file in the mounted volume, a dummy file is created using `LOGSTASH_PIPELINE_CONF_FILENAME` as a single pipeline.

```console
docker run -d --env LOGSTASH_ENABLE_MULTIPLE_PIPELINES=true -v /path/to/custom-conf-directory:/bitnami/logstash/config bitnami/logstash:latest
```

### <a id="exposing-api"></a> Exposing Logstash API

You can expose the Logstash API by setting the environment variable `LOGSTASH_EXPOSE_API`, you can also change the default port by using `LOGSTASH_API_PORT_NUMBER`.

```console
docker run -d --env LOGSTASH_EXPOSE_API=yes --env LOGSTASH_API_PORT_NUMBER=9090 -p 9090:9090 bitnami/logstash:latest
```

### <a id="plugins"></a> Plugins

You can add extra plugins by setting the `LOGSTASH_PLUGINS` environment variable. To specify multiple plugins, separate them by spaces, commas or semicolons. When the container is initialized it will install all of the specified plugins before starting Logstash.

```console
docker run -d --name logstash \
    -e LOGSTASH_PLUGINS=logstash-input-github \
    bitnami/logstash:latest
```

#### Adding plugins at build time (persisting plugins)

The Bitnami Logstash image provides a way to create your custom image installing plugins on build time. This is the preferred way to persist plugins when using Logstash, as they will not be installed every time the container is started but just once at build time.

To create your own image providing plugins execute the following command. Remember to replace the `VERSION` and `OPERATING-SYSTEM` path placeholders in the example command below with the correct values.

```console
git clone https://github.com/bitnami/containers.git
cd bitnami/logstash/VERSION/OPERATING-SYSTEM
docker build --build-arg LOGSTASH_PLUGINS=<plugin1,plugin2,...> -t bitnami/logstash:latest .
```

The command above will build the image providing this GitHub repository as build context, and will pass the list of plugins to install to the build logic.

### <a id="fips-configuration"></a> FIPS configuration in Bitnami Secure Images

The Bitnami Logstash Docker image from the [Bitnami Secure Images](https://go-vmware.broadcom.com/contact-us) catalog includes extra features and settings to configure the container with FIPS capabilities. You can configure the next environment variables:

- `OPENSSL_FIPS`: whether OpenSSL runs in FIPS mode or not. `yes` (default), `no`.

## <a id="logging"></a> Logging

The Bitnami Logstash Docker image sends the container logs to `stdout`. To view the logs:

```console
docker logs logstash
```

You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver.

Additionally, in case you'd like to modify Logstash logging configuration, it can be done by overwriting the file `/opt/bitnami/logstash/config/log4j2.properties`.
The syntax of this file can be found in Logstash [logging documentation](https://www.elastic.co/guide/en/logstash/current/logging.html).

## <a id="notable-changes"></a> Notable Changes

### 7.15.2-debian-10-r12

- Pipeline configuration files (i.e. `default_config.conf`) are being added into the `/opt/bitnami/logstash/pipeline` directory, instead of `/opt/bitnami/logstash/config`. Subsequently, `LOGSTASH_CONF_FILENAME` was renamed to `LOGSTASH_PIPELINE_CONF_FILENAME`, and `LOGSTASH_CONF_STRING` was renamed to `LOGSTASH_PIPELINE_CONF_STRING`.

## <a id="license"></a> License

Copyright &copy; 2026 Broadcom. The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

<http://www.apache.org/licenses/LICENSE-2.0>

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
