Hierarchy

  • ReportingPluginConfig
    • KinesisReportingPluginConfig

Constructors

Properties

assumeRoleArn: string

an optional AWS IAM role to assume that will allow you to send results to your Firehose instance if the default role obtained does not already do so

assumeRoleDuration: number = 900

an optional duration for the assumed role to remain valid

Default

900
batch: boolean = true

a boolean indicating if messages should be batched before sending. set to false to disable batching

Default

true
batchSize: number = 10

the number of messages to batch before sending

deliveryStream: string

the AWS Firehose delivery stream to use

enabled: boolean
logLevel: "trace" | "debug" | "info" | "step" | "warn" | "pass" | "fail" | "error" | "none"
region: string

the AWS region where your Kinesis Firehose instance exists

sendStrategy: SendStrategy = 'logsandresults'

a value of logsonly, resultsonly, or logsandresults indicating if only logs, only results or both should be sent

Default

'logsandresults'
timestampFieldName: string = '@timestamp'

within the Data being sent, a valid timestamp is required; this allows you to override the field name used for the timestamp to match any non-standard values you might already be using

Default

'@timestamp'
timestampFormat: string = 'YYYY-MM-DDTHH:mm:ss.SSSZ'

the timestamp format to use

Default

'YYYY-MM-DDT:HH:mm:ss.SSSZ'

Generated using TypeDoc