207 lines
9.2 KiB
Markdown
207 lines
9.2 KiB
Markdown
# Fluentd Exporter packaged by Bitnami
|
|
|
|
## Container Deprecation Notice
|
|
|
|
Fluentd Exporter container is no longer maintained by upstream and is now internally tagged as to be deprecated. This image will no longer be released in our catalog a month after this notice is published, but already released container images will still persist in the registries. Valid to be removed starting on: 06-12-2022
|
|
|
|
## What is Fluentd Exporter?
|
|
|
|
> Simple server that scrapes fluentd metrics endpoint and exports them as Prometheus metrics.
|
|
|
|
[Overview of Fluentd Exporter](https://github.com/V3ckt0r/fluentd-exporter)
|
|
|
|
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.
|
|
|
|
## TL;DR
|
|
|
|
```console
|
|
$ docker run --name fluentd-exporter bitnami/fluentd-exporter:latest
|
|
```
|
|
|
|
## Why use Bitnami Images?
|
|
|
|
* Bitnami closely tracks upstream source changes and promptly publishes new versions of this image using our automated systems.
|
|
* With Bitnami images the latest bug fixes and features are available as soon as possible.
|
|
* Bitnami containers, virtual machines and cloud images use the same components and configuration approach - making it easy to switch between formats based on your project needs.
|
|
* All our images are based on [minideb](https://github.com/bitnami/minideb) a minimalist Debian based container image which gives you a small base container image and the familiarity of a leading Linux distribution.
|
|
* All Bitnami images available in Docker Hub are signed with [Docker Content Trust (DCT)](https://docs.docker.com/engine/security/trust/content_trust/). You can use `DOCKER_CONTENT_TRUST=1` to verify the integrity of the images.
|
|
* Bitnami container images are released daily with the latest distribution packages available.
|
|
|
|
## 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://docs.bitnami.com/tutorials/work-with-non-root-containers/).
|
|
|
|
## 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://docs.bitnami.com/tutorials/understand-rolling-tags-containers/).
|
|
|
|
|
|
* [`0`, `0-debian-10`, `0.2.0`, `0.2.0-debian-10-r796`, `latest` (0/debian-10/Dockerfile)](https://github.com/bitnami/bitnami-docker-fluentd-exporter/blob/0.2.0-debian-10-r796/0/debian-10/Dockerfile)
|
|
|
|
Subscribe to project updates by watching the [bitnami/fluentd-exporter GitHub repo](https://github.com/bitnami/bitnami-docker-fluentd-exporter).
|
|
|
|
## Get this image
|
|
|
|
The recommended way to get the Bitnami Fluentd Exporter Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/fluentd-exporter).
|
|
|
|
```console
|
|
$ docker pull bitnami/fluentd-exporter: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/fluentd-exporter/tags/) in the Docker Hub Registry.
|
|
|
|
```console
|
|
$ docker pull bitnami/fluentd-exporter:[TAG]
|
|
```
|
|
|
|
If you wish, you can also build the image yourself.
|
|
|
|
```console
|
|
$ docker build -t bitnami/fluentd-exporter:latest 'https://github.com/bitnami/bitnami-docker-fluentd-exporter.git#master:0/debian-10'
|
|
```
|
|
|
|
## 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.
|
|
|
|
### Using the Command Line
|
|
|
|
#### Step 1: Create a network
|
|
|
|
```console
|
|
$ docker network create fluentd-exporter-network --driver bridge
|
|
```
|
|
|
|
#### Step 2: Launch the Fluentd Exporter container within your network
|
|
|
|
Use the `--network <NETWORK>` argument to the `docker run` command to attach the container to the `fluentd-exporter-network` network.
|
|
|
|
```console
|
|
$ docker run --name fluentd-exporter-node1 --network fluentd-exporter-network bitnami/fluentd-exporter:latest
|
|
```
|
|
|
|
#### Step 3: Run another containers
|
|
|
|
We can launch another containers using the same flag (`--network NETWORK`) in the `docker run` command. If you also set a name to your container, you will be able to use it as hostname in your network.
|
|
|
|
## Configuration
|
|
|
|
Fluentd exporter uses the fluentd monitoring agent api. [Fluentd official documentation](https://docs.fluentd.org/v1.0/articles/monitoring) details adding this source to the fluentd configuration file:
|
|
```yaml
|
|
<source>
|
|
@type monitor_agent
|
|
bind 0.0.0.0
|
|
port 24220
|
|
</source>
|
|
```
|
|
The metrics can then be accessed at: `curl http://host:24220/api/plugins.json`
|
|
|
|
### Flags/Arguments
|
|
```console
|
|
-telemetry.endpoint string
|
|
Path under which to expose metric. (default "/metrics")
|
|
-insecure
|
|
Ignore server certificate if using https, Default: false.
|
|
-log.format value
|
|
Set the log target and format. Example: "logger:syslog?appname=bob&local=7" or "logger:stdout?json=true" (default "logger:stderr")
|
|
-log.level value
|
|
Only log messages with the given severity or above. Valid levels: [debug, info, warn, error, fatal] (default "info")
|
|
-scrape_uri string
|
|
URI to fluentd metrics (default "http://localhost:24220/api/plugins.json")
|
|
-telemetry.address string
|
|
Address on which to expose metrics. (default ":9309")
|
|
-version
|
|
Print version information.
|
|
```
|
|
|
|
## Logging
|
|
|
|
The Bitnami fluentd-exporter Docker image sends the container logs to the `stdout`. To view the logs:
|
|
|
|
```console
|
|
$ docker logs fluentd-exporter
|
|
```
|
|
|
|
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.
|
|
|
|
## Maintenance
|
|
|
|
### Upgrade this image
|
|
|
|
Bitnami provides up-to-date versions of fluentd-exporter, including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container.
|
|
|
|
#### Step 1: Get the updated image
|
|
|
|
```console
|
|
$ docker pull bitnami/fluentd-exporter:latest
|
|
```
|
|
|
|
#### Step 2: Stop and backup the currently running container
|
|
|
|
Stop the currently running container using the command
|
|
|
|
```console
|
|
$ docker stop fluentd-exporter
|
|
```
|
|
|
|
Next, take a snapshot of the persistent volume `/path/to/fluentd-exporter-persistence` using:
|
|
|
|
```console
|
|
$ rsync -a /path/to/fluentd-exporter-persistence /path/to/fluentd-exporter-persistence.bkp.$(date +%Y%m%d-%H.%M.%S)
|
|
```
|
|
|
|
You can use this snapshot to restore the database state should the upgrade fail.
|
|
|
|
#### Step 3: Remove the currently running container
|
|
|
|
```console
|
|
$ docker rm -v fluentd-exporter
|
|
```
|
|
|
|
#### Step 4: Run the new image
|
|
|
|
Re-create your container from the new image, [restoring your backup](#restoring-a-backup) if necessary.
|
|
|
|
```console
|
|
$ docker run --name fluentd-exporter bitnami/fluentd-exporter:latest
|
|
```
|
|
|
|
## Contributing
|
|
|
|
We'd love for you to contribute to this container. You can request new features by creating an [issue](https://github.com/bitnami/bitnami-docker-fluentd-exporter/issues), or submit a [pull request](https://github.com/bitnami/bitnami-docker-fluentd-exporter/pulls) with your contribution.
|
|
|
|
## Issues
|
|
|
|
If you encountered a problem running this container, you can file an [issue](https://github.com/bitnami/bitnami-docker-fluentd-exporter/issues/new). Be sure to include the following information in your issue:
|
|
|
|
- Host OS and version
|
|
- Docker version (`docker version`)
|
|
- Output of `docker info`
|
|
- Version of this container
|
|
- The command you used to run the container, and any relevant output you saw (masking any sensitive information)
|
|
|
|
### Community supported solution
|
|
|
|
Please, note this asset is a community-supported solution. This means that the Bitnami team is not actively working on new features/improvements nor providing support through GitHub Issues. Any new issue will stay open for 20 days to allow the community to contribute, after 15 days without activity the issue will be marked as stale being closed after 5 days.
|
|
|
|
The Bitnami team will review any PR that is created, feel free to create a PR if you find any issue or want to implement a new feature.
|
|
|
|
New versions and releases cadence are not going to be affected. Once a new version is released in the upstream project, the Bitnami container image will be updated to use the latest version, supporting the different branches supported by the upstream project as usual.
|
|
|
|
## License
|
|
Copyright © 2022 Bitnami
|
|
|
|
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.
|