Class KinesisReportingPlugin

this plugin accepts the following options:

// aftconfig.json
{
    "KinesisReportingPluginConfig": {
      "logLevel": "info",
      "region": "us-west-1",
      "deliveryStream": "your-frehose-delivery-stream",
      "assumeRoleArn": "optional-arn-for-iam-role-used-to-send-records",
      "assumeRoleDuration": 900,
      "batch": true,
      "batchSize": 10,
      "sendStrategy": "logsandresults",
      "timestampFieldName": "@timestamp",
      "timestampFormat": "YYYY-MM-DDTHH:mm:ss.SSSZ"
    }
}

NOTE:

the order we obtain AWS Credentials follows the below:

Environment Variables: AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_SESSION_TOKEN

EC2 Metadata: also known as instance profile credentials

Shared Ini File: read from the host system

ECS Credentials: similar to the EC2 Metadata, but on ECS

Process Credentials: any credentials set on the current process

Hierarchy

ReportingPlugin
- KinesisReportingPlugin

Index

Constructors

constructor

new KinesisReportingPlugin(aftCfg?, client?): KinesisReportingPlugin
Parameters
- Optional aftCfg: AftConfig
- Optional client: Firehose
Returns KinesisReportingPlugin
Overrides ReportingPlugin.constructor
- Defined in packages/aft-reporting-aws-kinesis-firehose/src/kinesis-reporting-plugin.ts:101

Properties

`Private` `Readonly` _assumeRoleArn

_assumeRoleArn: string

`Private` `Readonly` _assumeRoleDuration

_assumeRoleDuration: number

`Private` _client

_client: Firehose

`Private` `Readonly` _level

`Private` `Readonly` _logs

_logs: Record[]

`Private` `Readonly` _timestampField

_timestampField: string

`Private` `Readonly` _timestampFormat

_timestampFormat: string

Accessors

aftCfg

get aftCfg(): AftConfig
Returns AftConfig
Inherited from ReportingPlugin.aftCfg
- Defined in packages/aft-core/dist/src/plugins/plugin.d.ts:12

aftLogger

get aftLogger(): AftLogger
Returns AftLogger
Inherited from ReportingPlugin.aftLogger
- Defined in packages/aft-core/dist/src/plugins/plugin.d.ts:13

batch

get batch(): boolean
Returns boolean
- Defined in packages/aft-reporting-aws-kinesis-firehose/src/kinesis-reporting-plugin.ts:131

batchSize

get batchSize(): number
Returns number
- Defined in packages/aft-reporting-aws-kinesis-firehose/src/kinesis-reporting-plugin.ts:135

deliveryStream

get deliveryStream(): string
Returns string
- Defined in packages/aft-reporting-aws-kinesis-firehose/src/kinesis-reporting-plugin.ts:127

enabled

get enabled(): boolean
Returns boolean
Inherited from ReportingPlugin.enabled
- Defined in packages/aft-core/dist/src/plugins/reporting/reporting-plugin.d.ts:9

logLevel

get logLevel(): "trace" | "debug" | "info" | "step" | "warn" | "pass" | "fail" | "error" | "none"
Returns "trace" | "debug" | "info" | "step" | "warn" | "pass" | "fail" | "error" | "none"
Overrides ReportingPlugin.logLevel
- Defined in packages/aft-reporting-aws-kinesis-firehose/src/kinesis-reporting-plugin.ts:97

logs

get logs(): Record[]
Returns Record[]
- Defined in packages/aft-reporting-aws-kinesis-firehose/src/kinesis-reporting-plugin.ts:175

region

get region(): string
Returns string
- Defined in packages/aft-reporting-aws-kinesis-firehose/src/kinesis-reporting-plugin.ts:123

sendStrategy

get sendStrategy(): SendStrategy
Returns SendStrategy
- Defined in packages/aft-reporting-aws-kinesis-firehose/src/kinesis-reporting-plugin.ts:139

Methods

`Private` _assumeRoleIfNeeded

_assumeRoleIfNeeded(credentials): Promise<Credentials>
Parameters
- credentials: Credentials
Returns Promise<Credentials>
- Defined in packages/aft-reporting-aws-kinesis-firehose/src/kinesis-reporting-plugin.ts:314

`Private` _checkAndSendLogs

_checkAndSendLogs(override?): Promise<PutRecordBatchOutput | PutRecordOutput>
Parameters
- override: boolean = false
Returns Promise<PutRecordBatchOutput | PutRecordOutput>
- Defined in packages/aft-reporting-aws-kinesis-firehose/src/kinesis-reporting-plugin.ts:234

`Private` _createKinesisLogRecord

_createKinesisLogRecord(logOrResult): Promise<Record>
Parameters
- logOrResult: LogMessageData | TestResult
Returns Promise<Record>
- Defined in packages/aft-reporting-aws-kinesis-firehose/src/kinesis-reporting-plugin.ts:216

