AWS Kinesis¶

Use the "TrueWatch Cloud Sync" series of script packages in the script market to synchronize cloud monitoring and cloud asset data to TrueWatch

Configuration¶

Install Func¶

It is recommended to activate the TrueWatch Integration - Extensions - DataFlux Func (Automata): all prerequisites are automatically installed, please proceed with the script installation.

If deploying Func manually, refer to Manual Deployment of Func

Install Script¶

Note: Please prepare the required Amazon AK in advance (for simplicity, you can directly grant global read-only permissions ReadOnlyAccess)

Activate Script in Automata¶

1. Log in to the TrueWatch console
2. Click the 【Integration】 menu and select 【Cloud Account Management】
3. Click 【Add Cloud Account】, select 【AWS】, and fill in the required information on the interface. If you have already configured the cloud account information before, ignore this step
4. Click 【Test】, and if the test is successful, click 【Save】. If the test fails, please check if the relevant configuration information is correct and retest
5. In the 【Cloud Account Management】 list, you can see the added cloud account. Click the corresponding cloud account to enter the details page
6. Click the 【Integration】 button on the cloud account details page, find AWS Kinesis under the Not Installed list, and click the 【Install】 button. The installation interface will pop up for installation.

Manually Activate Script¶

1. Log in to the Func console, click 【Script Market】, enter the TrueWatch script market, and search for: integration_aws_kinesis

2. Click 【Install】, then enter the corresponding parameters: AWS AK ID, AK Secret, and account name.

3. Click 【Deploy Startup Script】, the system will automatically create the Startup script set and configure the corresponding startup scripts.

4. After activation, you can see the corresponding automatic trigger configuration in 「Manage / Automatic Trigger Configuration」. Click 【Execute】 to immediately execute once without waiting for the scheduled time. After a while, you can view the execution task records and corresponding logs.

Verification¶

1. In 「Manage / Automatic Trigger Configuration」, confirm whether the corresponding task has the corresponding automatic trigger configuration, and you can also view the corresponding task records and logs to check for any exceptions
2. In TrueWatch, check if the asset information exists in 「Infrastructure / Custom」
3. In TrueWatch, check if there is corresponding monitoring data in 「Metrics」

Metrics¶

After configuring Amazon CloudWatch, the default Measurement is as follows. You can collect more Metrics through configuration Amazon CloudWatch Metrics Details

Instance Metrics¶

The AWS/Kinesis namespace includes the following instance metrics.

The collected AWS Kinesis object data structure can be viewed in 「Infrastructure - Custom」

{
  "measurement": "aws_kinesis",
  "tags": {
    "class"          : "aws_kinesis",
    "cloud_provider" : "aws",
    "create_time"    : "2023/08/07 14:29:19",
    "date"           : "2023/08/07 14:29:19",
    "date_ns"        :"0",
    "EncryptionType" :"NONE",
    "HasMoreShards"  :"false",
    "name"           :"zsh_test",
    "RegionId"      :"cn-northwest-1",
    "RetentionPeriodHours":"24",
    "StreamARN":"arn:aws-cn:kinesis:cn-northwest-1:294654068288:stream/zsh_test",
    "StreamName":"zsh_test",
    "StreamStatus":"ACTIVE"
  }
}

Note: Fields in tags may change with subsequent updates

Tip 1: The name value is the instance name and serves as the unique identifier