UNPKG

2.09 kBTypeScriptView Raw
1import { Duration } from '@aws-cdk/core';
2import { ContainerDefinition } from '../container-definition';
3import { BaseLogDriverProps } from './base-log-driver';
4import { LogDriver, LogDriverConfig } from './log-driver';
5import { Construct as CoreConstruct } from '@aws-cdk/core';
6/**
7 * Specifies the fluentd log driver configuration options.
8 *
9 * [Source](https://docs.docker.com/config/containers/logging/fluentd/)
10 */
11export interface FluentdLogDriverProps extends BaseLogDriverProps {
12 /**
13 * By default, the logging driver connects to localhost:24224. Supply the
14 * address option to connect to a different address. tcp(default) and unix
15 * sockets are supported.
16 *
17 * @default - address not set.
18 */
19 readonly address?: string;
20 /**
21 * Docker connects to Fluentd in the background. Messages are buffered until
22 * the connection is established.
23 *
24 * @default - false
25 */
26 readonly asyncConnect?: boolean;
27 /**
28 * The amount of data to buffer before flushing to disk.
29 *
30 * @default - The amount of RAM available to the container.
31 */
32 readonly bufferLimit?: number;
33 /**
34 * How long to wait between retries.
35 *
36 * @default - 1 second
37 */
38 readonly retryWait?: Duration;
39 /**
40 * The maximum number of retries.
41 *
42 * @default - 4294967295 (2**32 - 1).
43 */
44 readonly maxRetries?: number;
45 /**
46 * Generates event logs in nanosecond resolution.
47 *
48 * @default - false
49 */
50 readonly subSecondPrecision?: boolean;
51}
52/**
53 * A log driver that sends log information to journald Logs.
54 */
55export declare class FluentdLogDriver extends LogDriver {
56 private readonly props;
57 /**
58 * Constructs a new instance of the FluentdLogDriver class.
59 *
60 * @param props the fluentd log driver configuration options.
61 */
62 constructor(props?: FluentdLogDriverProps);
63 /**
64 * Called when the log driver is configured on a container
65 */
66 bind(_scope: CoreConstruct, _containerDefinition: ContainerDefinition): LogDriverConfig;
67}