77 lines
2.3 KiB
TypeScript
77 lines
2.3 KiB
TypeScript
import type { Construct } from 'constructs';
|
|
import type { BaseLogDriverProps } from './base-log-driver';
|
|
import type { LogDriverConfig } from './log-driver';
|
|
import { LogDriver } from './log-driver';
|
|
import type { Duration } from '../../../core';
|
|
import type { ContainerDefinition } from '../container-definition';
|
|
/**
|
|
* Specifies the fluentd log driver configuration options.
|
|
*
|
|
* [Source](https://docs.docker.com/config/containers/logging/fluentd/)
|
|
*/
|
|
export interface FluentdLogDriverProps extends BaseLogDriverProps {
|
|
/**
|
|
* By default, the logging driver connects to localhost:24224. Supply the
|
|
* address option to connect to a different address. tcp(default) and unix
|
|
* sockets are supported.
|
|
*
|
|
* @default - address not set.
|
|
*/
|
|
readonly address?: string;
|
|
/**
|
|
* Docker connects to Fluentd in the background. Messages are buffered until
|
|
* the connection is established.
|
|
*
|
|
* @default - false
|
|
* @deprecated use `async` instead
|
|
*/
|
|
readonly asyncConnect?: boolean;
|
|
/**
|
|
* Docker connects to Fluentd in the background. Messages are buffered until
|
|
* the connection is established.
|
|
*
|
|
* @default - false
|
|
*/
|
|
readonly async?: boolean;
|
|
/**
|
|
* The amount of data to buffer before flushing to disk.
|
|
*
|
|
* @default - The amount of RAM available to the container.
|
|
*/
|
|
readonly bufferLimit?: number;
|
|
/**
|
|
* How long to wait between retries.
|
|
*
|
|
* @default - 1 second
|
|
*/
|
|
readonly retryWait?: Duration;
|
|
/**
|
|
* The maximum number of retries.
|
|
*
|
|
* @default - 4294967295 (2**32 - 1).
|
|
*/
|
|
readonly maxRetries?: number;
|
|
/**
|
|
* Generates event logs in nanosecond resolution.
|
|
*
|
|
* @default - false
|
|
*/
|
|
readonly subSecondPrecision?: boolean;
|
|
}
|
|
/**
|
|
* A log driver that sends log information to journald Logs.
|
|
*/
|
|
export declare class FluentdLogDriver extends LogDriver {
|
|
private readonly props;
|
|
/**
|
|
* Constructs a new instance of the FluentdLogDriver class.
|
|
*
|
|
* @param props the fluentd log driver configuration options.
|
|
*/
|
|
constructor(props?: FluentdLogDriverProps);
|
|
/**
|
|
* Called when the log driver is configured on a container
|
|
*/
|
|
bind(_scope: Construct, _containerDefinition: ContainerDefinition): LogDriverConfig;
|
|
}
|