AWS Kinesis¶

Use the script package series of "Guance Cloud Sync" in the script market to synchronize cloud monitoring and cloud asset data to Guance.

Configuration¶

Install Func¶

It is recommended to enable Guance Integration - Extension - Hosted Func: All prerequisites are automatically installed. Please continue with script installation.

If you deploy Func on your own, refer to Self-hosted Func

Install Script¶

Note: Please prepare a qualified Amazon AK in advance (for simplicity, you can directly grant global read-only permission ReadOnlyAccess)

Enable Hosted Script¶

1. Log in to the Guance console.
2. Click on the 【Integration】 menu, select 【Cloud Account Management】.
3. Click 【Add Cloud Account】, choose 【AWS】, fill in the required information on the interface. If you have already configured cloud account information, skip this step.
4. Click 【Test】, after the test succeeds, click 【Save】. If the test fails, check whether the related configuration information is correct and retest.
5. In the 【Cloud Account Management】 list, you can see the added cloud accounts. Click on the corresponding cloud account to enter the details page.
6. Click the 【Integration】 button on the cloud account details page. In the Not Installed list, find AWS Kinesis, click the 【Install】 button, and install it from the pop-up installation interface.

Manually Enable Script¶

1. Log in to the Func console, click 【Script Market】, go to the official script market, search for: guance_aws_kinesis
2. After clicking 【Install】, input the corresponding parameters: AWS AK ID, AK Secret, and account name.
3. Click 【Deploy Startup Script】, the system will automatically create a Startup script set and configure the corresponding startup script automatically.
4. After enabling, you can see the corresponding automatic trigger configuration in the 「Management / Automatic Trigger Configuration」. Click 【Execute】 to run immediately without waiting for the scheduled time. After a short while, you can view the execution task records and corresponding logs.

Verification¶

1. In 「Management / Automatic Trigger Configuration」, confirm whether the corresponding task has an automatic trigger configuration, and at the same time, you can check the corresponding task records and logs for any anomalies.
2. In Guance, under 「Infrastructure / Custom」, check if there is any asset information.
3. In Guance, under 「Metrics」, check if there is any corresponding monitoring data.

Metrics¶

After configuring Amazon-CloudWatch, the default metric set is as follows. You can collect more metrics through configuration. Amazon CloudWatch Metric Details

Instance Metrics¶

The AWS/Kinesis namespace includes the following instance metrics.

Objects¶

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, used for unique identification. ```