`Private` _send

_send(deliveryStream, record): Promise<PutRecordOutput>
Parameters
- deliveryStream: string
- record: Record
Returns Promise<PutRecordOutput>
- Defined in packages/aft-reporting-aws-kinesis-firehose/src/kinesis-reporting-plugin.ts:283

`Private` _sendBatch

_sendBatch(deliveryStream, records): Promise<PutRecordBatchOutput>
Parameters
- deliveryStream: string
- records: Record[]
Returns Promise<PutRecordBatchOutput>
- Defined in packages/aft-reporting-aws-kinesis-firehose/src/kinesis-reporting-plugin.ts:252

client

client(): Promise<Firehose>
Returns Promise<Firehose>
- Defined in packages/aft-reporting-aws-kinesis-firehose/src/kinesis-reporting-plugin.ts:113

credentials

credentials(): Promise<Credentials>
generates a valid AWS Credentials object by checking the following (in this order):
- Options: read from passed in KinesisReportingPluginOptions
- Environment Variables: AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_SESSION_TOKEN
- EC2 Metadata: also known as instance profile credentials
- Shared Ini File: read from the host system
- ECS Credentials: similar to the EC2 Metadata, but on ECS
- Process Credentials: any credentials set on the current process
Returns Promise<Credentials>
a valid AWS Credentials object
- Defined in packages/aft-reporting-aws-kinesis-firehose/src/kinesis-reporting-plugin.ts:154

finalise

finalise(name): Promise<void>
Parameters
- name: string
Returns Promise<void>
Overrides ReportingPlugin.finalise
- Defined in packages/aft-reporting-aws-kinesis-firehose/src/kinesis-reporting-plugin.ts:207

initialise

initialise(logName): Promise<void>
Parameters
- logName: string
Returns Promise<void>
Overrides ReportingPlugin.initialise
- Defined in packages/aft-reporting-aws-kinesis-firehose/src/kinesis-reporting-plugin.ts:179

log

log(logData): Promise<void>
Parameters
- logData: LogMessageData
Returns Promise<void>
Overrides ReportingPlugin.log
- Defined in packages/aft-reporting-aws-kinesis-firehose/src/kinesis-reporting-plugin.ts:183

submitResult

submitResult(result): Promise<void>
implementation of the {ResultsPlugin} class used to submit results
Parameters
- result: TestResult
  
  a {TestResult} to send to Kinesis Firehose
Returns Promise<void>
Overrides ReportingPlugin.submitResult
- Defined in packages/aft-reporting-aws-kinesis-firehose/src/kinesis-reporting-plugin.ts:199

Class KinesisReportingPlugin

NOTE:

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional aftCfg: AftConfig

Optional client: Firehose

Returns KinesisReportingPlugin

Properties

Private Readonly _assumeRoleArn

Private Readonly _assumeRoleDuration

Private _client

Private Readonly _level

Private Readonly _logs

Private Readonly _timestampField

Private Readonly _timestampFormat

Accessors

aftCfg

Returns AftConfig

aftLogger

Returns AftLogger

batch

Returns boolean

batchSize

Returns number

deliveryStream

Returns string

enabled

Returns boolean

logLevel

Returns "trace" | "debug" | "info" | "step" | "warn" | "pass" | "fail" | "error" | "none"

logs

Returns Record[]

region

Returns string

sendStrategy

Returns SendStrategy

Methods

Private _assumeRoleIfNeeded

Parameters

credentials: Credentials

Returns Promise<Credentials>

Private _checkAndSendLogs

Parameters

override: boolean = false

Returns Promise<PutRecordBatchOutput | PutRecordOutput>

Private _createKinesisLogRecord

Parameters

logOrResult: LogMessageData | TestResult

Returns Promise<Record>

Private _send

Parameters

deliveryStream: string

record: Record

Returns Promise<PutRecordOutput>

Private _sendBatch

Parameters

deliveryStream: string

records: Record[]

Returns Promise<PutRecordBatchOutput>

client

Returns Promise<Firehose>

credentials

Returns Promise<Credentials>

finalise

Parameters

name: string

Returns Promise<void>

initialise

Parameters

logName: string

Returns Promise<void>

log

Parameters

`Optional` aftCfg: AftConfig

`Optional` client: Firehose

`Private` `Readonly` _assumeRoleArn

`Private` `Readonly` _assumeRoleDuration

`Private` _client

`Private` `Readonly` _level

`Private` `Readonly` _logs

`Private` `Readonly` _timestampField

`Private` `Readonly` _timestampFormat

`Private` _assumeRoleIfNeeded

`Private` _checkAndSendLogs

`Private` _createKinesisLogRecord

`Private` _send

`Private` _sendBatch