services.x-logging.FireLens ¶
- services:
-
- service:
-
- logging:
-
driver: str options: {}
- x-logging:
-
FireLens: {}
- x-logging:
-
- FireLens:
-
- ShortHands:
-
ReplaceAwsLogs: bool
- Advanced:
-
SourceFile: str ParserFiles: [] EnableApiHeathCheck: bool GracePeriod: int ComposeXManagedAwsDestinations: {} # ComposeXManagedAwsDestinations EnvironmentVariables: {}
Hint
FireLens configurations being numerous, we recommend to look at the examples / test-cases that are published on GitHub
Advanced ¶
SourceFile ¶
Allow you to add a custom source file that will be included to the main configuration part of fluent bit
For example, with the following, we ensure to add the pre-build parsers already in the docker image, and transform the NGINX logs
[SERVICE]
Parsers_File /fluent-bit/parsers/parsers.conf
[FILTER]
Name modify
Match web-firelens*
Rename ecs_task_arn task_id
[FILTER]
Name parser
Match web-firelens*
Parser nginx
Key_Name log
Reserve_Data True
Warning
Do not use that source file to add [PARSER] definitions. Instead, use ParserFiles
ParserFiles ¶
This allows you to define additional [PARSER] that you have configured into separate files, or use the ones already in the docker image for Fluent Bit.
For example, the following
ParserFiles:
- parser.conf
- parsers/java.conf
will result into
[SERVICE]
Parsers_File /compose_x_rendered/parser.conf
Parsers_File parsers/java.conf
In this example, the file
parser.conf
exists, and we import the file that the
log_router_config
sidecar will
write to disk for fluentbit to use.
However, java.conf does not exist. So we allow it in the configuration, but if the path is incorrect, it might fail.
ComposeXManagedAwsDestinations ¶
List of pre-defined / managed services by Compose-X that can be used as destination configuration.
At this time, the two supported are
-
FireLensCloudWatchManagedDestination
FireLensFirehoseManagedDestination ¶
This section allows to define multiple FireHose definitions if you wish to ship logs to multiple FireHose destinations, or simply to deliver the logs to FireHose in addition to delivering to another plugin, i.e. CloudWatch